ShippingV2Service

RouteIntelligence

RouteIntelligence scores a country-pair trade route for chokepoint exposure and current disruption risk. Partner-facing; wire shape is byte-compatible with the pre-migration JSON response documented at docs/api-shipping-v2.mdx. Empty exposure/bypass arrays with empty fetched_at mean the route snapshot is unavailable/degraded, not that the route has confirmed zero exposure. PRO-gated. Requires an active Pro subscription.

get/api/v2/shipping/route-intelligence

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/v2/shipping/route-intelligence
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key
    • HTTP bearer

Query parameters

fromIso2string required

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

toIso2string required

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

cargoTypestring

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.

hs2string

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

jmespathstring

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

OK

fromIso2string
toIso2string
cargoTypestring
hs2string
primaryRouteIdstring
warRiskTierstring

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

disruptionScoreinteger

Disruption score of the primary chokepoint, 0-100.

fetchedAtstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.