Physical Solar Model (PSM) v3
GET {{nrel_developer_url}}/nsrdb/v2/solar/psm3-download.json?wkt=POINT(14.61 -24.26)&attributes=&names=&utc=&leap_day=&interval=&full_name=&email=&affiliation=&reason=&mailing_list=
Physical Solar Model (PSM) v3 (/api/nsrdb/v2/solar/psm3-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.
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 |
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
wkt | string | 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 | null | Type: comma delimited string array | |
Default: Returns ALL | |||
Options: air_temperature, clearsky_dhi, clearsky_dni, clearsky_ghi, cloud_type, dew_point, dhi, dni, fill_flag, ghi, ghuv-280-400, ghuv-285-385, relative_humidity, solar_zenith_angle, surface_albedo, surface_pressure, total_precipitable_water, wind_direction, wind_speed | |||
Each specified attribute(*) will be returned as a column in the resultant CSV download. | |||
names | null | 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, 2018, 2019 | |||
The year(s) for which data should be extracted. | |||
utc | null | 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 | null | 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 | null | Type: 30 or 60 | |
Default: None | |||
This value determines data resolution. Either 30 minute or 60 minute intervals are available. | |||
full_name | null | Type: string | |
Default: None | |||
The full name of the user requesting data. | |||
email | null | Type: email string | |
Default: None | |||
An active email for the user requesting data. This email will be used to deliver the extracted data. | |||
affiliation | null | Type: string | |
Default: None | |||
The organization with which the user requesting the data is affiliated. | |||
reason | null | Type: string | |
Default: None | |||
The reason that the user is requesting the data. | |||
mailing_list | null | Type: true or false | |
Default: false | |||
Pass true to add the email address to our list of recipients for the NSRDB mailing list. |