Fires Outlook

URL Path

https://data.api.xweather.com/fires/outlook/

Data Coverage

Continental US

Update Interval

2x/day

Time Range

+8 days

The fires/outlook endpoint provides fire weather outlook information based on SPC Fire Weather Outlooks (opens in a new tab). Coverage for this endpoint is available for the US only.

Requests

Every request to the endpoint must include one of the supported actions in the url.

https://data.api.xweather.com/fires/outlook/{action}?client_id={client_id}&client_secret={client_secret}&{params}

Supported Actions

The following actions are supported with the /fires/outlook endpoint:

Action	Description
:id	Type: stringTypically used for passing a geographical location name or identifier such as city name, lat/long, or even US and Canadian postal codes. Learn more.
affects	Type: stringReturns a list of locations that are currently affected by a weather event. Criteria for the location(s) can be determined in your query parameters. Learn more.
contains	Type: stringUsed with polygon based products (convective outlook, drought monitor, etc.) to determine if the queried location is inside of an impacted area. Learn more.
search	Type: stringA generalized action that is determined with the endpoints query parameters. Learn more.
within	Type: stringUses a circle or polygon, define an area to search for results. Learn more.

Response

The following is an example of what each object in the response will consist of. Depending on your requested action, the response may contain multiple instances of this object within an array.

Properties

id (string)

The unique identifier for the event

details (object)

Object containing details about the event

details.product (string)

The product type. Should normally be "firewx"

details.category (string)

The outlook category type.

details.day (number)

Valid coverage day. Value from 1-8

details.range (object)

Object of the valid coverage period information

details.range.minTimestamp (number)

The minimum timestamp of the valid coverage period

details.range.maxTimestamp (number)

The maximum timestamp of the valid coverage period

details.range.minDateTimeISO (string)

The ISO 8601 date time string of the minimum timestamp

details.range.maxDateTimeISO (string)

The ISO 8601 date time string of the maximum timestamp

details.issuedTimestamp (number)

The timestamp of when the event was issued

details.issuedDateTimeISO (string)

The ISO 8601 date time string of when the event was issued

details.risk (object)

Object of the risk associated with the outlook. NULL if no associated risk

details.risk.type (string)

The abbreviated risk type

details.risk.name (string)

The full risk name as provided by SPC

details.risk.code (number)

The coded version of the risk type

geoPoly (object)

GeoJSON object, normally a Polygon or MultiPolygon, for the coverage area. NULL if the geo filter is not provided AND / OR there is no associated risk with the outlook.
Null if not requested (i.e. if filter=geo not provided)

geoPoly.type (string)

The GeoJSON type of the object, Normally "Polygon" or "MultiPolygon"

geoPoly.coordinates (array)

The GeoJSON coordinates array. Normally a 2D array of coordinates, but can be 3D if the type is "MultiPolygon"

[
  {
    "id": "6995ee9a93423c30f7c699acded53563",
    "details": {
      "product": "firewx",
      "category": "firewx",
      "day": 1,
      "range": {
        "minTimestamp": 1702573200,
        "maxTimestamp": 1702641600,
        "minDateTimeISO": "2023-12-14T17:00:00+00:00",
        "maxDateTimeISO": "2023-12-15T12:00:00+00:00"
      },
      "issuedTimestamp": 1702567320,
      "issuedDateTimeISO": "2023-12-14T15:22:00+00:00",
      "risk": null
    },
    "geoPoly": null
  },
  {
    "id": "d5a378e62287c432ad82f776e15ecbb1",
    "details": {
      "product": "firewx",
      "category": "dryltg",
      "day": 1,
      "range": {
        "minTimestamp": 1702573200,
        "maxTimestamp": 1702641600,
        "minDateTimeISO": "2023-12-14T17:00:00+00:00",
        "maxDateTimeISO": "2023-12-15T12:00:00+00:00"
      },
      "issuedTimestamp": 1702567320,
      "issuedDateTimeISO": "2023-12-14T15:22:00+00:00",
      "risk": null
    },
    "geoPoly": null
  }
]

Endpoints