port_volume

Daily port calls and estimated trading volumes from IMF Port Watch.

Examples

from openbb import obb
# Daily port calls and estimated trading volumes for specific ports.
obb.imf.port_volume(provider='imf', port_code='rotterdam,singapore')
# All ports in a specific country (ISO3 code).
obb.imf.port_volume(provider='imf', country='GBR')

Parameters

• standard
• imf

start_date: date | None
Start date of the data, in YYYY-MM-DD format.

end_date: date | None | str
End date of the data, in YYYY-MM-DD format.

start_date: date | None
Start date of the data, in YYYY-MM-DD format.

end_date: date | None | str
End date of the data, in YYYY-MM-DD format.

port_code: str | None | list[str | None]
Port code to filter results by a specific port. This parameter is ignored if country parameter is provided. To get a list of available ports, use obb.economy.shipping.port_info(). Multiple items allowed.

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

---

Returns

results: ImfPortVolume

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

date: date | str
The date of the data.

port_code: str | None
Port code.

port_name: str | None
Port name.

country: str | None
Country where the port is located.

date: date | str
The date of the data.

port_code: str | None
Port code.

port_name: str | None
Port name.

country: str | None
Country where the port is located.

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

portcalls: int
Total number of ships entering the port at this date. This is the sum of portcalls_container, portcalls_dry_bulk, portcalls_general_cargo, portcalls_roro and portcalls_tanker.

portcalls_tanker: int
Number of tankers transiting through the chokepoint or making a port call.

portcalls_container: int
Number of containers transiting through the chokepoint or making a port call.

portcalls_general_cargo: int
Number of general cargo ships transiting through the chokepoint or making a port call.

portcalls_dry_bulk: int
Number of dry bulk carriers transiting through the chokepoint or making a port call.

portcalls_roro: int
Number of Ro-Ro ships transiting through the chokepoint or making a port call.

imports: float
Total import volume (in metric tons) of all ships entering the port at this date. This is the sum of import_container, import_dry_bulk, import_general_cargo, import_roro and import_tanker.

imports_cargo: float
Total import volume (in metric tons) of all ships (excluding tankers) entering the port at this date. This is the sum of import_container, import_dry_bulk, import_general_cargo and import_roro.

imports_tanker: float
Total import volume (in metric tons) of tankers entering the port at this date.

imports_container: float
Total import volume (in metric tons) of all container ships entering the port at this date.

imports_general_cargo: float
Total import volume (in metric tons) of general cargo ships entering the port at this date.

imports_dry_bulk: float
Total import volume (in metric tons) of dry bulk carriers entering the port at this date.

imports_roro: float
Total import volume (in metric tons) of Ro-Ro ships entering the port at this date.

exports: float
Total export volume (in metric tons) of all ships entering the port at this date. This is the sum of export_container, export_dry_bulk, export_general_cargo, export_roro and export_tanker.

exports_cargo: float
Total export volume (in metric tons) of all ships (excluding tankers) entering the port at this date. This is the sum of export_container, export_dry_bulk, export_general_cargo and export_roro.

exports_tanker: float
Total export volume (in metric tons) of tankers entering the port at this date.

exports_container: float
Total export volume (in metric tons) of all container ships entering the port at this date.

exports_general_cargo: float
Total export volume (in metric tons) of general cargo ships entering the port at this date.

exports_dry_bulk: float
Total export volume (in metric tons) of dry bulk carriers entering the port at this date.

exports_roro: float
Total export volume (in metric tons) of Ro-Ro ships entering the port at this date.