Return to API Services or HML Request.
Documentation for /cgi-bin/request/hml.py
This service provides the processed data from HML products. This service does not emit the HML product itself, but rather the processed data. Due to lame reasons, you can only request forecast data within a single UTC year.
Changelog
- 2026-02-02: Added checks to ensure that dates are after 1 Jan 2012, which is the start of the archive.
- 2024-11-05: Initial implementation
Example Usage
Provide all Guttenberg, IA GTTI4 observation data for 2024 in CSV format:
And then Excel
Provide all Guttenberg, IA GTTI4 forecast data for 2024 in CSV
And then Excel
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 |
|---|---|---|
| kind | string | The type of data to request, either 'obs' or 'forecasts' |
| fmt | string | The format of the output file, either 'csv' or 'excel' |
| 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. |
| sts | string or null | The start timestamp for the data |
| ets | string or null | The end timestamp for the data |
| station | Multi-Params or CSV value (required) | The station(s) to request data for, either multi params or comma separated |
| year1 | integer or null | The start year, if not using sts |
| month1 | integer or null | The start month, if not using sts |
| day1 | integer or null | The start day, if not using sts |
| hour1 | integer | The start hour, if not using sts |
| minute1 | integer | The start minute, if not using sts |
| year2 | integer or null | The end year, if not using ets |
| month2 | integer or null | The end month, if not using ets |
| day2 | integer or null | The end day, if not using ets |
| hour2 | integer | The end hour, if not using ets |
| minute2 | integer | The end minute, if not using ets |