Monthly Trade
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
MonthlyTrade | MonthlyTradeQueryParams | MonthlyTradeData |
Import Statement
from openbb_core.provider.standard_models. import (
MonthlyTradeData,
MonthlyTradeQueryParams,
)
Parameters
- standard
- imf
code: str | None
Default: USA
ISO3 country code or IMF region code (e.g. 'USA', 'ASEAN-5').
metric: str | None
Default: trade_value
TradeNow metric: 'trade_value', 'trade_volume', or 'portcalls'.
start_date: str | None
ISO date (YYYY-MM-DD) lower bound for the monthly series.
end_date: str | None
ISO date (YYYY-MM-DD) upper bound for the monthly series.
theme: str | None
Theme for the chart. Only used when chart=True.
Data
- standard
- imf
date: str | str
Observation month (YYYY-MM-DD).
country_code: str
ISO3 country or IMF region code.
region: str | None
IMF region label.
trade_value: float | None
Trade value nowcast index (2019 = 100).
trade_volume: float | None
Trade volume nowcast index (2019 = 100).
value_import_total: float | None
Imports component of the trade value index.
value_export_total: float | None
Exports component of the trade value index.
volume_import_total: float | None
Imports component of the trade volume index.
volume_export_total: float | None
Exports component of the trade volume index.
ais_portcalls_container: int | None
Monthly AIS port calls by container ships.
ais_portcalls_dry_bulk: int | None
Monthly AIS port calls by dry-bulk carriers.
ais_portcalls_general_cargo: int | None
Monthly AIS port calls by general-cargo ships.
ais_portcalls_roro: int | None
Monthly AIS port calls by Ro-Ro ships.
ais_portcalls_tanker: int | None
Monthly AIS port calls by tankers.
ais_import_container: int | None
Monthly AIS import volume by container ships.
ais_import_dry_bulk: int | None
Monthly AIS import volume by dry-bulk carriers.
ais_import_general_cargo: int | None
Monthly AIS import volume by general-cargo ships.
ais_import_roro: int | None
Monthly AIS import volume by Ro-Ro ships.
ais_import_tanker: int | None
Monthly AIS import volume by tankers.
ais_export_container: int | None
Monthly AIS export volume by container ships.
ais_export_dry_bulk: int | None
Monthly AIS export volume by dry-bulk carriers.
ais_export_general_cargo: int | None
Monthly AIS export volume by general-cargo ships.
ais_export_roro: int | None
Monthly AIS export volume by Ro-Ro ships.
ais_export_tanker: int | None
Monthly AIS export volume by tankers.