Fires API v1 beta

Last updated: Jun 19, 2019

The Fires API lets you request fire information for an area around a specific location. The API provides endpoints that let you query:

Fires API is a new product which currently runs in Beta. That indicates possible additional fields which may be added to the product in the near future. With that in mind, you can expect no breaking changes will take place.

Current Conditions

Last updated: Jun 19, 2019

Returns current fire conditions for relevant fires in the area around a specific location

https://api.breezometer.com/fires/v1/current-conditions?lat={latitude}&lon={longitude}&key=YOUR_API_KEY&radius={radius}

Request Parameters

While making an API request some parameters are required while some are optional.

lat
float
Latitude (lat) specifies north-south position of a point in a range between -90 and 90
Required
lon
float
Longitude (lon) specifies east-west position of a point in a range between -180 to 180
Required
key
string
Your BreezoMeter API key
Required
radius
float
Sets the radius for an area around the requested lat/lon to retrieve fire information in the response

Values can vary between:
  • Metric unit system: 1-100 (kilometers)
  • Imperial unit system: 1-62 (miles)
Optional
default: 30 km / 18 mi
metadata
boolean
Includes request metadata in the response

For more information, see Metadata
Optional
default: false
units
string
Sets the response measurement system to either:
  • metric for Metric (default)
  • imperial for Imperial
For more information, see Unit Systems
Optional
default: metric
lang
string
Sets the response language to either:
  • en for English (default)
Optional
default: en

Examples

Last updated: Jun 19, 2019

Response with Relevant Fires

This example shows a request to get the current fire conditions in the area around a specific location in Yosemite National Park (37.842447, -119.518259) using the default request parameter settings.

https://api.breezometer.com/fires/v1/current-conditions?lat=37.842447&lon=-119.518259&key=YOUR_API_KEY

TIP

Note:

In this example, only fires within 30 km of the requested lat/lon (equal to approx 18 miles) will be returned, as it uses the default ‘radius’ setting which is set to a 30 km radius.

The request returns this response:

  -   {         "metadata" null ,     -     "data" {           "datetime" "2019-06-13T12:00:00Z" ,           "data_available" true ,     -       "fires" [     +         {  /* 5 items */  } ,     +         {  /* 5 items */  }           ]         } ,        "error" null       }  

Response Without Relevant Fires

This example shows a request to get the current fire conditions in the area around central San Francisco (37.788472, -122.405711) using the default request parameter settings.

https://api.breezometer.com/fires/v1/current-conditions?lat=37.788472&lon=-122.405711&key=YOUR_API_KEY

TIP

Note:

In this example, the response includes an empty ‘fires’ array which indicates that there are no relevant fires within a 30 km radius around the requested location.

The request returns this response:

    "loading..."  

Response Data Fields

Last updated: Jun 19, 2019

The response data field is an object that includes the following fields:

TIP

Note:

  • By default, the response uses metric units. For more information, see Unit Systems
  • In a case where fire data is completely unavailable, the data_available field returns with false, and the rest of the expected root level elements (fires) returns null.
datetime
string
ISO 8601 UTC timestamp indicating the time the data refers to
data_available
boolean
True/false indicating whether fire data is generally available with the service
fires
array | null
An array of objects where each object represents a single fire relevant for the requested location

Note:
  • Objects will be ordered from nearest to farthest from the requested location.
  • In a case where there are no relevant fires within the radius set in the request, the array returns empty.
Show child fields

Metadata

Last updated: Jun 19, 2019

Request Metadata

Last updated: Jun 19, 2019

Any request to an API endpoint can return metadata that describes the original request. You request metadata by including the metadata parameter in your request with the value true. When excluding the metadata parameter, or setting it to false, the metadata field returns null.

Single Object

Requests for a specific date and time return a single object, and a metadata object with a single timestamp. This example shows a request to the current conditions endpoint for a specific date and time that returns metadata:

https://api.breezometer.com/fires/v1/current-conditions?lat=37.842447&lon=-119.518259&key=YOUR_API_KEY&metadata=true

The request returns this metadata object as part of the response:

  -   {     -     "metadata" {           "timestamp" "2019-06-16T01:58:21Z" ,     -       "location" {             "country" "United States"           }         } ,           "data" {  ...  } ,         "error" null       }  

Metadata Fields

Metadata objects can include these fields:

datetime
string
ISO 8601 UTC timestamp indicating the time the request was made
location
object
Object containing information describing the requested location
Show child fields

Unit Systems

Last updated: Jun 19, 2019

This table list Fires API fields and the units in which they are measured or calculated according to the Metric and the Imperial systems.

TIP

Note:

By default, requests return Metric measurement. Requests can be customized by setting the request’s units parameter.

Fields Metric Imperial
position.distance km mi
position.direction Degrees (°) Degrees (°)
size m2 (Square Meters) ac (Acres)

Integrate BreezoMeter's data in your products today

Get API Key
Talk to an expert