Disruption Events
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
DisruptionEvents | DisruptionEventsQueryParams | DisruptionEventsData |
Import Statement
from openbb_core.provider.standard_models. import (
DisruptionEventsData,
DisruptionEventsQueryParams,
)
Parameters
- standard
- imf
country: str | None
ISO3 country code to restrict the event list to.
alertlevel: str | None
Default: ALL
Alert level filter: 'ALL', 'RED', 'ORANGE', or 'GREEN'.
eventtype: str | None
Optional event-type filter (e.g. 'Cyclone', 'Conflict').
start_date: str | None
ISO date (YYYY-MM-DD) lower bound on the event start (fromdate).
end_date: str | None
ISO date (YYYY-MM-DD) upper bound on the event start (fromdate).
active_only: bool | None
Default: False
If True, restrict to events whose end date is in the future or unset.
theme: str | None
Theme for the map chart. Only used when chart=True.
Data
- standard
- imf
eventid: int
Event identifier.
eventname: str
Event name.
eventtype: str | None
Event type (e.g. 'Conflict').
alertlevel: str | None
Alert level (RED / ORANGE / GREEN).
severitytext: str | None
Free-form severity description.
country: str | None
ISO3 country code of the affected event.
fromdate: str | None
Event start date.
todate: str | None
Event end date (null if ongoing).
editdate: str | None
Last update timestamp.
year: int | None
Year of the event start.
n_affectedports: int | None
Number of ports flagged as affected by this event.
affectedports: str | None
Comma-separated list of affected port IDs.
affectedpopulation: str | None
Estimated population of the affected area.
latitude: float | None
Latitude of the event's centroid.
longitude: float | None
Longitude of the event's centroid.
html_name: str | None
Event name with embedded HTML for rich tooltips.
html_description: str | None
Event description with embedded HTML.
page_id: str | None
IMF Port Watch event-detail page identifier.
object_id: int | None
Internal ArcGIS feature row identifier.
shape_area: float | None
Affected-area polygon area in projected units.
shape_length: float | None
Affected-area polygon perimeter in projected units.