Return to API Services or Download Frontend
Changelog
- 2024-09-02: Initial documentation update and pydantic validation
Example Requests
Provide the hourly averaged data on 15 September 2016
Same request, but return as a CSV file
CGI Arguments
The following table lists the CGI arguments that are accepted by this service. A HTTP GET request is required. Fields of type Multi-Params or CSV value can accept either a comma separated list or multiple parameter and value combinations. For example, ?foo=1&foo=2 is equivalent to ?foo=1,2.
| Field | Type | Description |
|---|---|---|
| agg | Multi-Params or CSV value | Aggregation method to use |
| format | string | The format of the response |
| ets | string | End of the period of interest |
| sts | string | Start of the period of interest |
| station | Multi-Params or CSV value (required) | Station(s) to query |
| var | Multi-Params or CSV value (required) | Variable(s) to query |
| window | integer | Window size for aggregation |
| z | Multi-Params or CSV value (required) | Height(s) to query |
| tz | string | A time zone string specified by IANA. Common examples include 'America/Chicago', 'UTC', and 'Etc/UTC'. The code implementation passes this provided string to the python ZoneInfo library. |
| year1 | integer | Start Year, if sts not provided |
| month1 | integer | Start Month, if sts not provided |
| day1 | integer | Start Day, if sts not provided |
| hour1 | integer | Start Hour, if sts not provided |
| year2 | integer | End Year, if ets not provided |
| month2 | integer | End Month, if ets not provided |
| day2 | integer | End Day, if ets not provided |
| hour2 | integer | End Hour, if ets not provided |