ForecastService

GetSimulationPackage

GetSimulationPackage returns the latest forecast simulation package; the response note is populated when a supplied runId does not match the returned package.

get/api/forecast/v1/get-simulation-package

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/forecast/v1/get-simulation-package
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

runIdstring

Optional run identifier. It does not select a package yet: the latest is always returned, and note says when it differs.

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

foundboolean
runIdstring
schemaVersionstring
theaterCountinteger
generatedAtinteger

Warning: Values > 2^53 may lose precision in JavaScript

notestring

Set when run_id differs from the returned package's run_id.

errorError (unresolved $ref)

Changes

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