port_info

General metadata and statistics for all IMF Port Watch ports.

Examples

from openbb import obb
obb.imf.port_info(provider='imf')
obb.imf.port_info(provider='imf', continent='asia_pacific')

Parameters

• standard
• imf

continent: str | None
Filter by continent. This parameter is ignored when a country is provided.

country: str | None
Country to focus on. Enter as a 3-letter ISO country code. This parameter supersedes continent if both are provided.

port_code: str | None
This is a dummy parameter to allow grouping in OpenBB Workspace widgets.

limit: int | None
Limit the number of results returned. Limit is determined by the annual average number of vessels transiting through the port. If not provided, all ports are returned.

---

Returns

results: ImfPortInfo

Serializable results.

provider: str | None

Provider name.

warnings: Optional[list[Warning_]]

List of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard
• imf

port_code: str
Unique ID assigned to the port by the source.

port_code: str
Unique ID assigned to the port.

continent: str
Continent where the port is located.

country: str
Country where the port is located.

country_code: str
3-letter ISO code of the country where the port is located.

port_name: str
Port name.

port_full_name: str
Full name of the port.

latitude: float
Latitude of the port.

longitude: float
Longitude of the port.

vessel_count_total: int
Yearly average number of all ships transiting through the port. 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 port. Estimated using AIS data beginning 2019.

vessel_count_container: int
Yearly average number of containers transiting through the port. Estimated using AIS data beginning 2019.

vessel_count_general_cargo: int
Yearly average number of general cargo ships transiting through the port. Estimated using AIS data beginning 2019.

vessel_count_dry_bulk: int
Yearly average number of dry bulk carriers transiting through the port. Estimated using AIS data beginning 2019.

vessel_count_roro: int
Yearly average number of Ro-Ro ships transiting through the port. 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 port.

industry_top2: str | None
Second dominant traded industries based on the volume of goods estimated to flow through the port.

industry_top3: str | None
Third dominant traded industries based on the volume of goods estimated to flow through the port.

share_country_maritime_import: float
Share of the total maritime imports of the country that are estimated to flow through the port.

share_country_maritime_export: float
Share of the total maritime exports of the country that are estimated to flow through the port.