> ## 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. # GetChokepointStatus > GetChokepointStatus retrieves seeded chokepoint status. Empty chokepoints with upstream_unavailable=true means the seed snapshot is unavailable/ degraded, not that there are confirmed zero chokepoints. ## OpenAPI ````yaml /api/SupplyChainService.openapi.yaml get /api/supply-chain/v1/get-chokepoint-status 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-chokepoint-status: get: tags: - SupplyChainService summary: GetChokepointStatus description: >- GetChokepointStatus retrieves seeded chokepoint status. Empty chokepoints with upstream_unavailable=true means the seed snapshot is unavailable/ degraded, not that there are confirmed zero chokepoints. operationId: GetChokepointStatus parameters: - 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: chokepoints: - activeWarnings: 1 affectedRoutes: - example aisDisruptions: 1 congestionLevel: example description: Example WorldMonitor observation. fetchedAt: '2026-01-15T12:00:00Z' upstreamUnavailable: false schema: $ref: '#/components/schemas/GetChokepointStatusResponse' '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: >- API access requires an active subscription (the API key's subscription is inactive or expired). 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' components: schemas: GetChokepointStatusResponse: type: object properties: chokepoints: type: array items: $ref: '#/components/schemas/ChokepointInfo' fetchedAt: type: string description: |- ISO-8601 time the status snapshot was fetched. Empty string with upstream_unavailable=true means the snapshot is unavailable/degraded. upstreamUnavailable: type: boolean description: >- True when upstream seed/relay data is unavailable or partial. When true, an empty chokepoints array is graceful degradation, not confirmed zero data. 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 ChokepointInfo: type: object properties: id: type: string name: type: string lat: type: number format: double lon: type: number format: double disruptionScore: type: integer format: int32 status: type: string description: >- Traffic-light score badge: green (<20), yellow (20-49), or red (>=50). Not an operational closure taxonomy. activeWarnings: type: integer format: int32 congestionLevel: type: string affectedRoutes: type: array items: type: string description: type: string aisDisruptions: type: integer format: int32 directions: type: array items: type: string directionalDwt: deprecated: true type: array items: $ref: '#/components/schemas/DirectionalDwt' transitSummary: $ref: '#/components/schemas/TransitSummary' flowEstimate: $ref: '#/components/schemas/FlowEstimate' warRiskTier: type: string enum: - 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 description: |- * 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. 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. DirectionalDwt: type: object properties: direction: type: string dwtThousandTonnes: type: number format: double wowChangePct: type: number format: double TransitSummary: type: object properties: todayTotal: type: integer format: int32 todayTanker: type: integer format: int32 todayCargo: type: integer format: int32 todayOther: type: integer format: int32 wowChangePct: type: number format: double history: type: array items: $ref: '#/components/schemas/TransitDayCount' riskLevel: type: string incidentCount7d: type: integer format: int32 disruptionPct: type: number format: double riskSummary: type: string riskReportAction: type: string dataAvailable: type: boolean description: >- False when the upstream portwatch/relay source did not return data for this chokepoint in the current cycle — the summary fields are zero-state fill, not a genuine "zero traffic" reading. Client should render a "transit data unavailable" indicator and skip stat/chart rendering. FlowEstimate: type: object properties: currentMbd: type: number format: double description: |- Current estimated flow in million barrels/day. Computed as baseline_mbd * flow_ratio. baselineMbd: type: number format: double description: >- EIA 2023 annual reference level in million barrels/day for the mapped seven-item live-flow subset. flowRatio: type: number format: double description: >- Latest 7-day PortWatch average divided by the preceding rolling baseline window of up to 90 days, clamped to 0.0-1.5. disrupted: type: boolean description: |- True when each of the latest 3 daily ratios is below 85% of the same rolling baseline window. Separate from the green/yellow/red status badge. source: type: string enum: - FLOW_SOURCE_UNSPECIFIED - portwatch-dwt - portwatch-counts description: >- Coverage basis behind a PortWatch-derived flow estimate: "portwatch-dwt" when the rolling baseline window has DWT-majority coverage, otherwise "portwatch-counts" for vessel-count coverage. FLOW_SOURCE_UNSPECIFIED means the cached estimate carried a basis this taxonomy does not list, which the endpoint reports rather than passing through undeclared. Carries the per-value semantics because an enum-typed field takes its generated OpenAPI description from the enum, not from the field. The custom JSON values preserve the strings seed-chokepoint-flows.mjs already writes to energy:chokepoint-flows:v1, so promoting this taxonomy out of prose changes no wire value. hazardAlertLevel: type: string description: >- Nearest active GDACS hazard alert level within the configured radius: "RED", "ORANGE", or empty string when no nearby alert applies. Deliberately an open string rather than a closed enum like source: the empty string is a real published value here, and the pinned sebuf codegen drops an empty (sebuf.http.enum_value), so "" cannot be expressed as an enum's JSON name. Verified at both the zero and a non-zero value; see #6106 before retrying. hazardAlertName: type: string description: |- Name of the nearest active GDACS hazard event within the configured radius, or empty string when no nearby alert applies. TransitDayCount: type: object properties: date: type: string tanker: type: integer format: int32 cargo: type: integer format: int32 other: type: integer format: int32 total: type: integer format: int32 container: type: integer format: int32 dryBulk: type: integer format: int32 generalCargo: type: integer format: int32 roro: type: integer format: int32 capContainer: type: number format: double capDryBulk: type: number format: double capGeneralCargo: type: number format: double capRoro: type: number format: double capTanker: type: number format: double 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). ````