Country Activity
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CountryActivity | CountryActivityQueryParams | CountryActivityData |
Import Statement
from openbb_core.provider.standard_models. import (
CountryActivityData,
CountryActivityQueryParams,
)
Parameters
- standard
- imf
country_code: str | None
Default: USA
ISO3 country code to fetch daily activity for.
metric: str | None
Default: portcalls
Activity metric to chart: 'portcalls', 'import', or 'export'.
start_date: str | None
ISO date (YYYY-MM-DD) lower bound for the activity window.
end_date: str | None
ISO date (YYYY-MM-DD) upper bound for the activity window.
theme: str | None
Theme for the chart. Only used when chart=True.
Data
- standard
- imf
date: str | str
Observation date (YYYY-MM-DD).
country_code: str
ISO3 country code.
country: str | None
Country display name.
portcalls: int | None
Total ships calling at the country's ports on this date.
portcalls_cargo: int | None
Total cargo ships (excluding tankers) calling on this date.
portcalls_container: int | None
Container-ship port calls on this date.
portcalls_dry_bulk: int | None
Dry-bulk-carrier port calls on this date.
portcalls_general_cargo: int | None
General-cargo-ship port calls on this date.
portcalls_roro: int | None
Ro-Ro-ship port calls on this date.
portcalls_tanker: int | None
Tanker port calls on this date.
portcalls_container_30ma: float | None
30-day moving average of container port calls.
portcalls_container_30ma_yoy_doy: float | None
Year-over-year change in the 30-day MA of container port calls, keyed on day of year.
imports: int | None
Total import volume (mt) of all ships entering on this date.
imports_cargo: int | None
Total import volume (mt) of cargo ships (excluding tankers).
imports_container: int | None
Total import volume (mt) of container ships on this date.
imports_dry_bulk: int | None
Total import volume (mt) of dry-bulk carriers on this date.
imports_general_cargo: int | None
Total import volume (mt) of general-cargo ships on this date.
imports_roro: int | None
Total import volume (mt) of Ro-Ro ships on this date.
imports_tanker: int | None
Total import volume (mt) of tankers on this date.
imports_container_30ma: float | None
30-day moving average of container import volume.
imports_container_30ma_yoy_doy: float | None
Year-over-year change in the 30-day MA of container import volume, keyed on day of year.
exports: int | None
Total export volume (mt) of all ships departing on this date.
exports_cargo: int | None
Total export volume (mt) of cargo ships (excluding tankers).
exports_container: int | None
Total export volume (mt) of container ships on this date.
exports_dry_bulk: int | None
Total export volume (mt) of dry-bulk carriers on this date.
exports_general_cargo: int | None
Total export volume (mt) of general-cargo ships on this date.
exports_roro: int | None
Total export volume (mt) of Ro-Ro ships on this date.
exports_tanker: int | None
Total export volume (mt) of tankers on this date.
exports_container_30ma: float | None
30-day moving average of container export volume.
exports_container_30ma_yoy_doy: float | None
Year-over-year change in the 30-day MA of container export volume, keyed on day of year.
shipment: int | None
Total shipment volume (mt) crossing the country on this date.
shipment_30ma: float | None
30-day moving average of total shipment volume.
shipment_30ma_yoy_doy: float | None
Year-over-year change in the 30-day MA of total shipment volume, keyed on day of year.