Alerts API¶
Helios Alerts API.
Methods are meant to represent the core functionality in the developer documentation. Some may have additional functionality for convenience.
-
class
helios.alerts_api.Alerts(session=None)[source]¶ Helios alerts provide real-time severe weather alerts.
National Weather Service:
- Severe weather alerts for the United States are provided by the National Weather Service. These alerts cover events such as Flood Warnings, Severe Thunderstorm Warnings, and Special Weather Statements.
Helios:
- Alerts generated by Helios are based on the sensor measurements from the Observations API. These alerts represent regional areas with a high detection confidence and currently include: Road Wetness Watch, Poor Visibility Watch, and Heavy Precip Watch.
-
index(**kwargs)[source]¶ Get alerts matching the provided spatial, text, or metadata filters.
The maximum skip value is 4000. If this is reached, truncated results will be returned. You will need to refine your query to avoid this.
Parameters: **kwargs – Any keyword arguments found in the alerts_index_documentation. Returns: - A tuple containing:
- feature_collection (
AlertsFeatureCollection): - Alerts feature collection.
- failed (list of
Record): - Failed API call records.
- feature_collection (
Return type: tuple
-
show(alert_ids)[source]¶ Get attributes for alerts.
Parameters: alert_ids (str or list of strs) – Helios alert ID(s). Returns: - A tuple containing:
- feature_collection (
AlertsFeatureCollection): - Alerts feature collection.
- failed (list of
Record): - Failed API call records.
- feature_collection (
Return type: tuple
-
class
helios.alerts_api.AlertsFeature(feature)[source]¶ Individual Alert GeoJSON feature.
-
area_description¶ ‘areaDesc’ value for the feature.
Type: str
-
bbox¶ ‘bbox’ value for the feature.
Type: list of floats
-
category¶ ‘category’ value for the feature.
Type: str
-
certainty¶ ‘certainty’ value for the feature.
Type: str
-
country¶ ‘country’ value for the feature.
Type: str
-
description¶ ‘description’ value for the feature.
Type: str
-
effective¶ ‘effective’ value for the feature.
Type: str
-
event¶ ‘event’ value for the feature.
Type: str
-
expires¶ ‘expires’ value for the feature.
Type: str
-
headline¶ ‘headline’ value for the feature.
Type: str
-
id¶ ‘id’ value for the feature.
Type: str
-
json¶ Raw ‘json’ for the feature.
Type: dict
-
origin¶ ‘origin’ value for the feature.
Type: str
-
severity¶ ‘severity’ value for the feature.
Type: str
-
states¶ ‘states’ value for the feature.
Type: list of strs
-
status¶ ‘status’ value for the feature.
Type: str
-
urgency¶ ‘urgency’ value for the feature.
Type: str
-
-
class
helios.alerts_api.AlertsFeatureCollection(features)[source]¶ Collection of GeoJSON features obtained via the Alerts API.
Convenience properties are available to extract values from every feature.
-
features¶ All features returned from a query.
Type: list of AlertsFeature
-
area_description¶ ‘areaDesc’ values for every feature.
-
bbox¶ ‘bbox’ values for every feature.
-
category¶ ‘category’ values for every feature.
-
certainty¶ ‘certainty’ values for every feature.
-
country¶ ‘country’ values for every feature.
-
description¶ ‘description’ values for every feature.
-
effective¶ ‘effective’ values for every feature.
-
event¶ ‘event’ values for every feature.
-
expires¶ ‘expires’ values for every feature.
-
headline¶ ‘headline’ values for every feature.
-
id¶ ‘id’ values for every feature.
-
json¶ Raw ‘json’ for every feature.
-
origin¶ ‘origin’ values for every feature.
-
severity¶ ‘severity’ values for every feature.
-
states¶ ‘states’ values for every feature.
-
status¶ ‘status’ values for every feature.
-
urgency¶ ‘urgency’ values for every feature.
-