port_info
Get general metadata and statistics for all ports from a given provider.
Examples
from openbb import obb
obb.economy.shipping.port_info(provider='imf')
obb.economy.shipping.port_info(provider='imf', continent=asia_pacific)
Parameters
- standard
- imf
continent: Literal['north_america', 'europe', 'asia_pacific', 'south_america', 'africa']
Filter by continent. This parameter is ignored when a country is provided.
• Optional: True
country: Literal['ABW', 'AGO', 'AIA', 'ALB', 'ARE', 'ARG', 'ASM', 'ATG', 'AUS', 'AZE', 'BEL', 'BEN', 'BES', 'BGD', 'BGR', 'BHR', 'BHS', 'BLM', 'BLZ', 'BRA', 'BRB', 'BRN', 'CAN', 'CHL', 'CHN', 'CIV', 'CMR', 'COD', 'COG', 'COK', 'COL', 'COM', 'CPV', 'CRI', 'CUB', 'CUW', 'CYM', 'CYP', 'DEU', 'DJI', 'DMA', 'DNK', 'DOM', 'DZA', 'ECU', 'EGY', 'ERI', 'ESP', 'EST', 'FIN', 'FJI', 'FRA', 'FRO', 'FSM', 'GAB', 'GBR', 'GEO', 'GHA', 'GIB', 'GIN', 'GLP', 'GMB', 'GNB', 'GNQ', 'GRC', 'GRD', 'GTM', 'GUF', 'GUM', 'GUY', 'HKG', 'HND', 'HRV', 'HTI', 'IDN', 'IND', 'IRL', 'IRN', 'IRQ', 'ISL', 'ISR', 'ITA', 'JAM', 'JOR', 'JPN', 'KAZ', 'KEN', 'KHM', 'KIR', 'KNA', 'KOR', 'KWT', 'LBN', 'LBR', 'LBY', 'LCA', 'LKA', 'LTU', 'LVA', 'MAC', 'MAF', 'MAR', 'MDA', 'MDG', 'MDV', 'MEX', 'MHL', 'MLT', 'MMR', 'MNE', 'MNP', 'MOZ', 'MRT', 'MSR', 'MTQ', 'MUS', 'MYS', 'MYT', 'NAM', 'NCL', 'NGA', 'NIC', 'NLD', 'NOR', 'NRU', 'NZL', 'OMN', 'PAK', 'PAN', 'PER', 'PHL', 'PLW', 'PNG', 'POL', 'PRI', 'PRT', 'PYF', 'QAT', 'REU', 'ROU', 'RUS', 'SAU', 'SDN', 'SEN', 'SGP', 'SLB', 'SLE', 'SLV', 'SOM', 'STP', 'SUR', 'SVN', 'SWE', 'SXM', 'SYC', 'SYR', 'TCA', 'TGO', 'THA', 'TKM', 'TLS', 'TON', 'TTO', 'TUN', 'TUR', 'TUV', 'TWN', 'TZA', 'UKR', 'URY', 'USA', 'VCT', 'VEN', 'VGB', 'VIR', 'VNM', 'VUT', 'WSM', 'YEM', 'ZAF']
Country to focus on. Enter as a 3-letter ISO country code. This parameter supersedes continent if both are provided.
• Optional: True
limit: int
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.
• Optional: True
Returns
results: list[PortInfo]
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
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
First dominant traded industries based on the volume of goods estimated to flow through the port.
industry_top2: str
Second dominant traded industries based on the volume of goods estimated to flow through the port.
industry_top3: str
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.