Skip to main content
GET
GetBypassOptions

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

chokepointId
string
required

Chokepoint identifier to evaluate for bypass options.

cargoType
string

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

closurePct
integer<int32>

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

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

chokepointId
string
cargoType
string
closurePct
integer<int32>
options
object[]
fetchedAt
string
primaryChokepointWarRiskTier
enum<string>

War risk tier derived from Lloyd's JWC Listed Areas + OSINT threat classification. This is a FREE field (no PRO gate) — it exposes the existing server-internal threatLevel from ChokepointConfig, making it available to clients for badges and bypass corridor scoring.

Available options:
WAR_RISK_TIER_UNSPECIFIED,
WAR_RISK_TIER_NORMAL,
WAR_RISK_TIER_ELEVATED,
WAR_RISK_TIER_HIGH,
WAR_RISK_TIER_CRITICAL,
WAR_RISK_TIER_WAR_ZONE