Skip to main content
GET
/
api
/
forecast
/
v1
/
get-simulation-package
GetSimulationPackage
curl --request GET \
  --url https://api.example.com/api/forecast/v1/get-simulation-package
{
  "found": true,
  "runId": "<string>",
  "pkgKey": "<string>",
  "schemaVersion": "<string>",
  "theaterCount": 123,
  "generatedAt": 123,
  "note": "<string>",
  "error": "<string>"
}

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

​
runId
string

Currently ignored; always returns the latest package. Reserved for Phase 3 per-run lookup.

Response

Successful response

​
found
boolean
​
runId
string
​
pkgKey
string
​
schemaVersion
string
​
theaterCount
integer<int32>
​
generatedAt
integer<int64>

Unix timestamp in milliseconds (from Date.now()). Warning: Values > 2^53 may lose precision in JavaScript.. Warning: Values > 2^53 may lose precision in JavaScript

​
note
string

Populated when req.runId was supplied but does not match the returned package's runId. Indicates that per-run filtering is not yet active and the latest package was returned instead.

​
error
string

Populated when the Redis lookup failed. Distinguish from healthy not-found (found=false, error=""). Value: "redis_unavailable" on Redis errors.