chokepoint_info
Get general metadata and statistics for all maritime chokepoint locations from a given provider.
Examples
from openbb import obb
obb.economy.shipping.chokepoint_info(provider='imf')
Parameters
- standard
- imf
theme: Literal['dark', 'light']
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'.
• Optional: True
Returns
results: list[MaritimeChokePointInfo]
Serializable results.
provider: Optional[Literal['imf']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
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
First dominant traded industries based on the volume of goods estimated to flow through the chokepoint.
industry_top2: str
Second dominant traded industries based on the volume of goods estimated to flow through the chokepoint.
industry_top3: str
Third dominant traded industries based on the volume of goods estimated to flow through the chokepoint.