Maritime Choke Point Info
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
MaritimeChokePointInfo | MaritimeChokePointInfoQueryParams | MaritimeChokePointInfoData |
Import Statement
from openbb_core.provider.standard_models.maritime_chokepoint_info import (
MaritimeChokePointInfoData,
MaritimeChokePointInfoQueryParams,
)
Parameters
- standard
- imf
theme: Literal['dark', 'light'] | None
Theme for the map. Only valid if openbb-charting is installed and chart parameter is set to true. Default is the 'chart_style' setting in user_settings.json, if available, otherwise 'dark'.
Data
- standard
- imf
chokepoint_code: str
Unique ID assigned to the chokepoint by the source.
chokepoint_code: str
Unique ID assigned to the chokepoint by the source.
name: str
Port name.
latitude: float
Latitude of the chokepoint location.
longitude: float
Longitude of the chokepoint location.
vessel_count_total: int
Yearly average number of all ships transiting through the chokepoint. Estimated using AIS data beginning 2019. The total is calculated over the sum of vessel_count_container, vessel_count_dry_bulk, vessel_count_general_cargo, vessel_count_roro and vessel_count_tanker.
vessel_count_tanker: int
Yearly average number of tankers transiting through the chokepoint. Estimated using AIS data beginning 2019.
vessel_count_container: int
Yearly average number of containers transiting through the chokepoint. Estimated using AIS data beginning 2019.
vessel_count_general_cargo: int
Yearly average number of general cargo ships transiting through the chokepoint. Estimated using AIS data beginning 2019.
vessel_count_dry_bulk: int
Yearly average number of dry bulk carriers transiting through the chokepoint. Estimated using AIS data beginning 2019.
vessel_count_roro: int
Yearly average number of Ro-Ro ships transiting through the chokepoint. Estimated using AIS data beginning 2019.
industry_top1: str | None
First dominant traded industries based on the volume of goods estimated to flow through the chokepoint.
industry_top2: str | None
Second dominant traded industries based on the volume of goods estimated to flow through the chokepoint.
industry_top3: str | None
Third dominant traded industries based on the volume of goods estimated to flow through the chokepoint.