Container Metrics
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ContainerMetrics | ContainerMetricsQueryParams | ContainerMetricsData |
Import Statement
from openbb_core.provider.standard_models. import (
ContainerMetricsData,
ContainerMetricsQueryParams,
)
Parameters
- standard
- imf
metric: str | None
Default: portcalls
Container metric to plot. Allowed: 'portcalls', 'import_container', 'export_container', 'incoming_cargo_container', 'outgoing_cargo_container'.
port_ids: str | None | list[str | None]
Default: TOP10
Comma- or plus-separated port IDs to compare, or 'TOP10' to auto-select the busiest ports for the chosen metric. Multiple items allowed.
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
metric: str
Container metric name.
portid: str
Port identifier (e.g. PORT23).
date: str | str
Observation month (YYYY-MM-DD).
value: float | None
Metric value.