Skip to main content
Cargo volume forecasts and accuracy tracking.

GET /api/v1/forecasts

Cargo volume forecasts by port and methodology. Parameters
NameTypeRequiredDescription
portstringPort slug
methodstring’pipeline’ | ‘statistical’ | ‘ml’
limitnumberDefault 50, max 200
Response
{ "forecasts": [...] }
Example
curl -X GET \
  https://axiomoverwatch.io/api/v1/forecasts?port=VALUE&method=VALUE

GET /api/v1/forecasts/accuracy

Forecast accuracy metrics (MAE, MAPE, directional accuracy). Parameters
NameTypeRequiredDescription
portstringPort slug
methodstringForecast method
Response
{ "accuracy": [...] }
Example
curl -X GET \
  https://axiomoverwatch.io/api/v1/forecasts/accuracy?port=VALUE&method=VALUE

POST /api/v1/predict-destination

Requires API key.
Predict the next destination port for a vessel from its recent movement pattern. The model consumes an ordered sequence of H3 cells the vessel has passed through and, optionally, draft changes that hint at loading or discharge events. Use this when you need a live forward-looking guess — for example, to populate an ETA widget, rank which vessels to investigate next, or enrich a dashboard where the AIS-reported destination is missing or unreliable. Pair this endpoint with GET /api/v1/destination-reliability to decide whether to trust the vessel’s declared destination or fall back to the model prediction. Body
NameTypeRequiredDescription
mmsistringVessel MMSI
active_h3_sequencestring[]Ordered list of H3 cell indexes the vessel has moved through, oldest first. Up to 256 entries
draft_currentnumberCurrent reported draft in meters
draft_deltanumberChange in draft since start of the sequence, in meters
Request payloads are capped at 32 KB. Response
{
  "predictions": [
    { "port": "sgsin", "probability": 0.42 },
    { "port": "mypkg", "probability": 0.19 },
    { "port": "idjkt", "probability": 0.11 }
  ]
}
Example
curl -X POST -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  https://axiomoverwatch.io/api/v1/predict-destination \
  -d '{
    "mmsi": "563123456",
    "active_h3_sequence": ["8a2a1072b59ffff", "8a2a1072b58ffff", "8a2a1072b41ffff"],
    "draft_current": 12.4,
    "draft_delta": -0.8
  }'

GET /api/v1/destination-reliability

Vessel destination declaration reliability scores. Parameters
NameTypeRequiredDescription
vesselstringIMO number
tierstring’reliable’ | ‘moderate’ | ‘unreliable’
limitnumberDefault 100, max 500
Response
{ "reliability": [...] }
Example
curl -X GET \
  https://axiomoverwatch.io/api/v1/destination-reliability?vessel=VALUE&tier=VALUE