> ## Documentation Index > Fetch the complete documentation index at: https://www.worldmonitor.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api/worldmonitor.openapi.yaml get /api/v2/shipping/route-intelligence openapi: 3.1.0 info: title: WorldMonitor API description: >- Unified OpenAPI bundle spanning all WorldMonitor services. Versioning and deprecation policy: https://www.worldmonitor.app/docs/api-versioning contact: name: WorldMonitor email: support@worldmonitor.app version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/v2/shipping/route-intelligence: get: tags: - ShippingV2Service summary: RouteIntelligence description: >- 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. operationId: RouteIntelligence parameters: - name: fromIso2 in: query description: Origin country, ISO-3166-1 alpha-2 uppercase. required: true example: US schema: type: string pattern: ^[A-Z]{2}$ - name: toIso2 in: query description: Destination country, ISO-3166-1 alpha-2 uppercase. required: true example: US schema: type: string pattern: ^[A-Z]{2}$ - name: cargoType in: query description: |- 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. required: false example: container schema: type: string - name: hs2 in: query description: |- 2-digit HS commodity code (default "27" — mineral fuels). Non-digit characters are stripped server-side to match legacy behavior. required: false example: '27' schema: type: string - name: jmespath in: query description: >- 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. required: false example: keys(@) schema: type: string responses: '200': description: Successful response content: application/json: example: bypassOptions: - activationThreshold: example addedCostMultiplier: 75.25 addedTransitDays: 7 id: example-id name: WorldMonitor Analyst cargoType: container chokepointExposures: - chokepointId: suez chokepointName: WorldMonitor Analyst exposurePct: 1 disruptionScore: 42 fetchedAt: '2026-01-15T12:00:00Z' schema: $ref: >- #/components/schemas/worldmonitor_shipping_v2_RouteIntelligenceResponse '400': description: Validation error content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/JmespathProjectionError' '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: Pro subscription required. headers: X-Billing-Verification: description: >- Present when the 403 is a billing-provider-confirmed subscription lapse (value subscription_lapsed, matching the body `code`). schema: type: string content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '429': description: Rate limit exceeded. headers: X-RateLimit-Limit: description: Maximum requests allowed in the active rate-limit window. schema: type: string X-RateLimit-Remaining: description: Requests remaining in the active rate-limit window. schema: type: string X-RateLimit-Reset: description: >- Unix epoch milliseconds when the active rate-limit window resets. schema: type: string Retry-After: description: Seconds to wait before retrying the request. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/RateLimitError' '503': description: >- Service unavailable. Billing-verification responses include code and X-Billing-Verification; other gateway infrastructure failures use the generic GatewayError shape. headers: Retry-After: description: Seconds to wait before retrying (1-60). schema: type: string X-Billing-Verification: description: >- Billing-verification state that produced this response (matches the body `code`). schema: type: string X-Validation-Mode: description: >- Present with value degraded when user API-key validation is temporarily unavailable. schema: type: string X-RateLimit-Mode: description: >- Present with value degraded when a fail-closed rate-limit dependency is unavailable. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/BillingVerificationError' - $ref: '#/components/schemas/GatewayError' default: description: Gateway or handler error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/GatewayError' security: - WorldMonitorKey: [] - ApiKeyHeader: [] - BearerAuth: [] components: schemas: worldmonitor_shipping_v2_RouteIntelligenceResponse: type: object properties: fromIso2: type: string toIso2: type: string cargoType: type: string hs2: type: string primaryRouteId: type: string chokepointExposures: type: array items: $ref: '#/components/schemas/worldmonitor_shipping_v2_ChokepointExposure' bypassOptions: type: array items: $ref: '#/components/schemas/worldmonitor_shipping_v2_BypassOption' warRiskTier: type: string description: >- War-risk tier enum string, e.g., "WAR_RISK_TIER_NORMAL" or "WAR_RISK_TIER_ELEVATED". disruptionScore: type: integer format: int32 description: Disruption score of the primary chokepoint, 0-100. fetchedAt: type: string description: >- ISO-8601 timestamp of when the response was assembled. Empty string means the route snapshot is unavailable/degraded, not confirmed zero exposure. description: |- 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. ValidationError: type: object properties: violations: type: array items: $ref: '#/components/schemas/FieldViolation' description: List of validation violations required: - violations description: >- ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong. JmespathProjectionError: description: >- Returned when a REST jmespath projection is invalid or exceeds the expression/output byte limits. properties: _jmespath_error: description: Projection error discriminator and details. type: string original_keys: description: Top-level keys or shape of the unprojected response. items: type: string type: array required: - _jmespath_error - original_keys type: object UnauthorizedError: type: object properties: error: type: string description: Human-readable error message. required: - error description: >- Returned when the API key is missing, malformed, or lacks current API access. ForbiddenError: type: object properties: error: type: string description: Human-readable entitlement failure reason. code: type: string enum: - subscription_lapsed description: >- Machine-readable denial code, present when the 403 is a billing-provider-confirmed subscription lapse (mirrored in the X-Billing-Verification response header). requiredTier: type: integer format: int32 description: Minimum entitlement tier required for this endpoint. currentTier: type: integer format: int32 description: Caller entitlement tier when known. planKey: type: string description: Caller plan key when known. required: - error description: >- Returned when a PRO-gated endpoint denies access because the caller has no resolved authenticated user, entitlements cannot be verified, or the caller lacks the required entitlement tier. Error: type: object properties: message: type: string description: Error message (e.g., 'user not found', 'database connection failed') description: >- Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize. RateLimitError: type: object description: Returned when a gateway or handler rate limit rejects the request. properties: error: type: string description: Human-readable rate-limit failure reason. required: - error BillingVerificationError: type: object description: >- Returned with HTTP 503 when paid access cannot be confirmed right now: the billing provider is re-verifying a recently expired subscription, or the entitlement backend is unreachable. Retryable — honor Retry-After. properties: error: type: string description: Human-readable billing-verification failure reason. code: type: string enum: - renewal_verification_pending - renewal_verification_failed - entitlement_verification_unavailable description: >- Machine-readable billing-verification state, mirrored in the X-Billing-Verification response header. requiredTier: type: integer format: int32 description: >- Minimum entitlement tier required for this endpoint, when the denial came from a tier gate. required: - error - code GatewayError: type: object description: >- Returned by gateway infrastructure errors before an RPC handler runs, such as origin, routing, method, authentication, or quota checks. properties: error: oneOf: - type: string - type: object additionalProperties: true description: Gateway error reason or structured gateway failure details. required: - error worldmonitor_shipping_v2_ChokepointExposure: type: object properties: chokepointId: type: string chokepointName: type: string exposurePct: type: integer format: int32 description: Single chokepoint exposure for a route. worldmonitor_shipping_v2_BypassOption: type: object properties: id: type: string name: type: string type: type: string description: Type of bypass (e.g., "maritime_detour", "land_corridor"). addedTransitDays: type: integer format: int32 addedCostMultiplier: type: number format: double activationThreshold: type: string description: Enum-like string, e.g., "DISRUPTION_SCORE_60". description: Single bypass-corridor option around a disrupted chokepoint. FieldViolation: type: object properties: field: type: string description: >- The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key') description: type: string description: >- Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing') required: - field - description description: FieldViolation describes a single validation error for a specific field. securitySchemes: WorldMonitorKey: type: apiKey in: header name: X-WorldMonitor-Key description: User-issued WorldMonitor API key. ApiKeyHeader: type: apiKey in: header name: X-Api-Key description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key). BearerAuth: type: http scheme: bearer description: >- Bearer token: a Clerk-issued JWT for browser session flows, passed as Authorization: Bearer . ````