Return to API Services

Documentation for /json/vtec_events_bypoint.py

This service returns VTEC event metadata for a given latitude and longitude point. You can optionally pass an at parameter to specify a specific time to query for VTEC events. The default is to query for all VTEC events that have occurred at the provided point.

Important Note: This service is providing events based on the UGCs associated with the event. In the case of storm based warnings, the UGCs are not the official warning. Use the SBW By Point Service for the official warnings.

Changelog

  • 2024-11-12: Added support for at parameter to query for VTEC events at a specific time.
  • 2024-10-16: Added support for a buffer parameter. The units are in decimal degrees with a range limited between 0 and 1. This buffer is used to expand the search area around the provided point.
  • 2024-08-08: Initial documentation and use pydantic

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 JSONP callback function name
at string Specific time to query for VTEC events. In the case of long fuse events, the at value is compared against the product issuance time as well.
fmt string The format to return the data in, either json or csv
buffer number Buffer in decimal degrees around the provided point
sdate string Start Date
edate string End Date
lat number Latitude
lon number Longitude