GET /api/georeserv/app/sam/pvwatts
PVWatts Version 2 (Deprecated): Returns the results for a PVWatts simulation, including financial and utility data. We encourage you to migrate to version 4 of the PVWatts API.
Request URL
GET http://developer.nrel.gov/api/georeserv/app/sam/pvwatts.format?parameters
Request Parameters
| Parameter | Required | Value | Description |
|---|---|---|---|
| format | Yes |
Type: string
Default: None
Options: json, xml, csv
|
The output response format. Given in the URL as the file extension. |
| api_key | Yes |
Type: string
Default: None
|
Your developer API key. See API keys for more information. |
| timeframe | No |
Type: string
Default: daily
Options: monthly, daily
|
Granularity of the output response |
| lat | Depends |
Type: decimal
Default: None
|
Latitude, required if address not given. |
| lon | Depends |
Type: decimal
Default: None
|
Longitude, required if address not given. |
| address | Depends |
Type: string
Default: None
|
Address to use, lat/lon returned by Google's geocoding service. |
| climate_file_type | No |
Type: string
Default: perez
Options: city, perez
|
Whether to use city-based observational data (city) or satellite data (perez). Default is perez. |
| city_file | No |
Type: string
Default: None
|
City file to use for this simulation. (deprecated) |
| tmy2_name | No |
Type: string
Default: None
|
City-based tm2 file for use in the simulation. Format: State Abbr<space>City see: http://rredc.nrel.gov/solar/old_data/nsrdb/1961-1990/tmy2/State.html |
| tmy3_name | No |
Type: string
Default: None
|
Site-based tm3 file for use in simulation. USAF number. See: http://rredc.nrel.gov/solar/old_data/nsrdb/1991-2005/tmy3/by_USAFN.html |
| azimuth | No |
Type: decimal
Default: None
|
Azimuth angle (degrees). |
| derate | Depends |
Type: decimal
Default: 0.77
|
System derate value (fraction). |
| system_size | Yes |
Type: decimal
Default: None
|
Nameplate capacity (kW). |
| tilt | No |
Type: decimal
Default: None
|
lTilt angle in degrees of the PV (degrees). |
| tilt_eq_lat | No |
Type: integer
Default: 0
Options: 0, 1
|
Override the tilt variable to equal latitude (0, 1) (default 0 unless tilt provided) |
| track_mode | No |
Type: integer
Default: 1
Options: 0, 1, 2
|
Tracking Mode (Fixed: 0, 1-Axis: 1, 2-Axis: 2) |
| year | No |
Type: decimal
Default: 1990
|
Year to use for weather simulation. |
| federal_tax_rate | No |
Type: decimal
Default: 35
|
Federal Tax Rate (percent). |
| insurance_rate | No |
Type: decimal
Default: 0.5
|
Insurance Rate (percent). |
| inflation_rate | No |
Type: decimal
Default: 3
|
Rate of Inflation (percent). |
| itc_fed_percent | No |
Type: decimal
Default: 30
|
If you have a series of itc’s, simply provide the parameter multiple times in the argument list. |
| loan_term | No |
Type: decimal
Default: 30
|
Loan Term (years). |
| loan_rate | No |
Type: decimal
Default: 4.95
|
Loan Rate (percent). |
| load_debt | No |
Type: decimal
Default: 80
|
Amount the funding for the solar installation provided by the loan (percent). |
| market | No |
Type: integer
Default: 0
Options: 0, 1
|
What market is used for the install. (Residential: 0, Commercial: 1) |
| mortage | No |
Type: integer
Default: 0
|
Add-on to an existing mortgage? (Yes: 1, No: 0) |
| percent_of_cost_subject_sales_tax | No |
Type: decimal
Default: 90
|
Percent of Cost Subject to Sales Tax (percent). |
| property_tax_rate | No |
Type: decimal
Default: 2.0
|
Property Tax Rate (percent). |
| real_discount_rate | No |
Type: decimal
Default: 11.0
|
Real Discount Rate (percent). |
| state_tax_rate | No |
Type: decimal
Default: 3.2
|
State Tax Rate (percent). |
| system_capacity | No |
Type: decimal
Default: 250
|
System Capacity. |
| total_hard_cost | No |
Type: decimal
Default: 103810
|
Total installed cost of the system hardware after incentives (dollars). |
| total_soft_cost | No |
Type: decimal
Default: 7150
|
Total cost of labor and permitting for the system after incentives. |
| analysis years | No |
Type: integer
Default: 30
|
Number of years in analysis (years). |
| load_escalation | No |
Type: decimal
Default: 0.9
|
Annual load escalation (%/year). |
| rate_escalation | No |
Type: decimal
Default: 1.5
|
Annual utility rate escalation (%/year). |
| system_degradation | No |
Type: decimal
Default: 0.5
|
Annual degradation of system (%/year). |
| ur_monthly_fixed_charge | No |
Type: decimal
Default: 50
|
Monthly fixed charge (dollars). |
| ur_flat_buy_rate | No |
Type: decimal
Default: 0.12
|
Flat rate (buy) ($/kWh). |
| ur_tou_enable | No |
Type: integer
Default: 1
|
Enable time-of-use rate (0/1). |
| ur_tou_p1_buy_rate | No |
Type: decimal
Default: 0.12
|
TOU Period 1 Rate (buy). |
| ur_tou_p2_buy_rate | No |
Type: decimal
Default: 0.556
|
TOU Period 2 Rate (buy). |
| ur_tou_p3_buy_rate | No |
Type: decimal
Default: 0.75
|
TOU Period 3 Rate (buy). |
| ur_tou_p4_buy_rate | No |
Type: decimal
Default: 0.99
|
TOU Period 4 Rate (buy). |
| ur_tou_sched_weekday | No |
Type: string
Default: 1111111111111
11111111111111111111
11111111111111111111
11111111111111111111
11111111111111111111
11111111111111111111
11111112222222222222
22222222222222222224
44444444222222222222
22244444444422222223
33333334444444443333
33333333333333333333
33333331111111111111
11111111111111111111
111111111111111
|
TOU Weekday Schedule (288 values). |
| ur_tou_sched_weekend | No |
Type: string
Default: 1111111111111
11111111111111111111
11111111111111111111
11111111111111111111
11111111111111111111
11111111111111111111
11111111111111111111
11111111111222222222
22222222222222222222
22222222222222222222
22222222222222222222
22211111111111111111
11111111111111111111
11111111111111111111
111111111111111
|
TOU Weekend Schedule (288 values). |
Examples
JSON Output Format
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
{'errors': [{}],
'infos': [],
'inputs': {'azimuth': '170',
'derate': '0.770',
'lat': '21.3069',
'lon': '-157.8583',
'system_size': '4.0',
'tilt': '39.5',
'timeframe': 'monthly'},
'outputs': {'ann_kwh_yr': 5880.5222881091868,
'financials': {'FedITC': [],
'analysis_period': 0.0,
'cost_per_kw': 27740.0,
'direct_cost': 103810.0,
'installed_cost': 110960.0,
'lcoe': 11.884482383728027,
'npv': 16864.57421875,
'payback': 3.2254412174224854,
'totalCBI': [],
'totalIBI': [],
'totalPBI': [0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0,
0.0],
'util_cost_savings': [2939.253662109375,
2968.427734375,
2997.892333984375,
3027.637939453125,
3057.687744140625,
3088.0390625,
3118.688232421875,
3149.63427734375,
3180.9033203125,
3212.47412109375,
3244.3544921875,
3276.55078125,
3309.070556640625,
3341.91796875,
3375.083984375,
3408.586669921875,
3442.413818359375,
3476.58447265625,
3511.0849609375,
3545.933349609375,
3581.1220703125,
3616.670166015625,
3652.5625,
3688.814453125,
3725.4306640625,
3762.40234375,
3799.739501953125,
3837.45751953125,
3875.5380859375,
3914.011962890625],
'util_rate': 0.0},
'kwh_per_kw': 1470.1305710386539,
'sam_output': {'Apr': 540.29125842182714,
'Aug': 530.56997357641478,
'Dec': 409.51255196079626,
'Feb': 415.35182499417647,
'Jan': 420.67913817015267,
'Jul': 517.03098054057511,
'Jun': 510.93430222376634,
'Mar': 565.91124939849931,
'May': 534.37443022542971,
'Nov': 414.09659745669353,
'Oct': 501.23863327485492,
'Sep': 520.53134786599992},
'utilities': [2939.253662109375,
2968.427734375,
2997.892333984375,
3027.637939453125,
3057.687744140625,
3088.0390625,
3118.688232421875,
3149.63427734375,
3180.9033203125,
3212.47412109375,
3244.3544921875,
3276.55078125,
3309.070556640625,
3341.91796875,
3375.083984375,
3408.586669921875,
3442.413818359375,
3476.58447265625,
3511.0849609375,
3545.933349609375,
3581.1220703125,
3616.670166015625,
3652.5625,
3688.814453125,
3725.4306640625,
3762.40234375,
3799.739501953125,
3837.45751953125,
3875.5380859375,
3914.011962890625]},
'version': '2.0.24',
'warnings': []}
|
XML Output Format
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 |
<params>
<param>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<string>errors</string>
</value>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<struct>
</struct>
</value>
</param>
<param>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<string>infos</string>
</value>
<value>
<array>
<data>
</data>
</array>
</value>
</param>
<param>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<string>inputs</string>
</value>
<value>
<struct>
<member>
<name>tilt</name>
</member>
</struct>
</value>
<value>
<string>39.5</string>
</value>
<member>
<name>system_size</name>
<value>
<string>4.0</string>
</value>
</member>
<member>
<name>timeframe</name>
<value>
<string>monthly</string>
</value>
</member>
<member>
<name>lon</name>
<value>
<string>-157.8583</string>
</value>
</member>
<member>
<name>derate</name>
<value>
<string>0.770</string>
</value>
</member>
<member>
<name>azimuth</name>
<value>
<string>170</string>
</value>
</member>
<member>
<name>lat</name>
<value>
<string>21.3069</string>
</value>
</member>
</param>
<param>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<string>outputs</string>
</value>
<value>
<struct>
<member>
<name>kwh_per_kw</name>
</member>
</struct>
</value>
<value>
<double>1470.1305710386539</double>
</value>
<member>
<name>ann_kwh_yr</name>
<value>
<double>5880.5222881091868</double>
</value>
</member>
<member>
<name>sam_output</name>
<value>
<struct>
</struct>
</value>
</member>
<member>
<name>Mar</name>
<value>
<double>565.91124939849931</double>
</value>
</member>
<member>
<name>Feb</name>
<value>
<double>415.35182499417647</double>
</value>
</member>
<member>
<name>Aug</name>
<value>
<double>530.56997357641478</double>
</value>
</member>
<member>
<name>Sep</name>
<value>
<double>520.53134786599992</double>
</value>
</member>
<member>
<name>Apr</name>
<value>
<double>540.29125842182714</double>
</value>
</member>
<member>
<name>Jun</name>
<value>
<double>510.93430222376634</double>
</value>
</member>
<member>
<name>Jul</name>
<value>
<double>517.03098054057511</double>
</value>
</member>
<member>
<name>Jan</name>
<value>
<double>420.67913817015267</double>
</value>
</member>
<member>
<name>May</name>
<value>
<double>534.37443022542971</double>
</value>
</member>
<member>
<name>Nov</name>
<value>
<double>414.09659745669353</double>
</value>
</member>
<member>
<name>Dec</name>
<value>
<double>409.51255196079626</double>
</value>
</member>
<member>
<name>Oct</name>
<value>
<double>501.23863327485492</double>
</value>
</member>
<member>
<name>financials</name>
<value>
<struct>
</struct>
</value>
</member>
<member>
<name>util_rate</name>
<value>
<double>0.0</double>
</value>
</member>
<member>
<name>direct_cost</name>
<value>
<double>103810.0</double>
</value>
</member>
<member>
<name>FedITC</name>
<value>
<array>
<data>
</data>
</array>
</value>
</member>
<member>
<name>cost_per_kw</name>
<value>
<double>27740.0</double>
</value>
</member>
<member>
<name>lcoe</name>
<value>
<double>11.884482383728027</double>
</value>
</member>
<member>
<name>totalIBI</name>
<value>
<array>
<data>
</data>
</array>
</value>
</member>
<member>
<name>installed_cost</name>
<value>
<double>110960.0</double>
</value>
</member>
<member>
<name>totalPBI</name>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
<value>
<double>0.0</double>
</value>
</member>
<member>
<name>payback</name>
<value>
<double>3.2254412174224854</double>
</value>
</member>
<member>
<name>util_cost_savings</name>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<double>2939.253662109375</double>
</value>
<value>
<double>2968.427734375</double>
</value>
<value>
<double>2997.892333984375</double>
</value>
<value>
<double>3027.637939453125</double>
</value>
<value>
<double>3057.687744140625</double>
</value>
<value>
<double>3088.0390625</double>
</value>
<value>
<double>3118.688232421875</double>
</value>
<value>
<double>3149.63427734375</double>
</value>
<value>
<double>3180.9033203125</double>
</value>
<value>
<double>3212.47412109375</double>
</value>
<value>
<double>3244.3544921875</double>
</value>
<value>
<double>3276.55078125</double>
</value>
<value>
<double>3309.070556640625</double>
</value>
<value>
<double>3341.91796875</double>
</value>
<value>
<double>3375.083984375</double>
</value>
<value>
<double>3408.586669921875</double>
</value>
<value>
<double>3442.413818359375</double>
</value>
<value>
<double>3476.58447265625</double>
</value>
<value>
<double>3511.0849609375</double>
</value>
<value>
<double>3545.933349609375</double>
</value>
<value>
<double>3581.1220703125</double>
</value>
<value>
<double>3616.670166015625</double>
</value>
<value>
<double>3652.5625</double>
</value>
<value>
<double>3688.814453125</double>
</value>
<value>
<double>3725.4306640625</double>
</value>
<value>
<double>3762.40234375</double>
</value>
<value>
<double>3799.739501953125</double>
</value>
<value>
<double>3837.45751953125</double>
</value>
<value>
<double>3875.5380859375</double>
</value>
<value>
<double>3914.011962890625</double>
</value>
</member>
<member>
<name>totalCBI</name>
<value>
<array>
<data>
</data>
</array>
</value>
</member>
<member>
<name>npv</name>
<value>
<double>16864.57421875</double>
</value>
</member>
<member>
<name>analysis_period</name>
<value>
<double>0.0</double>
</value>
</member>
<member>
<name>utilities</name>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<double>2939.253662109375</double>
</value>
<value>
<double>2968.427734375</double>
</value>
<value>
<double>2997.892333984375</double>
</value>
<value>
<double>3027.637939453125</double>
</value>
<value>
<double>3057.687744140625</double>
</value>
<value>
<double>3088.0390625</double>
</value>
<value>
<double>3118.688232421875</double>
</value>
<value>
<double>3149.63427734375</double>
</value>
<value>
<double>3180.9033203125</double>
</value>
<value>
<double>3212.47412109375</double>
</value>
<value>
<double>3244.3544921875</double>
</value>
<value>
<double>3276.55078125</double>
</value>
<value>
<double>3309.070556640625</double>
</value>
<value>
<double>3341.91796875</double>
</value>
<value>
<double>3375.083984375</double>
</value>
<value>
<double>3408.586669921875</double>
</value>
<value>
<double>3442.413818359375</double>
</value>
<value>
<double>3476.58447265625</double>
</value>
<value>
<double>3511.0849609375</double>
</value>
<value>
<double>3545.933349609375</double>
</value>
<value>
<double>3581.1220703125</double>
</value>
<value>
<double>3616.670166015625</double>
</value>
<value>
<double>3652.5625</double>
</value>
<value>
<double>3688.814453125</double>
</value>
<value>
<double>3725.4306640625</double>
</value>
<value>
<double>3762.40234375</double>
</value>
<value>
<double>3799.739501953125</double>
</value>
<value>
<double>3837.45751953125</double>
</value>
<value>
<double>3875.5380859375</double>
</value>
<value>
<double>3914.011962890625</double>
</value>
</member>
</param>
<param>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<string>version</string>
</value>
<value>
<string>2.0.24</string>
</value>
</param>
<param>
<value>
<array>
<data>
</data>
</array>
</value>
<value>
<string>warnings</string>
</value>
<value>
<array>
<data>
</data>
</array>
</value>
</param>
</params>
|
Demo Application
You can download a demo application to see how you might implement your own service on top of the PVWatts service. There is also a live version running so that you can see it in action.
Rate Limits
Standard rate limits apply. No more than 1,000 requests may be made in any hour. No more than 10,000 requests may be made in any day.
Errors
Standard errors may be returned. In addition, the following service-specific errors may be returned:
| HTTP Status Code | Description |
|---|---|
| 400 | Invalid Request - One or more parameters did not pass validation, or a parameter may be missing. Check the error section of the response to see how the request url should be modified to address the error. |