IEM API Mainpage

Documentation on /cgi-bin/request/hads.py

The backend database for this application has many billion rows of data, so requests can be slow.

Changelog

  • 2024-04-18: Allowed cross-year requests, but limited to 365 days when requesting more than one station.
  • 2024-04-09: Migrated to pydantic based CGI field validation.
  • 2024-03-15: Initial documentation added

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
delim string Delimiter for output
ets string End Time for request
network string Network Identifier
stations Multi-Params or CSV value (required) Station Identifier(s)
sts string Start Time for request
threshold number or null Threshold Value for Searching
thresholdvar string Threshold Variable for Searching
what string Output format
year integer Legacy year value when this service only supported 1 year at a time.
year1 integer or null Start year for request, when sts not set.
year2 integer or null End year for request, when ets not set.
month1 integer Start month for request, when sts not set.
month2 integer End month for request, when ets not set.
day1 integer Start day for request, when sts not set.
day2 integer End day for request, when ets not set.
hour1 integer Start hour for request, when sts not set.
hour2 integer End hour for request, when ets not set.
minute1 integer Start minute for request, when sts not set.
minute2 integer End minute for request, when ets not set.