Return to API Services

Documentation for /json/vtec_events.py

This provides metadata on VTEC events for a given WFO and year.

Changelog

  • 2025-01-10: Support providing all events for a given year and wfo.
  • 2024-08-08: Migration to pydantic validation

Example Usage

Provide all NWS Des Moines VTEC events for 2024.

https://mesonet.agron.iastate.edu/json/vtec_events.py?wfo=DMX&year=2024

Provide all NWS Des Moines Tornado Warnings for 2024:

https://mesonet.agron.iastate.edu/json/vtec_events.py?wfo=DMX&year=2024&phenomena=TO&significance=W

Provide all SV, TO, FF, MA events for NWS Des Moines in 2024 in csv format:

https://mesonet.agron.iastate.edu/json/vtec_events.py?wfo=DMX&year=2024&combo=1&fmt=csv

Provide all 2024 tornado warnings for NWS Des Moines in xlsx format:

https://mesonet.agron.iastate.edu/json/vtec_events.py?wfo=DMX&year=2024&phenomena=TO&significance=W&fmt=xlsx

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
callback string or null Legacy JSON-P style callback. It is likely best to not depend on this usage. The IEM website has a permissive CORS.
combo boolean Special one-off to get all SV, TO, FF, MA events
fmt string Output format, json, csv, xlsx
phenomena string or null Two character (uppercase) VTEC phenomena code.
significance string or null One character (uppercase) VTEC significance code.
wfo string 3 character WFO identifier
year integer Year between 1986 and the current year for which the IEM database may have VTEC records.