Skip to main content
GET
ComputeEnergyShockScenario

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

country_code
string

ISO 3166-1 alpha-2 country code for the affected energy market.

chokepoint_id
enum<string>

Chokepoint identifier to model as disrupted.

Available options:
hormuz_strait,
malacca_strait,
suez,
bab_el_mandeb
disruption_pct
integer<int32>

Percent of chokepoint flow disrupted, 10 to 100. Other values are clamped; an absent value models 10.

fuel_mode
enum<string>

Fuel mode to model: "oil", "gas", or "both". Defaults to "oil".

Available options:
oil,
gas,
both
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

countryCode
string
chokepointId
string
disruptionPct
integer<int32>
gulfCrudeShare
number<double>

Headline: preCrisisBaseline.gulfCrudeShare, a fraction of import value (tonnes if national_monthly) times the route factor; 0 when that baseline is absent or fuel_mode is gas.

crudeLossKbd
number<double>

Headline: preCrisisBaseline.crudeLossAfterBypassKbd when present, else preCrisisBaseline.crudeLossKbd; 0 when the loss is not modeled or fuel_mode is gas.

products
object[]
effectiveCoverDays
integer<int32>

-1 marks a net oil exporter: the IEA flag, or, without an IEA record, a JODI crude row with positive production, crude exports above imports (unreported imports count as zero; an invalid reported figure disqualifies the row), and production at least refinery intake when intake is reported. No import-cover duration applies. It does not mean domestic supply is unexposed.

assessment
string
dataAvailable
boolean
jodiOilCoverage
boolean

v2 fields

comtradeCoverage
boolean
ieaStocksCoverage
boolean
portwatchCoverage
boolean
coverageLevel
string
limitations
string[]
degraded
boolean
chokepointConfidence
string
liveFlowRatio
number<double>
gasImpact
object
deprecated
gasSensitivity
object
preCrisisBaseline
object

Gulf crude share over one window and the crude loss it implies. preCrisisBaseline: the 12 months before the Hormuz crisis from at least 9 monthly filings (Comtrade, or national statistics for an importer with no Comtrade partner filings), else the annual share (basis comtrade_annual); drives the headline, products and cover. currentFlows: the latest 3 monthly filings since the crisis; absent when unavailable, never used for the products array or cover; the "product balance, current flows" line in limitations nets its crude loss.

currentFlows
object

Gulf crude share over one window and the crude loss it implies. preCrisisBaseline: the 12 months before the Hormuz crisis from at least 9 monthly filings (Comtrade, or national statistics for an importer with no Comtrade partner filings), else the annual share (basis comtrade_annual); drives the headline, products and cover. currentFlows: the latest 3 monthly filings since the crisis; absent when unavailable, never used for the products array or cover; the "product balance, current flows" line in limitations nets its crude loss.

reserveEstimate
object
deprecated

Deprecated: hand-entered reserve estimates were replaced by ReportedStocks.

reportedStocks
object

Month-end oil stocks a country without an IEA record reports to JODI (not IEA data). They set effective_cover_days only when stock_days is present; a net exporter keeps -1. Whether government reserves count depends on the reporter.