SupplyChainService

GetBypassOptions

GetBypassOptions returns ranked bypass corridors for a chokepoint. PRO-gated. Requires entitlement tier >= 1.

get/api/supply-chain/v1/get-bypass-options

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/supply-chain/v1/get-bypass-options
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key
    • HTTP bearer

Query parameters

chokepointIdstring required

Chokepoint identifier to evaluate for bypass options.

cargoTypestring

container | tanker | bulk | roro (default: "container")

closurePctinteger

0-100, percent of capacity blocked (default: 100)

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

chokepointIdstring
cargoTypestring
closurePctinteger
fetchedAtstring
primaryChokepointWarRiskTierWM33 (unresolved $ref)

Changes

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