> ## 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. # GetRouteExplorerLane > GetRouteExplorerLane returns the primary maritime route, chokepoint exposures, bypass options with geometry, war risk, and static transit/freight estimates for a country pair + HS2 + cargo type. PRO-gated. Wraps the route-intelligence vendor endpoint's compute with browser-callable auth and adds fields needed by the Route Explorer UI. Requires entitlement tier >= 1. ## OpenAPI ````yaml /api/SupplyChainService.openapi.yaml get /api/supply-chain/v1/get-route-explorer-lane openapi: 3.1.0 info: title: SupplyChainService API version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/supply-chain/v1/get-route-explorer-lane: get: tags: - SupplyChainService summary: GetRouteExplorerLane description: >- GetRouteExplorerLane returns the primary maritime route, chokepoint exposures, bypass options with geometry, war risk, and static transit/freight estimates for a country pair + HS2 + cargo type. PRO-gated. Wraps the route-intelligence vendor endpoint's compute with browser-callable auth and adds fields needed by the Route Explorer UI. Requires entitlement tier >= 1. operationId: GetRouteExplorerLane parameters: - name: fromIso2 in: query description: ISO 3166-1 alpha-2 origin country code for the trade lane. required: true example: US schema: type: string pattern: ^[A-Z]{2}$ - name: toIso2 in: query description: ISO 3166-1 alpha-2 destination country code for the trade lane. required: true example: US schema: type: string pattern: ^[A-Z]{2}$ - name: hs2 in: query description: HS2 chapter code, e.g. "27", "85" required: true example: '27' schema: type: string - name: cargoType in: query description: 'One of: container, tanker, bulk, roro' required: true example: container 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: - addedCostMultiplier: 75.25 addedTransitDays: 7 fromPort: lat: 40.7128 lon: -74.006 id: example-id name: WorldMonitor Analyst cargoType: container chokepointExposures: - chokepointId: suez chokepointName: WorldMonitor Analyst exposurePct: 1 disruptionScore: 42.5 estFreightUsdPerTeuRange: max: 1 min: 1 schema: $ref: '#/components/schemas/GetRouteExplorerLaneResponse' '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 entitlement access denied. 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' 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: GetRouteExplorerLaneResponse: type: object properties: fromIso2: type: string toIso2: type: string hs2: type: string cargoType: type: string primaryRouteId: type: string description: >- Primary trade route ID from TRADE_ROUTES config. Empty when no modeled lane. primaryRouteGeometry: type: array items: $ref: '#/components/schemas/GeoPoint' chokepointExposures: type: array items: $ref: '#/components/schemas/ChokepointExposureSummary' bypassOptions: type: array items: $ref: '#/components/schemas/BypassCorridorOption' warRiskTier: type: string disruptionScore: type: number format: double estTransitDaysRange: $ref: '#/components/schemas/NumberRange' estFreightUsdPerTeuRange: $ref: '#/components/schemas/NumberRange' noModeledLane: type: boolean description: >- True when the wrapper fell back to the origin's first route (no shared route between origin and destination clusters). Signals "no modeled lane" to the UI. fetchedAt: type: string 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. 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 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 GeoPoint: type: object properties: lon: type: number format: double lat: type: number format: double description: GeoPoint is a [longitude, latitude] pair. ChokepointExposureSummary: type: object properties: chokepointId: type: string chokepointName: type: string exposurePct: type: integer format: int32 BypassCorridorOption: type: object properties: id: type: string name: type: string type: type: string addedTransitDays: type: integer format: int32 addedCostMultiplier: type: number format: double warRiskTier: type: string status: type: string enum: - CORRIDOR_STATUS_UNSPECIFIED - CORRIDOR_STATUS_ACTIVE - CORRIDOR_STATUS_PROPOSED - CORRIDOR_STATUS_UNAVAILABLE description: >- Status of a bypass corridor for UI labeling. "active" means usable today; "proposed" means documented but not yet built/operational; "unavailable" means blockaded or otherwise blocked from use. fromPort: $ref: '#/components/schemas/GeoPoint' toPort: $ref: '#/components/schemas/GeoPoint' description: >- BypassCorridorOption is a single enriched bypass corridor for the Route Explorer UI. Includes coordinate endpoints so the client can call MapContainer.setBypassRoutes directly without any client-side geometry lookup. NumberRange: type: object properties: min: type: integer format: int32 max: type: integer format: int32 description: Inclusive integer range for transit days / freight USD estimates. 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 . ````