Maritime Choke Point Volume
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
MaritimeChokePointVolume | MaritimeChokePointVolumeQueryParams | MaritimeChokePointVolumeData |
Import Statement
from openbb_core.provider.standard_models.maritime_chokepoint_volume import (
MaritimeChokePointVolumeData,
MaritimeChokePointVolumeQueryParams,
)
Parameters
- standard
- imf
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
chokepoint: Union[str, list[str]]
Description
Name of the chokepoint. Use None for all chokepoints. Choices are:
- suez_canal
- panama_canal
- bosporus_strait
- bab_el_mandeb_strait
- malacca_strait
- strait_of_hormuz
- cape_of_good_hope
- gibraltar_strait
- dover_strait
- oresund_strait
- taiwan_strait
- korea_strait
- tsugaru_strait
- luzon_strait
- lombok_strait
- ombai_strait
- bohai_strait
- torres_strait
- sunda_strait
- makassar_strait
- magellan_strait
- yucatan_channel
- windward_passage
- mona_passage Multiple items allowed for provider(s): imf.
• Optional: True
Data
- standard
- imf
date: Union[date, str]
The date of the data.
date: Union[date, str]
The date of the data.
chokepoint: str
Name of the chokepoint.
vessels_total: int
Number of all ships transiting through the chokepoint on that date. The total is calculated over the sum of vessels_container, vessels_dry_bulk, vessels_general_cargo, vessels_roro and vessels_tanker.
vessels_cargo: int
Total number of ships (excluding tankers) transiting through the chokepoint at this date. This is the sum of vessels_container, vessels_dry_bulk, vessels_general_cargo and vessels_roro.
vessels_tanker: int
Number of tankers transiting through the chokepoint on that date.
vessels_container: int
Number of containers transiting through the chokepoint on that date.
vessels_general_cargo: int
Number of general cargo ships transiting through the chokepoint on that date.
vessels_dry_bulk: int
Yearly average number of dry bulk carriers transiting through the chokepoint. Estimated using AIS data beginning 2019.
vessels_roro: int
Yearly average number of Ro-Ro ships transiting through the chokepoint. Estimated using AIS data beginning 2019.
capacity_total: float
Total trade volume (in metric tons) of all ships transiting through the chokepoint at this date. This is the sum of capacity_container, capacity_dry_bulk, capacity_general_cargo, capacity_roro and capacity_tanker.
capacity_cargo: float
Total trade volume (in metric tons) of all ships (excluding tankers) transiting through the chokepoint at this date. This is the sum of capacity_container, capacity_dry_bulk, capacity_general_cargo and capacity_roro.
capacity_tanker: float
Total trade volume (in metric tons) of tankers transiting through the chokepoint at this date.
capacity_container: float
Total trade volume (in metric tons) of containers transiting through the chokepoint at this date.
capacity_general_cargo: float
Total trade volume (in metric tons) of general cargo Vessels transiting through the chokepoint at this date.
capacity_dry_bulk: float
Total trade volume (in metric tons) of dry bulk carriers transiting through the chokepoint at this date.
capacity_roro: float
Total trade volume (in metric tons) of Ro-Ro ships transiting through the chokepoint at this date.