Skip to main content
GET
/
api
/
supply-chain
/
v1
/
get-bypass-options
GetBypassOptions
curl --request GET \
  --url https://api.example.com/api/supply-chain/v1/get-bypass-options
{
  "chokepointId": "<string>",
  "cargoType": "<string>",
  "closurePct": 123,
  "options": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "addedTransitDays": 123,
      "addedCostMultiplier": 123,
      "capacityConstraintTonnage": "<string>",
      "suitableCargoTypes": [
        "<string>"
      ],
      "activationThreshold": "<string>",
      "waypointChokepointIds": [
        "<string>"
      ],
      "liveScore": 123,
      "bypassWarRiskTier": "WAR_RISK_TIER_UNSPECIFIED",
      "notes": "<string>"
    }
  ],
  "fetchedAt": "<string>",
  "primaryChokepointWarRiskTier": "WAR_RISK_TIER_UNSPECIFIED"
}

Documentation Index

Fetch the complete documentation index at: https://worldmonitor.app/docs/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

chokepointId
string
cargoType
string

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

closurePct
integer<int32>

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

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