---
title: "GetSimulationPackage"
method: GET
path: "/api/forecast/v1/get-simulation-package"
tags: ["ForecastService"]
---

# GetSimulationPackage

`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`

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

## Query parameters

- `runId` string
- `jmespath` string

## Response `200`

OK

- WorldmonitorForecastV1GetSimulationPackageResponse
  - `found` boolean
  - `runId` string
  - `schemaVersion` string
  - `theaterCount` integer
  - `generatedAt` integer: Warning: Values > 2^53 may lose precision in JavaScript
  - `note` string: Set when run_id differs from the returned package's run_id.
  - `error` Error (unresolved $ref)

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key.
- `403`: API access requires an active subscription (the API key's subscription is inactive or expired).
- `429`: Rate limit exceeded.
- `503`: Service unavailable. Billing-verification responses include code and X-Billing-Verification; other gateway infrastructure failures use the generic GatewayError shape.
- `default`: Gateway or handler error response.

---

[API](https://skmtc.dev/worldmonitor/apis/worldmonitor-api.md) · [All operations](https://skmtc.dev/worldmonitor/apis/worldmonitor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/worldmonitor/apis/worldmonitor-api/revisions/e3dc8463a5c9?raw)