Skip to content
DeepfireDeepfire Docs
Esc
↑↓navigate↵open⌘Jpreview

Get a simulation (poll here)

The status and, once COMPLETED, the spread polygons. While the run is QUEUED the response carries a Retry-After header; stop polling once status is terminal. Only simulations belonging to your organization are visible.

GET/v1/fire-spread/simulations/{simulationId}
Authorization
AuthorizationBearer token (JWT) · headerrequired
Token from `POST /v1/token` — see the Authentication guide.
Path parameters
simulationIdstring<uuid>required
Responses
200The simulation.
idstring<uuid>
statusstring
`QUEUED` until the worker reports back. `NO_SPREAD` means the model completed but the fire did not grow meaningfully. `FAILED` carries `errorMessage`.
Allowed:QUEUEDCOMPLETEDNO_SPREADFAILED
clusterIdstring<uuid>
Absent for point ignitions.
modelstring
durationHoursinteger
ensembleMembersinteger
sourcesstring[]
The source codes that were eligible to seed the run: what you passed, or the defaults expanded.
lookbackHoursinteger | null
latitudenumber
longitudenumber
locationNamestring
ignitionPointCountinteger
Hotspots that seeded the run (at most 100; the most recent and most intense are kept when a cluster has more).
ignitionIgnitionFeatureCollection
GeoJSON `Point` features for the hotspots that seeded the run, with `hotspotId`, `source`, `observedAt` and `fireRadiativePower` properties.
Show properties
typestring
featuresobject[]
createdAtstring<date-time>
errorMessagestring
Present when `FAILED`.
summaryobject
Model outputs. Absent until the worker has reported back.
Show properties
burnedAreaM2number
Final burned area in square metres.
edgeReachedboolean
True when the fire reached the edge of the modelled domain, so the last polygons are clipped.
windSpeedAvgMsnumber
Mean wind speed over the run, m/s.
windDirectionAvgnumber
Mean wind direction, degrees.
resultobject
GeoJSON `FeatureCollection`, present once `COMPLETED`. One `MultiPolygon` feature per simulated hour with `properties.hour` (1…durationHours), `properties.elapsed_seconds`, and `properties.burn_probability` for ensemble runs. Each polygon is cumulative: the area burned by that hour.
linksobject
Show properties
selfstring<uri>
404`simulation-not-found`: unknown id, or a simulation owned by another organization.
codestring
Stable machine-readable code: `invalid-request`, `cluster-not-found`, `simulation-not-found`, `too-many-simulations`.
messagestring
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.deepfire.co/v1/fire-spread/simulations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "QUEUED",
  "clusterId": "a3d24843-7014-4490-bdd3-b7cb39b400c8",
  "model": "string",
  "durationHours": 0,
  "ensembleMembers": 0,
  "sources": [
    "string"
  ],
  "lookbackHours": 0,
  "latitude": 0,
  "longitude": 0,
  "locationName": "string",
  "ignitionPointCount": 0,
  "ignition": {
    "type": "FeatureCollection",
    "features": [
      {}
    ]
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "errorMessage": "string",
  "summary": {
    "burnedAreaM2": 0,
    "edgeReached": true,
    "windSpeedAvgMs": 0,
    "windDirectionAvg": 0
  },
  "result": {},
  "links": {
    "self": "http://example.com"
  }
}