ANTAQ API¶
The ANTAQ module provides port cargo movement data from the Estatístico Aquaviário, published by the National Waterway Transportation Agency.
Functions¶
movimentacao¶
Port cargo movement for a single year.
async def movimentacao(
ano: int,
*,
tipo_navegacao: str | None = None,
natureza_carga: str | None = None,
mercadoria: str | None = None,
porto: str | None = None,
uf: str | None = None,
sentido: str | None = None,
as_polars: bool = False,
return_meta: bool = False,
) -> pd.DataFrame | tuple[pd.DataFrame, MetaInfo]
Parameters:
| Parameter | Type | Description |
|---|---|---|
ano |
int |
Data year (2010-2025) |
tipo_navegacao |
str \| None |
longo_curso, cabotagem, interior, apoio_maritimo, apoio_portuario |
natureza_carga |
str \| None |
granel_solido, granel_liquido, carga_geral, conteiner |
mercadoria |
str \| None |
Filter by commodity (case-insensitive substring) |
porto |
str \| None |
Filter by port (case-insensitive substring) |
uf |
str \| None |
Filter by state (e.g. SP, PR, MT) |
sentido |
str \| None |
embarque or desembarque |
as_polars |
bool |
Return as polars.DataFrame |
return_meta |
bool |
If True, returns a (DataFrame, MetaInfo) tuple |
Returns:
DataFrame with columns: ano, mes, data_atracacao, tipo_navegacao, tipo_operacao,
natureza_carga, sentido, porto, complexo_portuario, terminal, municipio, uf,
regiao, cd_mercadoria, mercadoria, grupo_mercadoria, origem, destino,
peso_bruto_ton, qt_carga, teu
Example:
from agrobr import antaq
# 2024 movement
df = await antaq.movimentacao(2024)
# Filter by state
df = await antaq.movimentacao(2024, uf="SP")
# Filter by navigation type and cargo nature
df = await antaq.movimentacao(
2024,
tipo_navegacao="longo_curso",
natureza_carga="granel_solido",
)
# Filter by commodity
df = await antaq.movimentacao(2024, mercadoria="soja")
Synchronous Version¶
Notes¶
- Source: ANTAQ Estatístico Aquaviário —
livrelicense - Data: bulk ZIP (
;-delimited TXT, UTF-8-sig encoding) - History: 2010+
- Annual ZIPs (~80MB) — download may take a few seconds