Earnings & Freight

Voyage earnings estimates and freight rate data.

`GET` `/api/v1/earnings`

Per-voyage earnings estimates. Parameters

Name	Type	Description
`vessel`	string	IMO number
`port`	string	Port slug
`limit`	number	Default 50, max 200

Response

{ "earnings": [...] }

Example

curl -X GET \
  https://axiomoverwatch.io/api/v1/earnings?vessel=VALUE&port=VALUE

Weekly port revenue aggregates. Parameters

Name	Type	Required	Description
`port`	string		Port slug
`limit`	number		Default 52, max 200

Response

{ "port_revenue": [...] }

Example

curl -X GET \
  https://axiomoverwatch.io/api/v1/earnings/port-revenue?port=VALUE&limit=VALUE

Freight rate data by vessel type. Parameters

Name	Type	Required	Description
`vessel_type`	string		Vessel type filter
`limit`	number		Default 50, max 200

Response

{ "freight_rates": [...] }

Example

curl -X GET \
  https://axiomoverwatch.io/api/v1/freight-rates?vessel_type=VALUE&limit=VALUE

Requires API key.

Submit a new freight rate record. Response

{ "freight_rate": {...} }

Example

curl -X POST -H "X-API-Key: YOUR_KEY" \
  https://axiomoverwatch.io/api/v1/freight-rates \
  -d '{"key":"value"}'

⌘I