1. Documentation
2. Wave
3. Hindcast Data Downloads
4. Hawaii Hindcast Wave Data

Hawaii Hindcast Wave Data (/api/wave/v2/wave/hawaii-hindcast-download)

Collect and download, as CSV, a configurable set of wave data fields from the DOE-WPTO.

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.

Request URL

GET|POST /api/wave/v2/wave/hawaii-hindcast-download.format?parameters

Request Parameters

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

Response Fields

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

Data File Format

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

Examples

JSON Output Format

{
    "inputs": {
        "body": {},
        "params": {},
        "query": {
            "names": "2010",
            "utc": "true",
            "leap_day": "true",
            "interval": "180",
            "email": "user@company.com",
            "wkt": "POINT (-164 15)"
        }
    },
    "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/wave/f3a8731d7d677f56ebb174e278f6e53e.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.

Source,Location ID,Jurisdiction,Latitude,Longitude,Time Zone,Local Time Zone,Distance to Shore,Directionality Coefficient,Energy Period,Maximum Energy Direction,Mean Absolute Period,Mean Wave Direction,Mean Zero-Crossing Period,Omni-Directional Wave Power,Peak Period,Significant Wave Height,Spectral Width,Water Depth,Version
NSRDB,0,b'None',15,-164,0,-11,821611.2,-,s,deg,s,deg,s,W/m,s,m,-,m,v1.0.0
Year,Month,Day,Hour,Minute,Directionality Coefficient,Energy Period,Maximum Energy Direction,Mean Absolute Period,Mean Wave Direction,Mean Zero-Crossing Period,Omni-Directional Wave Power,Peak Period,Significant Wave Height,Spectral Width,Water Depth
2010,1,1,0,0,0.6799049973487854,10.734100341796875,303.75,8.941699981689453,359.0409851074219,N/A,49074,14.289799690246582,3.053339958190918,0.33434000611305237,
2010,1,1,3,0,0.6549950242042542,10.57800006866455,303.75,8.836999893188477,5.170000076293945,N/A,49255,14.289799690246582,3.081480026245117,0.330159991979599,
2010,1,1,6,0,0.6317160129547119,10.439399719238281,303.75,8.786100387573242,11.456000328063965,N/A,49483,13.00629997253418,3.1090099811553955,0.32264000177383423,
2010,1,1,9,0,0.6239420175552368,10.473199844360352,303.75,8.940899848937988,12.947999954223633,N/A,48713,13.00629997253418,3.079669952392578,0.3077700138092041,

POST request example in Python

import requests

url = "https://developer.nrel.gov/api/wave/v2/wave/hawaii-hindcast-download.json?api_key=yourapikeygoeshere"

payload = "full_name=Sample+User&email=user@company.com&affiliation=Test+Organization&reason=Example&mailing_list=true&wkt=POINT (-164 15)&names=2010&utc=true&leap_day=true"

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

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

print(response.text)

Rate Limits

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

There are 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.

Errors

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