1. Documentation
2. Wind
3. Wind Toolkit Data Downloads
4. Offshore Hawaii

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).

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:

• A 21-year modeling period from 2000 through 2020 (compared to the 7-year 2007-2013 modeling period in the WIND Toolkit)
• Confidence metrics for the hub height wind resource, driven by an ensemble of 16 different WRF simulations run in the 2017 calendar year
• An updated WRF version, from 3.4 used in the WIND Toolkit to version 4.1.2 used here, which incorporates significant R&D advancements
• The use of the state-of-the-art reanalysis product ERA5 to provide atmospheric forcing at the WRF domain boundaries. The ERA5 product is produced by the European Centre for Medium Range Weather Forecasts (ECMWF) and replaces its older ERA-interim product, which was used in the WIND Toolkit.

Request URL

GET /api/wind-toolkit/v2/wind/offshore-hawaii-download.format?parameters

Request Parameters

Response Fields

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

Examples

{
    "inputs": {
        "body": {},
        "params": {},
        "query": {
            "attributes": "winddirection_180m",
            "names": "2017",
            "utc": "false",
            "leap_day": "true",
            "email": "user@company.com",
            "wkt": "POLYGON((-130.756145509839060 48.75520578942107,-130.75571635639668 48.75520578942107,-130.75571635639668 48.75485477666326,-130.75614550983906 48.75485477666326,-130.75614550983906 48.75520578942107))"
        }
    },
    "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/wind/ebc9bbbc34f91c65ac50707d43176c6c.zip"
    },
    "errors": []
}

SiteID,Site Timezone,Data Timezone,Longitude,Latitude,Country
80,-9,-9,-130.756,48.75498,b'Canada'
Year,Month,Day,Hour,Minute,wind direction at 180m (deg)
2017,1,1,0,0,347.18
2017,1,1,0,5,347.3
2017,1,1,0,10,347.40000000000003
2017,1,1,0,15,347.52
2017,1,1,0,20,347.66
2017,1,1,0,25,347.79
2017,1,1,0,30,348
2017,1,1,0,35,348.18
2017,1,1,0,40,348.35

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.

Contact

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

Errors

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