Skip to main content
GET
RouteIntelligence

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

fromIso2
string
required

Origin country, ISO-3166-1 alpha-2 uppercase.

Pattern: ^[A-Z]{2}$
toIso2
string
required

Destination country, ISO-3166-1 alpha-2 uppercase.

Pattern: ^[A-Z]{2}$
cargoType
string

Cargo type — one of: container (default), tanker, bulk, roro. Empty string defers to the server default. Unknown values are coerced to "container" to preserve legacy behavior.

hs2
string

2-digit HS commodity code (default "27" — mineral fuels). Non-digit characters are stripped server-side to match legacy behavior.

jmespath
string

Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath.

Response

Successful response

RouteIntelligenceResponse wire shape preserved byte-for-byte from the pre-migration JSON at docs/api-shipping-v2.mdx. fetched_at is intentionally a string (ISO-8601) rather than int64 epoch ms because partners depend on the ISO-8601 shape.

fromIso2
string
toIso2
string
cargoType
string
hs2
string
primaryRouteId
string
chokepointExposures
object[]
bypassOptions
object[]
warRiskTier
string

War-risk tier enum string, e.g., "WAR_RISK_TIER_NORMAL" or "WAR_RISK_TIER_ELEVATED".

disruptionScore
integer<int32>

Disruption score of the primary chokepoint, 0-100.

fetchedAt
string

ISO-8601 timestamp of when the response was assembled. Empty string means the route snapshot is unavailable/degraded, not confirmed zero exposure.