From 1684b936d2d1478011f68aa68bc3058393890ee3 Mon Sep 17 00:00:00 2001 From: "Edwards, Paul" Date: Wed, 21 Feb 2024 11:11:31 -0500 Subject: [PATCH] New wind and solar download APIs --- .../nsrdb-msg-v1-0-0-download.html.md.erb | 315 ++++++++++++++++++ .../nsrdb-msg-v1-0-0-tdy-download.html.md.erb | 315 ++++++++++++++++++ .../nsrdb-msg-v1-0-0-tgy-download.html.md.erb | 315 ++++++++++++++++++ .../nsrdb-msg-v1-0-0-tmy-download.html.md.erb | 315 ++++++++++++++++++ .../central-asia-wind-download.html.md.erb | 2 +- .../india-wind-download-old.html.md.erb | 2 +- .../india-wind-download.html.md.erb | 2 +- .../mexico-wtk.download.html.md.erb | 3 +- .../offshore-ca-download.html.md.erb | 4 +- .../offshore-great-lakes-download.html.md.erb | 2 +- ...fshore-gulf-of-mexico-download.html.md.erb | 2 +- .../offshore-hawaii-download.html.md.erb | 2 +- ...offshore-mid-atlantic-download.html.md.erb | 2 +- ...fshore-north-atlantic-download.html.md.erb | 2 +- .../offshore-nw-pacific-download.html.md.erb | 2 +- .../philippines-wtk-download.html.md.erb | 2 +- .../southeast-asia-wind-download.html.md.erb | 3 +- .../vietnam-wtk-download.html.md.erb | 2 +- .../wind-toolkit-extract-old.html.md.erb | 2 +- .../wtk-bangladesh-download.html.md.erb | 314 +++++++++++++++++ .../wtk-canada-5min-download.html.md.erb | 314 +++++++++++++++++ .../wind-toolkit/wtk-download.html.md.erb | 3 +- .../wtk-kazakhstan-download.html.md.erb | 314 +++++++++++++++++ .../wtk-led-conus-hr-download.html.md.erb | 314 +++++++++++++++++ .../wtk-maine-download.html.md.erb | 314 +++++++++++++++++ .../wtk-mexico-5min-download.html.md.erb | 314 +++++++++++++++++ ...-north-america-v1-0-0-download.html.md.erb | 314 +++++++++++++++++ ...alifornia-v1-0-0-5min-download.html.md.erb | 314 +++++++++++++++++ .../wtk-seasiawind-v3-download.html.md.erb | 314 +++++++++++++++++ ...ic-yearly-5min-v1-0-0-download.html.md.erb | 314 +++++++++++++++++ 30 files changed, 4419 insertions(+), 18 deletions(-) create mode 100755 source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-download.html.md.erb create mode 100755 source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tdy-download.html.md.erb create mode 100755 source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tgy-download.html.md.erb create mode 100755 source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tmy-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-bangladesh-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-canada-5min-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-kazakhstan-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-led-conus-hr-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-maine-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-mexico-5min-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-north-america-v1-0-0-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-now23-california-v1-0-0-5min-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-seasiawind-v3-download.html.md.erb create mode 100755 source/docs/wind/wind-toolkit/wtk-south-atlantic-yearly-5min-v1-0-0-download.html.md.erb diff --git a/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-download.html.md.erb b/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-download.html.md.erb new file mode 100755 index 00000000..9e240c34 --- /dev/null +++ b/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-download.html.md.erb @@ -0,0 +1,315 @@ +--- +title: "MSG V1.0.0" +summary: Collect and download, as CSV, a configurable set of solar and meteorological data fields from The NSRDB. The National Solar Radiation Database [(NSRDB)](https://nsrdb.nrel.gov/) is a serially complete collection of satellite-derived 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. The data are publicly available at no cost to the user. These API provide access to downloading the data. Other options are detailed [here](https://nsrdb.nrel.gov/data-sets/how-to-access-data). Read more about the datasets at [https://nsrdb.nrel.gov](https://nsrdb.nrel.gov) +detail: 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 a link to a file to 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. +url: /api/nsrdb/v2/solar/nsrdb-msg-v1-0-0-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: solar_zenith_angle, surface_albedo, total_precipitable_water, clearsky_dhi, clearsky_dni, clearsky_ghi, cloud_type, dew_point, relative_humidity, surface_pressure, dhi, dni, fill_flag, ghi, air_temperature, wind_direction, wind_speed.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:15, 30, 60
+
Default: None
+ 		+ This value determines data resolution. Either 15, 30, 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/solar/nsrdb/guide/). + +

Contact

+ +

For questions about the API or the data models please contact nsrdb@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tdy-download.html.md.erb b/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tdy-download.html.md.erb new file mode 100755 index 00000000..b5dabf68 --- /dev/null +++ b/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tdy-download.html.md.erb @@ -0,0 +1,315 @@ +--- +title: "MSG V1.0.0 TDY" +summary: Collect and download, as CSV, a configurable set of solar and meteorological data fields from The NSRDB. The National Solar Radiation Database [(NSRDB)](https://nsrdb.nrel.gov/) is a serially complete collection of satellite-derived 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. The data are publicly available at no cost to the user. These API provide access to downloading the data. Other options are detailed [here](https://nsrdb.nrel.gov/data-sets/how-to-access-data). Read more about the datasets at [https://nsrdb.nrel.gov](https://nsrdb.nrel.gov) +detail: 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 a link to a file to 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. +url: /api/nsrdb/v2/solar/nsrdb-msg-v1-0-0-tdy-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: air_temperature, clearsky_dhi, clearsky_dni, clearsky_ghi, cloud_fill_flag, cloud_type, dew_point, dhi, dni, fill_flag, ghi, 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. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: tdy, tdy-2014, tdy-2022.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:60
+
Default: None
+ 		+ This value determines data resolution. Either 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/solar/nsrdb/guide/). + +

Contact

+ +

For questions about the API or the data models please contact nsrdb@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tgy-download.html.md.erb b/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tgy-download.html.md.erb new file mode 100755 index 00000000..8696b9fd --- /dev/null +++ b/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tgy-download.html.md.erb @@ -0,0 +1,315 @@ +--- +title: "MSG V1.0.0 TGY" +summary: Collect and download, as CSV, a configurable set of solar and meteorological data fields from The NSRDB. The National Solar Radiation Database [(NSRDB)](https://nsrdb.nrel.gov/) is a serially complete collection of satellite-derived 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. The data are publicly available at no cost to the user. These API provide access to downloading the data. Other options are detailed [here](https://nsrdb.nrel.gov/data-sets/how-to-access-data). Read more about the datasets at [https://nsrdb.nrel.gov](https://nsrdb.nrel.gov) +detail: 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 a link to a file to 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. +url: /api/nsrdb/v2/solar/nsrdb-msg-v1-0-0-tgy-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
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, 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. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: tgy, tgy-2014, tgy-2022.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:60
+
Default: None
+ 		+ This value determines data resolution. Either 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/solar/nsrdb/guide/). + +

Contact

+ +

For questions about the API or the data models please contact nsrdb@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tmy-download.html.md.erb b/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tmy-download.html.md.erb new file mode 100755 index 00000000..e4c911c3 --- /dev/null +++ b/source/docs/solar/nsrdb/nsrdb-msg-v1-0-0-tmy-download.html.md.erb @@ -0,0 +1,315 @@ +--- +title: "MSG V1.0.0 TMY" +summary: Collect and download, as CSV, a configurable set of solar and meteorological data fields from The NSRDB. The National Solar Radiation Database [(NSRDB)](https://nsrdb.nrel.gov/) is a serially complete collection of satellite-derived 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. The data are publicly available at no cost to the user. These API provide access to downloading the data. Other options are detailed [here](https://nsrdb.nrel.gov/data-sets/how-to-access-data). Read more about the datasets at [https://nsrdb.nrel.gov](https://nsrdb.nrel.gov) +detail: 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 a link to a file to 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. +url: /api/nsrdb/v2/solar/nsrdb-msg-v1-0-0-tmy-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
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, 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. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: tmy, tmy-2014, tmy-2022.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:60
+
Default: None
+ 		+ This value determines data resolution. Either 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/solar/nsrdb/guide/). + +

Contact

+ +

For questions about the API or the data models please contact nsrdb@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/central-asia-wind-download.html.md.erb b/source/docs/wind/wind-toolkit/central-asia-wind-download.html.md.erb index d03319d3..3c26e67f 100644 --- a/source/docs/wind/wind-toolkit/central-asia-wind-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/central-asia-wind-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Central Asia Wind Data Download +title: Central Asia summary: Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, and direction values at 80m, 100m, and 120m above the surface and air pressure at the surface, 100m, and 200m above the surface for the year 2015 produced using WRF v3.7. The model time resolution used was 15 minutes with a nominal spatial resolution of 3 km2 over Kazakhstan and 9 km2 over the surrounding region. For the U and V components used to derive the wind speed, a total of 41 pressure levels were used. detail: 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 a link to a file to 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. url: /api/wind-toolkit/v2/wind/central-asia-wind-download diff --git a/source/docs/wind/wind-toolkit/india-wind-download-old.html.md.erb b/source/docs/wind/wind-toolkit/india-wind-download-old.html.md.erb index 050dffca..102de3ec 100644 --- a/source/docs/wind/wind-toolkit/india-wind-download-old.html.md.erb +++ b/source/docs/wind/wind-toolkit/india-wind-download-old.html.md.erb @@ -1,5 +1,5 @@ --- -title: India Wind Data Download +title: India summary: This service has been replaced by V2. See India Wind V2. url: /api/wind-toolkit/wind/india_wind_download deprecated: true diff --git a/source/docs/wind/wind-toolkit/india-wind-download.html.md.erb b/source/docs/wind/wind-toolkit/india-wind-download.html.md.erb index 6c7a463d..037ef2c9 100644 --- a/source/docs/wind/wind-toolkit/india-wind-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/india-wind-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: India Wind Data Download +title: India summary: Collect and download, as CSV, a configurable set of data fields from a national collection of wind stations. The India Wind Dataset, developed in part through the India Renewable Integration Study, contains simulated windspeed, direction, temperate and pressure values at 40m, 80m, 100m and 120m heights above the ground where available. The spatial resolution of the data is 3 km and the temporal resolution is 5 minutes. detail: 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 a link to a file to 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. url: /api/wind-toolkit/v2/wind/india-wind-download diff --git a/source/docs/wind/wind-toolkit/mexico-wtk.download.html.md.erb b/source/docs/wind/wind-toolkit/mexico-wtk.download.html.md.erb index 36cd471f..d9b4e4dc 100644 --- a/source/docs/wind/wind-toolkit/mexico-wtk.download.html.md.erb +++ b/source/docs/wind/wind-toolkit/mexico-wtk.download.html.md.erb @@ -1,8 +1,9 @@ --- -title: Mexico WTK Data Download +title: Mexico summary: Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. detail: 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 a link to a file to 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. url: /api/wind-toolkit/v2/wind/mexico-wtk-download +deprecated: true --- # <%= current_page.data.title %> (<%= current_page.data.url %>) diff --git a/source/docs/wind/wind-toolkit/offshore-ca-download.html.md.erb b/source/docs/wind/wind-toolkit/offshore-ca-download.html.md.erb index 414e744b..91f8bd8f 100644 --- a/source/docs/wind/wind-toolkit/offshore-ca-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/offshore-ca-download.html.md.erb @@ -1,6 +1,6 @@ --- -title: Offshore CA Data Download -summary: The Offshore CA Dataset is a 21-year wind resource dataset for offshore California. Produced in 2020, this data set replaces NREL's Wind Integration National Dataset (WIND) Toolkit for offshore California, which was produced and released publicly in 2013 and is currently the principal data set used by stakeholders for wind resource assessment in the continental United States. Both the WIND Toolkit and this new data set are created using the Weather Research and Forecasting (WRF) numerical weather prediction model (NWP). +title: Offshore California +summary: The Offshore California Dataset is a 21-year wind resource dataset for offshore California. Produced in 2020, this data set replaces NREL's Wind Integration National Dataset (WIND) Toolkit for offshore California, which was produced and released publicly in 2013 and is currently the principal data set used by stakeholders for wind resource assessment in the continental United States. Both the WIND Toolkit and this new data set are created using the Weather Research and Forecasting (WRF) numerical weather prediction model (NWP). detail: 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 a link to a file to 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.

The Offshore CA shares many of the same attributes as the WIND Toolkit, including 5-minute time resolution and 2-kilometer horizontal spatial resolution. However, the new data set improves upon - the WIND Toolkit through: url: /api/wind-toolkit/v2/wind/offshore-ca-download --- diff --git a/source/docs/wind/wind-toolkit/offshore-great-lakes-download.html.md.erb b/source/docs/wind/wind-toolkit/offshore-great-lakes-download.html.md.erb index f9364592..f94442ed 100644 --- a/source/docs/wind/wind-toolkit/offshore-great-lakes-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/offshore-great-lakes-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Offshore Great Lakes Data Download +title: Offshore Great Lakes summary: The Offshore Great Lakes Dataset is a 21-year wind resource dataset for the Great Lakes. Produced in 2021, this data set replaces NREL's Wind Integration National Dataset (WIND) Toolkit for the Great Lakes, which was produced and released publicly in 2013 and is currently the principal data set used by stakeholders for wind resource assessment in the continental United States. Both the WIND Toolkit and this new data set are created using the Weather Research and Forecasting (WRF) numerical weather prediction model (NWP). detail: 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 a link to a file to 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.

The Offshore Great Lakes shares many of the same attributes as the WIND Toolkit, including 5-minute time resolution and 2-kilometer horizontal spatial resolution. However, the new data set improves upon - the WIND Toolkit through: url: /api/wind-toolkit/v2/wind/offshore-great-lakes-download diff --git a/source/docs/wind/wind-toolkit/offshore-gulf-of-mexico-download.html.md.erb b/source/docs/wind/wind-toolkit/offshore-gulf-of-mexico-download.html.md.erb index b992d953..e5a07537 100644 --- a/source/docs/wind/wind-toolkit/offshore-gulf-of-mexico-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/offshore-gulf-of-mexico-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Offshore Gulf of Mexico Wind Data Download +title: Offshore Gulf of Mexico summary: The Offshore Gulf of Mexico Dataset is a 21-year wind resource dataset for the Gulf of Mexico. Produced in 2022, this data set replaces NREL's Wind Integration National Dataset (WIND) Toolkit for the Gulf of Mexico, which was produced and released publicly in 2013 and is currently the principal data set used by stakeholders for wind resource assessment in the continental United States. Both the WIND Toolkit and this new data set are created using the Weather Research and Forecasting (WRF) numerical weather prediction model (NWP). detail: 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 a link to a file to 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.

The Offshore Gulf of Mexico shares many of the same attributes as the WIND Toolkit, including 5-minute time resolution and 2-kilometer horizontal spatial resolution. However, the new data set improves upon - the WIND Toolkit through: url: /api/wind-toolkit/v2/wind/offshore-gulf-of-mexico-download diff --git a/source/docs/wind/wind-toolkit/offshore-hawaii-download.html.md.erb b/source/docs/wind/wind-toolkit/offshore-hawaii-download.html.md.erb index 9b4f8f20..30d390fb 100644 --- a/source/docs/wind/wind-toolkit/offshore-hawaii-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/offshore-hawaii-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Offshore Hawaii Wind Data Download +title: Offshore Hawaii summary: The Offshore Hawaii Dataset is a 21-year wind resource dataset for offshore Hawaii. Produced in 2020, this data set replaces NREL's Wind Integration National Dataset (WIND) Toolkit for offshore Hawaii, which was produced and released publicly in 2013 and is currently the principal data set used by stakeholders for wind resource assessment in the continental United States. Both the WIND Toolkit and this new data set are created using the Weather Research and Forecasting (WRF) numerical weather prediction model (NWP). detail: 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 a link to a file to 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.

The Offshore Hawaii shares many of the same attributes as the WIND Toolkit, including 5-minute time resolution and 2-kilometer horizontal spatial resolution. However, the new data set improves upon - the WIND Toolkit through: url: /api/wind-toolkit/v2/wind/offshore-hawaii-download diff --git a/source/docs/wind/wind-toolkit/offshore-mid-atlantic-download.html.md.erb b/source/docs/wind/wind-toolkit/offshore-mid-atlantic-download.html.md.erb index 3714961c..32f6a301 100644 --- a/source/docs/wind/wind-toolkit/offshore-mid-atlantic-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/offshore-mid-atlantic-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Offshore Mid Atlantic Wind Data Download +title: Offshore Mid Atlantic summary: The Offshore Mid Atlantic Dataset is a 21-year wind resource dataset for the mid Atlantic. Produced in 2020, this data set replaces NREL's Wind Integration National Dataset (WIND) Toolkit for the mid Atlantic, which was produced and released publicly in 2013 and is currently the principal data set used by stakeholders for wind resource assessment in the continental United States. Both the WIND Toolkit and this new data set are created using the Weather Research and Forecasting (WRF) numerical weather prediction model (NWP). detail: 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 a link to a file to 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.

The Offshore Mid Atlantic shares many of the same attributes as the WIND Toolkit, including 5-minute time resolution and 2-kilometer horizontal spatial resolution. However, the new data set improves upon - the WIND Toolkit through: url: /api/wind-toolkit/v2/wind/offshore-mid-atlantic-download diff --git a/source/docs/wind/wind-toolkit/offshore-north-atlantic-download.html.md.erb b/source/docs/wind/wind-toolkit/offshore-north-atlantic-download.html.md.erb index bc1ada37..c7540268 100644 --- a/source/docs/wind/wind-toolkit/offshore-north-atlantic-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/offshore-north-atlantic-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Offshore North Atlantic Wind Data Download +title: Offshore North Atlantic summary: The Offshore North Atlantic Dataset is a 21-year wind resource dataset for the North Atlantic. Produced in 2022, this data set replaces NREL's Wind Integration National Dataset (WIND) Toolkit for the North Atlantic, which was produced and released publicly in 2013 and is currently the principal data set used by stakeholders for wind resource assessment in the continental United States. Both the WIND Toolkit and this new data set are created using the Weather Research and Forecasting (WRF) numerical weather prediction model (NWP). detail: 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 a link to a file to 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.

The Offshore North Atlantic shares many of the same attributes as the WIND Toolkit, including 5-minute time resolution and 2-kilometer horizontal spatial resolution. However, the new data set improves upon - the WIND Toolkit through: url: /api/wind-toolkit/v2/wind/offshore-north-atlantic-download diff --git a/source/docs/wind/wind-toolkit/offshore-nw-pacific-download.html.md.erb b/source/docs/wind/wind-toolkit/offshore-nw-pacific-download.html.md.erb index 58b366a3..54ec5abf 100644 --- a/source/docs/wind/wind-toolkit/offshore-nw-pacific-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/offshore-nw-pacific-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Offshore NW Pacific Wind Data Download +title: Offshore NW Pacific summary: The Offshore NW Pacific Dataset is a 21-year wind resource dataset for offshore NW Pacific. Produced in 2020, this data set replaces NREL's Wind Integration National Dataset (WIND) Toolkit for offshore NW Pacific, which was produced and released publicly in 2013 and is currently the principal data set used by stakeholders for wind resource assessment in the continental United States. Both the WIND Toolkit and this new data set are created using the Weather Research and Forecasting (WRF) numerical weather prediction model (NWP). detail: 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 a link to a file to 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.

The Offshore NW Pacific shares many of the same attributes as the WIND Toolkit, including 5-minute time resolution and 2-kilometer horizontal spatial resolution. However, the new data set improves upon - the WIND Toolkit through: url: /api/wind-toolkit/v2/wind/offshore-nw-pacific-download diff --git a/source/docs/wind/wind-toolkit/philippines-wtk-download.html.md.erb b/source/docs/wind/wind-toolkit/philippines-wtk-download.html.md.erb index 46347d0b..582bfc2c 100644 --- a/source/docs/wind/wind-toolkit/philippines-wtk-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/philippines-wtk-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Philippines WTK Data Download +title: Philippines summary: Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, and direction values at 80m, 100m, and 120m above the surface and air pressure at the surface, 100m, and 200m above the surface for the year 2015 produced using WRF v3.7. The model time resolution used was 15 minutes with a nominal spatial resolution of 3 km2 over Kazakhstan and 9 km2 over the surrounding region. For the U and V components used to derive the wind speed, a total of 41 pressure levels were used. detail: 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 a link to a file to 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. url: /api/wind-toolkit/v2/wind/philippines-wtk-download diff --git a/source/docs/wind/wind-toolkit/southeast-asia-wind-download.html.md.erb b/source/docs/wind/wind-toolkit/southeast-asia-wind-download.html.md.erb index bf083674..8111300f 100644 --- a/source/docs/wind/wind-toolkit/southeast-asia-wind-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/southeast-asia-wind-download.html.md.erb @@ -1,8 +1,9 @@ --- -title: Southeast Asia Wind Data Download +title: Southeast Asia V2 summary: Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, and direction values at 10m, 40m, 80m, 100m, 120m, 160m, and 200m above the surface and air pressure at the surface, 100m, and 200m above the surface for the years 2017 to 2021. The model time resolution used was 15 minutes. detail: 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 a link to a file to 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. url: /api/wind-toolkit/v2/wind/seasia-wtk-download +deprecated: true --- # <%= current_page.data.title %> (<%= current_page.data.url %>) diff --git a/source/docs/wind/wind-toolkit/vietnam-wtk-download.html.md.erb b/source/docs/wind/wind-toolkit/vietnam-wtk-download.html.md.erb index f8eb9fec..e7dfa17c 100644 --- a/source/docs/wind/wind-toolkit/vietnam-wtk-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/vietnam-wtk-download.html.md.erb @@ -1,5 +1,5 @@ --- -title: Vietnam WTK Data Download +title: Vietnam summary: Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, and direction values at 80m, 100m, and 120m above the surface and air pressure at the surface, 100m, and 200m above the surface for the year 2015 produced using WRF v3.7. The model time resolution used was 15 minutes with a nominal spatial resolution of 3 km2 over Kazakhstan and 9 km2 over the surrounding region. For the U and V components used to derive the wind speed, a total of 41 pressure levels were used. detail: 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 a link to a file to 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. url: /api/wind-toolkit/v2/wind/vietnam-wtk-download diff --git a/source/docs/wind/wind-toolkit/wind-toolkit-extract-old.html.md.erb b/source/docs/wind/wind-toolkit/wind-toolkit-extract-old.html.md.erb index 8343202f..ecf270d8 100644 --- a/source/docs/wind/wind-toolkit/wind-toolkit-extract-old.html.md.erb +++ b/source/docs/wind/wind-toolkit/wind-toolkit-extract-old.html.md.erb @@ -1,5 +1,5 @@ --- -title: Wind Toolkit Data +title: Wind Toolkit Data V1 summary: This service has been replaced by V2. See WIND toolkit Download V2 url: /api/wind-toolkit/wind/wtk_download deprecated: true diff --git a/source/docs/wind/wind-toolkit/wtk-bangladesh-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-bangladesh-download.html.md.erb new file mode 100755 index 00000000..8dfcd846 --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-bangladesh-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "Bangladesh" +summary: "Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the years 2014 to 2017." +url: /api/wind-toolkit/v2/wind/wtk-bangladesh-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: inversemoninobukhovlength_2m, pressure_0m, pressure_100m, pressure_200m, relativehumidity_2m, temperature_100m, temperature_10m, temperature_120m, temperature_140m, temperature_160m, temperature_200m, temperature_2m, temperature_30m, temperature_40m, temperature_60m, temperature_80m, winddirection_100m, winddirection_10m, winddirection_120m, winddirection_140m, winddirection_160m, winddirection_200m, winddirection_30m, winddirection_40m, winddirection_60m, winddirection_80m, windspeed_100m, windspeed_10m, windspeed_120m, windspeed_140m, windspeed_160m, windspeed_200m, windspeed_30m, windspeed_40m, windspeed_60m, windspeed_80m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2014, 2015, 2016, 2017.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:60
+
Default: None
+ 		+ This value determines data resolution. Either 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-canada-5min-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-canada-5min-download.html.md.erb new file mode 100755 index 00000000..5326c1ac --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-canada-5min-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "Canada 5Min" +summary: "Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the years 2007 to 2014." +url: /api/wind-toolkit/v2/wind/wtk-canada-5min-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: pressure_100m, temperature_100m, winddirection_100m, windspeed_100m, temperature_10m, winddirection_10m, windspeed_10m, temperature_120m, winddirection_120m, windspeed_120m, temperature_140m, winddirection_140m, windspeed_140m, temperature_160m, winddirection_160m, windspeed_160m, pressure_200m, temperature_200m, winddirection_200m, windspeed_200m, inversemoninobukhovlength_2m, relativehumidity_2m, temperature_2m, temperature_40m, winddirection_40m, windspeed_40m, temperature_60m, winddirection_60m, windspeed_60m, temperature_80m, winddirection_80m, windspeed_80m, precipitationrate_0m, pressure_0m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:5, 15, 30, 60
+
Default: None
+ 		+ This value determines data resolution. Either 5, 15, 30, 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-download.html.md.erb index 2e760299..a5f70cfe 100644 --- a/source/docs/wind/wind-toolkit/wtk-download.html.md.erb +++ b/source/docs/wind/wind-toolkit/wtk-download.html.md.erb @@ -1,9 +1,8 @@ --- -title: Wind Toolkit Data +title: Wind Toolkit Data V2 summary: Collect and download, as CSV, a configurable set of data fields from a national collection of wind stations. The Wind Integration National Dataset (WIND) Toolkit is an update and expansion of the Eastern and Western Wind Datasets, and is intended to support the next generation of integration studies. The WIND Toolkit includes meteorological conditions at multiple hub heights for more than 2,488,136 sites in the continental United States for the years 2007–2014. detail: 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 a link to a file to 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. url: /api/wind-toolkit/v2/wind/wtk-download - --- # <%= current_page.data.title %> (<%= current_page.data.url %>) diff --git a/source/docs/wind/wind-toolkit/wtk-kazakhstan-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-kazakhstan-download.html.md.erb new file mode 100755 index 00000000..6f8e43ef --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-kazakhstan-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "Kazakhstan" +summary: "Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the year 2015." +url: /api/wind-toolkit/v2/wind/wtk-kazakhstan-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: pressure_0m, pressure_100m, pressure_200m, temperature_100m, temperature_120m, temperature_80m, winddirection_100m, winddirection_120m, winddirection_80m, windspeed_100m, windspeed_120m, windspeed_80m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2015.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:15, 30, 60
+
Default: None
+ 		+ This value determines data resolution. Either 15, 30, 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-led-conus-hr-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-led-conus-hr-download.html.md.erb new file mode 100755 index 00000000..a31dd033 --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-led-conus-hr-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "LED Conus High Resolution" +summary: "Collect and download, as CSV, a configurable set of data fields from a national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the years 2017 and 2018." +url: /api/wind-toolkit/v2/wind/wtk-led-conus-hr-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: boundary_layer_height, friction_velocity_2m, inversemoninobukhovlength_2m, latent_heat_flux, pressure_0m, pressure_100m, pressure_200m, relativehumidity_2m, skin_temperature, temperature_100m, temperature_10m, temperature_120m, temperature_140m, temperature_160m, temperature_180m, temperature_200m, temperature_20m, temperature_2m, temperature_40m, temperature_60m, temperature_80m, turbulent_kinetic_energy_100m, turbulent_kinetic_energy_120m, turbulent_kinetic_energy_140m, turbulent_kinetic_energy_160m, turbulent_kinetic_energy_180m, turbulent_kinetic_energy_20m, turbulent_kinetic_energy_40m, turbulent_kinetic_energy_60m, turbulent_kinetic_energy_80m, winddirection_100m, winddirection_10m, winddirection_120m, winddirection_140m, winddirection_160m, winddirection_180m, winddirection_200m, winddirection_20m, winddirection_40m, winddirection_60m, winddirection_80m, windspeed_100m, windspeed_10m, windspeed_120m, windspeed_140m, windspeed_160m, windspeed_180m, windspeed_200m, windspeed_20m, windspeed_40m, windspeed_60m, windspeed_80m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2017, 2018.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:60
+
Default: None
+ 		+ This value determines data resolution. Either 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-maine-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-maine-download.html.md.erb new file mode 100755 index 00000000..4734ec56 --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-maine-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "Maine" +summary: "Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the years 2000 to 2020." +url: /api/wind-toolkit/v2/wind/wtk-maine-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: boundary_layer_height, friction_velocity_2m, inversemoninobukhovlength_2m, pressure_0m, pressure_100m, pressure_200m, pressure_300m, relativehumidity_2m, skin_temperature, temperature_100m, temperature_10m, temperature_120m, temperature_140m, temperature_160m, temperature_180m, temperature_200m, temperature_20m, temperature_220m, temperature_240m, temperature_260m, temperature_280m, temperature_2m, temperature_300m, temperature_400m, temperature_40m, temperature_500m, temperature_60m, temperature_80m, winddirection_100m, winddirection_10m, winddirection_120m, winddirection_140m, winddirection_160m, winddirection_180m, winddirection_200m, winddirection_20m, winddirection_220m, winddirection_240m, winddirection_260m, winddirection_280m, winddirection_300m, winddirection_400m, winddirection_40m, winddirection_500m, winddirection_60m, winddirection_80m, windspeed_100m, windspeed_10m, windspeed_120m, windspeed_140m, windspeed_160m, windspeed_180m, windspeed_200m, windspeed_20m, windspeed_220m, windspeed_240m, windspeed_260m, windspeed_280m, windspeed_300m, windspeed_400m, windspeed_40m, windspeed_500m, windspeed_60m, windspeed_80m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:
+
Default: None
+ 		+ This value determines data resolution. Either minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-mexico-5min-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-mexico-5min-download.html.md.erb new file mode 100755 index 00000000..56891e73 --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-mexico-5min-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "Mexico 5Min" +summary: "Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the years 2007 to 2014." +url: /api/wind-toolkit/v2/wind/wtk-mexico-5min-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: pressure_100m, temperature_100m, winddirection_100m, windspeed_100m, temperature_10m, winddirection_10m, windspeed_10m, temperature_120m, winddirection_120m, windspeed_120m, temperature_140m, winddirection_140m, windspeed_140m, temperature_160m, winddirection_160m, windspeed_160m, pressure_200m, temperature_200m, winddirection_200m, windspeed_200m, inversemoninobukhovlength_2m, relativehumidity_2m, temperature_2m, temperature_40m, winddirection_40m, windspeed_40m, temperature_60m, winddirection_60m, windspeed_60m, temperature_80m, winddirection_80m, windspeed_80m, pressure_0m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:5, 15, 30, 60
+
Default: None
+ 		+ This value determines data resolution. Either 5, 15, 30, 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-north-america-v1-0-0-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-north-america-v1-0-0-download.html.md.erb new file mode 100755 index 00000000..c1b1e7cd --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-north-america-v1-0-0-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "North America V1.0.0" +summary: "Collect and download, as CSV, a configurable set of data fields from a national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the years 2001 to 2020." +url: /api/wind-toolkit/v2/wind/wtk-north-america-v1-0-0-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: precipitation_0m, pressure_0m, pressure_100m, pressure_200m, pressure_500m, temperature_1000m, temperature_100m, temperature_200m, temperature_2m, temperature_300m, temperature_30m, temperature_40m, temperature_500m, temperature_60m, temperature_80m, virtual_potential_temperature_1000m, virtual_potential_temperature_100m, virtual_potential_temperature_200m, virtual_potential_temperature_2m, virtual_potential_temperature_300m, virtual_potential_temperature_30m, virtual_potential_temperature_40m, virtual_potential_temperature_500m, virtual_potential_temperature_60m, virtual_potential_temperature_80m, winddirection_1000m, winddirection_100m, winddirection_10m, winddirection_120m, winddirection_140m, winddirection_160m, winddirection_180m, winddirection_200m, winddirection_250m, winddirection_300m, winddirection_30m, winddirection_32m, winddirection_40m, winddirection_44m, winddirection_47m, winddirection_500m, winddirection_54m, winddirection_57m, winddirection_60m, winddirection_80m, windspeed_1000m, windspeed_100m, windspeed_10m, windspeed_120m, windspeed_140m, windspeed_160m, windspeed_180m, windspeed_200m, windspeed_250m, windspeed_300m, windspeed_30m, windspeed_32m, windspeed_40m, windspeed_44m, windspeed_47m, windspeed_500m, windspeed_54m, windspeed_57m, windspeed_60m, windspeed_80m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:60
+
Default: None
+ 		+ This value determines data resolution. Either 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-now23-california-v1-0-0-5min-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-now23-california-v1-0-0-5min-download.html.md.erb new file mode 100755 index 00000000..560b5191 --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-now23-california-v1-0-0-5min-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "Now23 California V1.0.0 5Min" +summary: "Collect and download, as CSV, a configurable set of data fields from a national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the years 2000 to 2022." +url: /api/wind-toolkit/v2/wind/wtk-now23-california-v1-0-0-5min-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: boundary_layer_height, friction_velocity_2m, inversemoninobukhovlength_2m, pressure_0m, pressure_100m, pressure_200m, pressure_300m, relativehumidity_2m, skin_temperature, temperature_100m, temperature_10m, temperature_120m, temperature_140m, temperature_160m, temperature_180m, temperature_200m, temperature_20m, temperature_220m, temperature_240m, temperature_260m, temperature_280m, temperature_2m, temperature_300m, temperature_400m, temperature_40m, temperature_500m, temperature_60m, temperature_80m, winddirection_100m, winddirection_10m, winddirection_120m, winddirection_140m, winddirection_160m, winddirection_180m, winddirection_200m, winddirection_20m, winddirection_220m, winddirection_240m, winddirection_260m, winddirection_280m, winddirection_300m, winddirection_400m, winddirection_40m, winddirection_500m, winddirection_60m, winddirection_80m, windspeed_100m, windspeed_10m, windspeed_120m, windspeed_140m, windspeed_160m, windspeed_180m, windspeed_200m, windspeed_20m, windspeed_220m, windspeed_240m, windspeed_260m, windspeed_280m, windspeed_300m, windspeed_400m, windspeed_40m, windspeed_500m, windspeed_60m, windspeed_80m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:5, 15, 30, 60
+
Default: None
+ 		+ This value determines data resolution. Either 5, 15, 30, 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-seasiawind-v3-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-seasiawind-v3-download.html.md.erb new file mode 100755 index 00000000..0c573355 --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-seasiawind-v3-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "Southeast Asia V3" +summary: "Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, and direction values at 10m, 40m, 80m, 100m, 120m, 160m, and 200m above the surface and air pressure at the surface, 100m, and 200m above the surface for the years 2007 to 2021. The model time resolution used was 15 minutes." +url: /api/wind-toolkit/v2/wind/wtk-seasiawind-v3-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: pressure_0m, pressure_100m, pressure_200m, temperature_100m, temperature_10m, temperature_120m, temperature_160m, temperature_200m, temperature_40m, temperature_80m, winddirection_100m, winddirection_10m, winddirection_120m, winddirection_160m, winddirection_200m, winddirection_40m, winddirection_80m, windspeed_100m, windspeed_10m, windspeed_120m, windspeed_160m, windspeed_200m, windspeed_40m, windspeed_80m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:15, 30, 60
+
Default: None
+ 		+ This value determines data resolution. Either 15, 30, 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=pressure_200m,temperature_100m,temperature_10m&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "pressure_200m,temperature_100m,temperature_10m", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.
diff --git a/source/docs/wind/wind-toolkit/wtk-south-atlantic-yearly-5min-v1-0-0-download.html.md.erb b/source/docs/wind/wind-toolkit/wtk-south-atlantic-yearly-5min-v1-0-0-download.html.md.erb new file mode 100755 index 00000000..91eefc84 --- /dev/null +++ b/source/docs/wind/wind-toolkit/wtk-south-atlantic-yearly-5min-v1-0-0-download.html.md.erb @@ -0,0 +1,314 @@ +--- +title: "South Atlantic Yearly 5Min V1.0.0" +summary: "Collect and download, as CSV, a configurable set of data fields from a multi-national collection of wind stations. This data represents wind-speed, temperature, direction, and air pressure values at multiple heights above the surface for the years 2000 to 2020." +url: /api/wind-toolkit/v2/wind/wtk-south-atlantic-yearly-5min-v1-0-0-download +--- + +# <%= current_page.data.title %> (<%= current_page.data.url %>) +<%= current_page.data.summary %> + +<%= current_page.data.detail %> + + + +## Request URL + +
GET|POST <%= current_page.data.url %>.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._ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredValueDescription
api_keyYes +
Type: string
+
Default: None
+ 		+

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

+
wktYes +
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. +
attributesNo +
Type: comma delimited string array
+
Default: Returns ALL
+
Options: boundary_layer_height, friction_velocity_2m, inversemoninobukhovlength_2m, pressure_0m, pressure_100m, pressure_200m, pressure_300m, relativehumidity_2m, skin_temperature, temperature_100m, temperature_10m, temperature_120m, temperature_140m, temperature_160m, temperature_180m, temperature_200m, temperature_20m, temperature_220m, temperature_240m, temperature_260m, temperature_280m, temperature_2m, temperature_300m, temperature_400m, temperature_40m, temperature_500m, temperature_60m, temperature_80m, winddirection_100m, winddirection_10m, winddirection_120m, winddirection_140m, winddirection_160m, winddirection_180m, winddirection_200m, winddirection_20m, winddirection_220m, winddirection_240m, winddirection_260m, winddirection_280m, winddirection_300m, winddirection_400m, winddirection_40m, winddirection_500m, winddirection_60m, winddirection_80m, windspeed_100m, windspeed_10m, windspeed_120m, windspeed_140m, windspeed_160m, windspeed_180m, windspeed_200m, windspeed_20m, windspeed_220m, windspeed_240m, windspeed_260m, windspeed_280m, windspeed_300m, windspeed_400m, windspeed_40m, windspeed_500m, windspeed_60m, windspeed_80m.
+ 		+ Each specified attribute(*) will be returned as a column in the resultant CSV download. +
namesYes +
Type: comma delimited string array
+
Default: None
+
Options: 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020.
+ 		The year(s) for which data should be extracted.
utcNo +
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_dayNo +
Type: true or false
+
Default: false
+ 		+ Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. +
intervalYes +
Type:5, 15, 30, 60
+
Default: None
+ 		+ This value determines data resolution. Either 5, 15, 30, 60 minute intervals are available. +
full_nameNo +
Type: string
+
Default: None
+ 		The full name of the user requesting data.
emailYes +
Type: email string
+
Default: None
+ 		+ An active email for the user requesting data. This email will be used to deliver the extracted data. +
affiliationNo +
Type: string
+
Default: None
+ 		+ The organization with which the user requesting the data is affiliated. +
reasonNo +
Type: string
+
Default: None
+ 		The reason that the user is requesting the data.
mailing_listNo +
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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueDescription
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](https://sam.nrel.gov/) and other NREL models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). + +## Examples +Examples may not reflect this specific dataset. + +### JSON Output Format + +
GET <%= current_page.data.url %>.json?api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)
+ +```json +{ + "inputs": { + "body": {}, + "params": {}, + "query": { + "api_key": "{{API_KEY}}", + "attributes": "alpha,aod,ghi,dni,dhi", + "names": "2019", + "utc": "true", + "leap_day": "true", + "interval": "10", + "email": "user@company.com", + "wkt": "POINT(-179.99 -15.94)" + } + }, + "metadata": { + "version": "2.0.0", + "resultset": { + "count": 1 + } + }, + "status": 200, + "outputs": { + "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", + "downloadUrl": "https://mapfiles.nrel.gov/data/solar/332e3704bbdc119e0fb9c6bdafbce0eb.zip" + }, + "errors": [] +} +``` + + +### 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 <%= current_page.data.url %>.csv?api_key={{API_KEY}}&wkt=POINT(-179.99 -15.94)&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=30&email=user@company.com
+ +```csv +Source,Location ID,City,State,Country,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,Clearsky DHI Units,Clearsky DNI Units,Clearsky GHI Units,Dew Point Units,DHI Units,DNI Units,GHI Units,Solar Zenith Angle Units,Temperature Units,Pressure Units,Relative Humidity Units,Precipitable Water Units,Wind Direction Units,Wind Speed,Cloud Type -15,Cloud Type 0,Cloud Type 1,Cloud Type 2,Cloud Type 3,Cloud Type 4,Cloud Type 5,Cloud Type 6,Cloud Type 7,Cloud Type 8,Cloud Type 9,Cloud Type 10,Cloud Type 11,Cloud Type 12,Fill Flag 0,Fill Flag 1,Fill Flag 2,Fill Flag 3,Fill Flag 4,Fill Flag 5,Surface Albedo Units,Version +NSRDB,0,-,b'None',b'None',-15.94,-179.99,0,0,12,w/m2,w/m2,w/m2,c,w/m2,w/m2,w/m2,Degree,c,mbar,%,cm,Degrees,m/s,N/A,Clear,Probably Clear,Fog,Water,Super-Cooled Water,Mixed,Opaque Ice,Cirrus,Overlapping,Overshooting,Unknown,Dust,Smoke,N/A,Missing Image,Low Irradiance,Exceeds Clearsky,Missing CLoud Properties,Rayleigh Violation,N/A,unknown +Year,Month,Day,Hour,Minute,Alpha,AOD,GHI,DNI,DHI +2019,1,1,0,0,1.02,0.0102,0,0,0 +2019,1,1,0,45,1.02,0.0111,0,0,0 +2019,1,1,1,30,1.02,0.0111,0,0,0 +2019,1,1,2,15,1.04,0.0122,0,0,0 +2019,1,1,3,0,1.06,0.013000000000000001,0,0,0 +2019,1,1,3,45,1.07,0.0134,0,0,0 +2019,1,1,4,30,1.07,0.0134,0,0,0 +``` + +### POST request example in Python + +```python +import requests + +url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" + +payload = "api_key={{API_KEY}}&attributes=alpha,aod,ghi,dni,dhi&names=2019&utc=true&leap_day=true&interval=10&email=user@company.com&wkt=POINT(-179.99 -15.94)" + +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](/docs/rate-limits){:target="_blank"} 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 several 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. + +Secondly each user is limited to 20 in-flight requests at any given time. + +In addition, the service has a 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](/docs/wind/wind-toolkit/guide/). + +

Contact

+ +

For questions about the API or the data models please contact wind-toolkit@nrel.gov

+ +

Errors

+ +

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

+ + + + + + + + + + + + + + +
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.