WeatherDotGov (weather_dot_gov v0.2.0)
An API client for weather.gov, autogenerated from https://api.weather.gov/openapi.json See the documentation for information about all the functions available.
Summary
Functions
Returns all currently active alerts
Returns active alerts for the given area (state or marine area)
Returns info on the number of active alerts
Returns active alerts for the given marine region
Returns active alerts for the given NWS public zone or county
Returns all alerts
Returns a specific alert
Returns a list of alert types
Returns a list of Center Weather Advisories from a CWSU
Returns a list of Center Weather Advisories from a CWSU
Returns metadata about a Center Weather Service Unit
Returns glossary terms
Returns raw numerical forecast data for a 2.5km grid area
Returns a textual forecast for a 2.5km grid area
Returns a textual hourly forecast for a 2.5km grid area
Returns a list of observation stations usable for a given 2.5km grid area
Returns a forecast icon. Icon services in API are deprecated.
Returns a forecast icon. Icon services in API are deprecated.
Returns a list of icon codes and textual descriptions. Icon services in API are deprecated.
Returns a list of valid text product types for a given issuance location
Returns metadata about a given observation station
Returns a list of observation stations.
Returns metadata about a NWS forecast office
Returns a specific news headline for a given NWS office
Returns a list of news headlines for a given NWS office
Returns metadata about a given latitude/longitude point
Returns a list of observation stations for a given point
Returns a specific text product
Returns a list of valid text product issuance locations
Returns a list of valid text product types and codes
Returns a list of text products
Returns a list of text products of a given type
Returns a list of text products of a given type for a given issuance location
Returns a list of valid text product issuance locations for a given product type
Returns metadata about a given radar wind profiler
Returns metadata about a given radar queue
Returns metadata about a given radar server
Returns a list of radar servers
Returns metadata about a given radar station
Returns metadata about a given radar station alarms
Returns a list of radar stations
Returns a thumbnail image for a satellite region. Image services in API are deprecated.
Returns a specific SIGMET/AIRMET
Returns a list of SIGMET/AIRMETs
Returns a list of SIGMET/AIRMETs for the specified ATSU
Returns a list of SIGMET/AIRMETs for the specified ATSU for the specified date
Returns the latest observation for a station
Returns a list of observations for a given station
Returns a single observation.
Returns a single Terminal Aerodrome Forecast.
Returns Terminal Aerodrome Forecasts for the specified airport station.
Returns metadata about a given zone
Returns the current zone forecast for a given zone
Returns a list of zones
Returns a list of zones of a given type
Returns a list of observations for a given zone
Returns a list of observation stations for a given zone
Functions
alerts_active()
Returns all currently active alerts
Endpoint: /alerts/active
alerts_active_area(area)
Returns active alerts for the given area (state or marine area)
Endpoint: /alerts/active/area/{area}
alerts_active_count()
Returns info on the number of active alerts
Endpoint: /alerts/active/count
alerts_active_region(region)
Returns active alerts for the given marine region
Endpoint: /alerts/active/region/{region}
alerts_active_zone(zone_id)
Returns active alerts for the given NWS public zone or county
Endpoint: /alerts/active/zone/{zoneId}
alerts_query()
Returns all alerts
Endpoint: /alerts
alerts_single(id)
Returns a specific alert
Endpoint: /alerts/{id}
alerts_types()
Returns a list of alert types
Endpoint: /alerts/types
cwa(cwsu_id, date, sequence)
Returns a list of Center Weather Advisories from a CWSU
Endpoint: /aviation/cwsus/{cwsuId}/cwas/{date}/{sequence}
cwas(cwsu_id)
Returns a list of Center Weather Advisories from a CWSU
Endpoint: /aviation/cwsus/{cwsuId}/cwas
cwsu(cwsu_id)
Returns metadata about a Center Weather Service Unit
Endpoint: /aviation/cwsus/{cwsuId}
glossary()
Returns glossary terms
Endpoint: /glossary
gridpoint(wfo, x, y)
Returns raw numerical forecast data for a 2.5km grid area
Endpoint: /gridpoints/{wfo}/{x},{y}
gridpoint_forecast(wfo, x, y)
Returns a textual forecast for a 2.5km grid area
Endpoint: /gridpoints/{wfo}/{x},{y}/forecast
gridpoint_forecast_hourly(wfo, x, y)
Returns a textual hourly forecast for a 2.5km grid area
Endpoint: /gridpoints/{wfo}/{x},{y}/forecast/hourly
gridpoint_stations(wfo, x, y)
Returns a list of observation stations usable for a given 2.5km grid area
Endpoint: /gridpoints/{wfo}/{x},{y}/stations
icons(set, time_of_day, first)
Returns a forecast icon. Icon services in API are deprecated.
Endpoint: /icons/{set}/{timeOfDay}/{first}
icons_dual_condition(set, time_of_day, first, second)
Returns a forecast icon. Icon services in API are deprecated.
Endpoint: /icons/{set}/{timeOfDay}/{first}/{second}
icons_summary()
Returns a list of icon codes and textual descriptions. Icon services in API are deprecated.
Endpoint: /icons
info()
location_products(location_id)
Returns a list of valid text product types for a given issuance location
Endpoint: /products/locations/{locationId}/types
obs_station(station_id)
Returns metadata about a given observation station
Endpoint: /stations/{stationId}
obs_stations()
Returns a list of observation stations.
Endpoint: /stations
office(office_id)
Returns metadata about a NWS forecast office
Endpoint: /offices/{officeId}
office_headline(office_id, headline_id)
Returns a specific news headline for a given NWS office
Endpoint: /offices/{officeId}/headlines/{headlineId}
office_headlines(office_id)
Returns a list of news headlines for a given NWS office
Endpoint: /offices/{officeId}/headlines
open_api_version()
point(point)
Returns metadata about a given latitude/longitude point
Endpoint: /points/{point}
point_stations(point)
Returns a list of observation stations for a given point
Endpoint: /points/{point}/stations
product(product_id)
Returns a specific text product
Endpoint: /products/{productId}
product_locations()
Returns a list of valid text product issuance locations
Endpoint: /products/locations
product_types()
Returns a list of valid text product types and codes
Endpoint: /products/types
products_query()
Returns a list of text products
Endpoint: /products
products_type(type_id)
Returns a list of text products of a given type
Endpoint: /products/types/{typeId}
products_type_location(type_id, location_id)
Returns a list of text products of a given type for a given issuance location
Endpoint: /products/types/{typeId}/locations/{locationId}
products_type_locations(type_id)
Returns a list of valid text product issuance locations for a given product type
Endpoint: /products/types/{typeId}/locations
radar_profiler(station_id)
Returns metadata about a given radar wind profiler
Endpoint: /radar/profilers/{stationId}
radar_queue(host)
Returns metadata about a given radar queue
Endpoint: /radar/queues/{host}
radar_server(id)
Returns metadata about a given radar server
Endpoint: /radar/servers/{id}
radar_servers()
Returns a list of radar servers
Endpoint: /radar/servers
radar_station(station_id)
Returns metadata about a given radar station
Endpoint: /radar/stations/{stationId}
radar_station_alarms(station_id)
Returns metadata about a given radar station alarms
Endpoint: /radar/stations/{stationId}/alarms
radar_stations()
Returns a list of radar stations
Endpoint: /radar/stations
satellite_thumbnails(area)
Returns a thumbnail image for a satellite region. Image services in API are deprecated.
Endpoint: /thumbnails/satellite/{area}
servers()
sigmet(atsu, date, time)
Returns a specific SIGMET/AIRMET
Endpoint: /aviation/sigmets/{atsu}/{date}/{time}
sigmet_query()
Returns a list of SIGMET/AIRMETs
Endpoint: /aviation/sigmets
sigmets_by_atsu(atsu)
Returns a list of SIGMET/AIRMETs for the specified ATSU
Endpoint: /aviation/sigmets/{atsu}
sigmets_by_atsuby_date(atsu, date)
Returns a list of SIGMET/AIRMETs for the specified ATSU for the specified date
Endpoint: /aviation/sigmets/{atsu}/{date}
station_observation_latest(station_id)
Returns the latest observation for a station
Endpoint: /stations/{stationId}/observations/latest
station_observation_list(station_id)
Returns a list of observations for a given station
Endpoint: /stations/{stationId}/observations
station_observation_time(station_id, time)
Returns a single observation.
Endpoint: /stations/{stationId}/observations/{time}
taf(station_id, date, time)
Returns a single Terminal Aerodrome Forecast.
Endpoint: /stations/{stationId}/tafs/{date}/{time}
tafs(station_id)
Returns Terminal Aerodrome Forecasts for the specified airport station.
Endpoint: /stations/{stationId}/tafs
zone(type, zone_id)
Returns metadata about a given zone
Endpoint: /zones/{type}/{zoneId}
zone_forecast(type, zone_id)
Returns the current zone forecast for a given zone
Endpoint: /zones/{type}/{zoneId}/forecast
zone_list()
Returns a list of zones
Endpoint: /zones
zone_list_type(type)
Returns a list of zones of a given type
Endpoint: /zones/{type}
zone_obs(zone_id)
Returns a list of observations for a given zone
Endpoint: /zones/forecast/{zoneId}/observations
zone_stations(zone_id)
Returns a list of observation stations for a given zone
Endpoint: /zones/forecast/{zoneId}/stations