High Resolution Rapid Refresh History
The method which may be used to access the global data sets programmatically is via a REST web services data request. First, establish an account where a unique key will be created and provided. You may have multiple accounts. Each key is configured to allow up to X number of calls per year which was discussed and agreed upon in conversations with your account manager. The definition of a call is noted below.
HTTP Headers and Data Lifetime - Caching and Expiration
For details on appropriate header values as well as caching and expiration definitions, please see: The API Common Usage Guide.
Parameters
Certain parameters are required to initiate a weather request. As is standard in URIs, all parameters are separated using the ampersand (&) character. The list of parameters and their possible values are enumerated below.
Required Parameters
- lat/lon: the latitude and longitude coordinates of the requested location
- startDate: “mm/dd/yyyy” Denotes the start date of the request
- endDate: “mm/dd/yyyy” Denotes the end of the request. Data from this end date is not returned
- peril: Denotes the variable to be returned. Accepted variables are:
- temperature
- wind
- hail
- userKey: Unique identifier
Customizable Parameters
- units: Denotes the units of the request. Accepted values are:
- imperial (Default)
- metric
- interval: Denotes the temporal resolution of the request. Accepted values are:
- hourly (Default)
- daily
- time: Denotes the time zone of the request. Accepted values are:
- gmt (Greenwich mean time) (Default)
- lwt (local wall time)
- format: Denotes the file format of the request. Accepted values are:
- json (Default)
- xml
- csv
- version: Denotes the specific version of the API to be called. Beginning November 2019, please update all endpoints to version 3.
Examples to Retrieve Parameters
1km Hail: |
---|
https://cleanedobservations.weather.com/api/v3/dexter/peril/hail/[40.5,-80.5]?startDate=06/01/2019&endDate=06/05/2019&interval=hourly&units=imperial&time=gmt&format=json&userKey=YourAPIKey |
2km Wind: |
---|
https://cleanedobservations.weather.com/api/v3/dexter/peril/wind/[40.5,-80.5]?startDate=06/01/2019&endDate=06/05/2019&interval=hourly&units=imperial&time=gmt&format=json&userKey=YourAPIKey |