Developer Network NREL NREL Developer Network

Puerto Rico SHR (Simulated High Resolution) (/api/nsrdb/v2/solar/puerto-rico-download)

Collect and download, as CSV, a configurable set of solar and meteorological data fields from The NSRDB. The National Solar Radiation Database (NSRDB) is a serially complete collection of hourly and half-hourly values of the three most common measurements of solar radiation—global horizontal, direct normal, and diffuse horizontal irradiance—and meteorological data. These data have been collected at a sufficient number of locations and temporal and spatial scales to accurately represent regional solar radiation climates. Read more about the datasets at https://nsrdb.nrel.gov

This API is capable of creating very large downloadable archives. Unlike a typical API, the response to this provides a request acknowledgement. The real work of creating the requested downloadable archive will continue to run on the server side. When complete, and email will be sent to the email address provided in the initial request with either a link to a file to download, or in the case of a very, very large archive, a link to more detailed instructions for using Globus to complete the download. In addition to this two step workflow, there is also an option for users who wish to download a single CSV file in direct response to an API request. The .csv format may be used to download a CSV directly. This feature is restricted to use with only a single POINT, for a single YEAR at a time.

Request URL

GET|POST /api/nsrdb/v2/solar/puerto-rico-download.format?parameters

Request Parameters

NOTE: when using POST to submit a request the api_key must still be included as a query parameter in the url. All other parameters may be included in a POST request as part of the payload.

Parameter Required Value Description
api_key Yes
Type: string
Default: None

Your developer API key. See API keys for more information.

wkt Yes
Type: well-known text string
Default: None
A well-known text (WKT) representation of the geometry for which to extract data. May be a point, multipoint, or polygon geometry. When a point is passed the site nearest to that point is used. When a multipoint is passed the site nearest each point is used. This can be useful for downloading multiple sites in a single request when those sites are geographically distant from each other. When a polygon is passed all sites that intersect with the given polygon are used.
attributes No
Type: comma delimited string array
Default: Returns ALL
Options: air_temperature, clearsky_dhi, clearsky_dni, clearsky_ghi, dhi, dni, ghi, solar_zenith_angle, surface_albedo, surface_pressure, total_precipitable_water, wind_speed
Each specified attribute(*) will be returned as a column in the resultant CSV download.

names Yes
Type: comma delimited string array
Default: None
Options: 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
The year(s) for which data should be extracted.
utc No
Type: true or false
Default: true
Pass true to retrieve data with timestamps in UTC. Pass false to retrieve data with timestamps converted to local time of data point (without daylight savings time).
leap_day No
Type: true or false
Default: false
Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day.
interval Yes
Type: 5, 30 or 60
Default: None
This value determines data resolution. 5 minute, 30 minute, or 60 minute intervals are available.
full_name No
Type: string
Default: None
The full name of the user requesting data.
email Yes
Type: email string
Default: None
An active email for the user requesting data. This email will be used to deliver the extracted data.
affiliation No
Type: string
Default: None
The organization with which the user requesting the data is affiliated.
reason No
Type: string
Default: None
The reason that the user is requesting the data.
mailing_list No
Type: true or false
Default: false
Pass true to add the email address to our list of recipients for the NSRDB mailing list.

Response Fields

The response is composed of service-related informational fields and the results of the data query.

Field Value Description
errors
Type: string array

A list of error messages

inputs
Type: Object Hash
Key: Value pairs representing all input parameters
outputs
Type: Object Hash
Upon successful completion a message will be returned informing the user that file generation is in progress and an email will be sent to the address provided in the email input field when the download is ready

Data File Format

Generated data files are formatted in accordance with the Standard Time Series Data File Format. This file format has been developed to support SAM and other NREL models and is documented fully in this PDF. More information on SAM file formats available on the SAM weather page.

Examples

JSON Output Format

GET /api/nsrdb/v2/solar/puerto-rico-download.json?api_key=DEMO_KEY&names=2016&email=valued.user@gmail.com&interval=60&wkt=POINT(-66.1057 18.4655)
{
    "errors": [],
    "inputs": {
        "names": [
            2016
        ],
        "email": "valued.user@gmail.com",
        "interval": 60,
        "wkt": "POINT(-66.1057 18.4655)"
    },
    "outputs": {
        "message": "File generation in progress. An email will be sent to valued.user@gmail.com when the download is ready."
    }
}

CSV Output Format

Direct streaming of CSV data is supported for single location, single year only. The following response example is truncated after the first few rows of data.

GET /api/nsrdb/v2/solar/puerto-rico-download.csv?api_key=DEMO_KEY&names=2016&email=valued.user@gmail.com&interval=60&wkt=POINT(-66.1057 18.4655)
Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Pressure Units,Precipitable Water Units,Wind Speed,Version
NSRDB,1601,-,PR,Puerto Rico,18.459999084472656,-66.11000061035156,-4,9,-4,w/m2,w/m2,w/m2,w/m2,w/m2,w/m2,Degree,mbar,mm,m/s,unknown
Year,Month,Day,Hour,Minute,Air Temerature,Clearsky DHI,Clearsky DNI,Clearsky GHI,DHI,DNI,GHI,Solar Zenith Angle,Albedo,Pressure,Precipitable Water,Wind Speed
2016,1,1,0,5,25,0,0,0,0,0,0,89.0,0.082,1020.0,3.286,5
2016,1,1,1,5,25,0,0,0,0,0,0,89.0,0.082,1020.0,2.852,5
2016,1,1,2,5,25,0,0,0,0,0,0,89.0,0.082,1020.0,2.5340000000000003,5
2016,1,1,3,5,25,0,0,0,0,0,0,89.0,0.082,1020.0,2.316,5
2016,1,1,4,5,25,0,0,0,0,0,0,89.0,0.082,1020.0,2.1350000000000002,4
2016,1,1,5,5,24,0,0,0,0,0,0,89.0,0.082,1020.0,1.999,4
2016,1,1,6,5,24,0,0,0,0,0,0,89.0,0.082,1020.0,1.926,4
2016,1,1,7,5,25,16,78,18,16,78,18,88.26,0.082,1020.0,1.923,4
2016,1,1,8,5,26,61,594,206,61,594,206,75.91,0.082,1021.7,1.973,4
2016,1,1,9,5,27,79,788,423,79,788,423,64.15,0.082,1030.0,2.081,4
2016,1,1,10,5,27,89,876,606,89,876,606,53.800000000000004,0.082,1030.0,2.248,5

POST request example in Python

import requests

url = "http://developer.nrel.gov/api/nsrdb/v2/solar/puerto-rico-download.json?api_key=yourapikeygoeshere"

payload = "names=2012&leap_day=false&interval=60&utc=false&full_name=Valued%2BUser&email=valued.user%40gmail.com&affiliation=NREL&mailing_list=true&reason=Academic&attributes=dhi%2Cdni%2Cwind_speed%2Cair_temperature&wkt=MULTIPOINT(-66.1057%2018.4655%2C-66.2057%2018.3655%2C-66.1157%2018.4655)"

headers = {
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache"
}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Rate Limits

Rate limits for this application are significantly less than the standard rate limits for developer.nrel.gov. This decrease in the limit is required as the data provided through this service is significantly more computationally intensive to generate and provide. These rate limits are carefully calculated to allow all users the maximum throughput that our servers can sustain.

There are two levels of rate limiting for this service. The first limit determines how many requests a given user can make per 24 hour period. For requests utilizing the .csv format this rate limit is set at 5000 a day at a frequency of no more than 1 per second. For all other requests this limit is set at 1000 requests per day at a frequency of no more than 1 every 2 seconds.

In addition to this limit, the service has a secondary fail-safe mechanism to prevent significant performance decreases that can be caused by unexpectedly high usage of the service. This limit will cause the service to stop accepting requests when the queue reaches a point where additional requests will significantly lower server performance. When this limit is hit, the service will error with a message describing that the request queue is full.

For some tips and tricks to maximize data downloads please read the guide here.

Errors

Standard errors may be returned. In addition, the following service-specific errors may be returned:

HTTP Status Code Description
400 Bad Request: When required parameters are missing.
Help Improve this Content