# Wildfire Tracker API v1
Last updated: Mar 29, 2022
The wildfire tracker API provides ongoing wildfire updates for the areas of interest you define.
We offer 2 main products:
- Locate & Track API
- Wildfire Area API - coming soon
# Locate & Track API
Last updated: Mar 29, 2022
You can pull updates on-demand without being limited to certain areas. As the fires move, so does the perimeter track, ensuring a timely and updated solution you can trust.
# Current Conditions
Last updated: Mar 29, 2022
# Request Parameters
Returns current active wildfire current conditions for a specific location
https://api.breezometer.com/fires/v1/locate-and-track?key=YOUR_API_KEY&lat={latitude}&lon={longitude}&radius={radius} While making an API request some parameters are required while some are optional.
| Parameter | Type | Description | R/O |
|---|---|---|---|
| lat | float | Latitude (lat) specifies the north-south position of a point in a range between -90 and 90 | Required |
| lon | float | Longitude (lon) specifies the east-west position of a point in a range between -180 to 180 | Required |
| radius | integer | Desired radius from the location provided (lat,lon) Radius range: Min Value: 5 KM / 3 Mile Max Value: 100 KM / 62 Mile Note:
| Required |
| key | String | Your BreezoMeter API key location | Required |
| units | string | Sets the response measurement system to either:
| optional |
| features | string | Sets the data fields returned by the response. Possible values: See Features List below Note: You must separate every two features with a comma, and use the exact naming convention as shown in the possible values. Example: fire_size, %containment, discovery_date | optional |
# Examples
Last updated: Mar 29, 2022
A request to get the status of all the current wildfires within a designated radius (20 km) of the specified location (48.857456, 2.354611) using the default request parameters settings.
https://api.breezometer.com/fires/v1/locate-and-track?key=YOUR_API_KEY&lat={latitude}&lon={longitude}&radius={radius} # Response Data Fields
Last updated: Mar 29, 2022
Locate & Track API provides a list of response fields for each wildfire, based on the following statement: "Get all the fires around your chosen objects".
You will need to submit a single API request and supply the object's input to receive the following response fields (included by default with all packages):
DiscoveryDateTime
Default
The DateTime of the earliest hotspot detected for this event
LastUpdated
Default
The last time the wildfire data was updated.
CurrentLat
Default
The current latitude (lat) of the wildfire
CurrentLon
Default
The current longitude (lon) of the wildfire
Geometry
Default
The fire perimeter consists of all the coordinates of the fire polygon.
For example:
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-17.9119606274645,
28.6068773236325
],
[
-17.9099705306238,
28.6080715099283
],
[
-17.9045284977173,
28.6106982885562
],
[
-17.8953817270035,
28.6142966182073
],
[
-17.8893890246955,
28.6161486793994
]
]]}
For example:
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-17.9119606274645,
28.6068773236325
],
[
-17.9099705306238,
28.6080715099283
],
[
-17.9045284977173,
28.6106982885562
],
[
-17.8953817270035,
28.6142966182073
],
[
-17.8893890246955,
28.6161486793994
]
]]}
For the list of the data fields returned with each feature, see Features List
# Features List
Last updated: Mar 29, 2022
You will get a list of all the wildfires within the specified radius of the designated location, and receive in-depth information about each wildfire’s boundaries, distance, fire name, start date and size.
Here are the various supported features:
# Confidence & Polygon
| Field Name | Type | Description |
|---|---|---|
| ShapeConfidence | Integer | Confidence value (1-5) representing how accurate is the shape of the wildfire perimeter. Scale: 1- worst, 5- best. |
| Shape | Polygon / Multipolygon (Lat / Long coordinates) | Geographic representation of the wildfire extent (boundary) in WGS84 coordinates. The latitude points for the polygons are to be specified in decimal degrees. The longitude points for the polygons are to be specified in decimal degrees. |
| CalculatedAcres | Float | Calculated area of our polygon in acres. |
| MaxCalculatedAcres | Float | Maximal wildfire size throughout all of the wildfires duration |
| ExistenceConfidence | Integer | GValue (1-5) represents how confident are we this wildfire is real |
# Location
| Field Name | Type | Description |
|---|---|---|
| InitialLat | Float | Initial location average of latitudes (center of mass). |
| InitialLon | Float | Initial location average of longitudes (center of mass) |
| CurrentLat | Float | Current location average of latitudes (center of mass) |
| CurrentLon | Float | Current location average of longitudes (center of mass) |
| Country | ISO 3 letters (String) | The country containing the POO. |
| State | ISO (String) | The State alpha code identifies the state or equivalent entity at the point of origin. * Available only in Australia |
| City | String | The closest city to the incident point of origin. |
# Date & Time
| Field Name | Type | Description |
|---|---|---|
| CreatedBySystem | ISO datetime | The timestamp the wildfire was first created by BRZ system |
| CreatedOnDateTime | ISO datetime | The timestamp of the wildfire first crossed the 1000 acres. |
| LastUpdated | ISO datetime | The last time the wildfire data was updated |
| DiscoveryDateTime | ISO datetime | The DateTime of the earliest hotspot detected for this event |
# Source Data Enrichment
| Field Name | Type | Description |
|---|---|---|
| SourceCurrentLatitude | Float | The current point location latitude indicated by the source |
| SourceCurrentLongitude | Float | The current point location longitude indicated by the source |
| SourceDetailURL | String (link) | Link to a specific page for the wildfire. Could be a link from the same source as ‘SourceName’ or a different one |
| SourceDetailURLName | String | The name of the local source providing the ‘SourceDetailURL’ link. Same terminology as ‘SourceName’. |
| ComplexName | String | The name of the complex where this wildfire is located |
| SourceId | String | A consistent identifier for the source agency. E.g “IRW_USA” |
| SourceName | String | The organization providing authoritative wildfire information E.g ‘IRWIN’ |
| SourceURL | String | General web address for wildfireAgencyName (the wildfire authority for a unique event) |
| SourceEventId | String | Unique identifier assigned to each wildland wildfire by the local source |
| SourceEventName | String | The name assigned to an incident By the local source |
| SourceEventDescription | String | General description of the incident given by the local source |
| SourceLastUpdated | ISO datetime | Date/time that the Agency Incident record was last modified. |
| SourceDiscoveryDateTime | ISO datetime | The date and time a wildfire was reported as discovered or confirmed to exist. May also be the start date for reporting purposes. |
| SourceCreatedOnDateTime | ISO datetime | Date/time that the Local source Incident record was created. |
| SourcePercentContained | Float | The wildfire containment %, provided by the local source |
| SourceContainmentForecast | ISO datetime | Expected containment date |
| SourceInitialLatitude | Float | Initial latitude value for the wildfire given by local source |
| SourceInitialLongitude | Float | Initial Longitude value for the wildfire given by local source |
| SourcePrescribed | Bool | When wildfires are reported as ‘prescribed’ by local sources (if local sources provide this information) |
# Metadata
Last updated: Mar 29, 2022
Metadata objects can include these fields.
| Field Name | Type | Description |
|---|---|---|
| EventId | string format:yyyy-VLLLLLLL-HLLLLLLLL-xxxxxxxx | Unique identifier for each wildfire event |
| ts | ISO datetime | UTC time for the hour in which all of this data was generated |
| EventName | String | Name of the closest city to the polygons' initial central location |
| EventDescription | String | Direction and distance to the closest city to the polygon's initial central location |
| cloud_ratio | Float | ratio of cloud cover |
# Unit Systems
Last updated: Mar 29, 2022
This table lists Locate & Track 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 |
|---|---|---|
| radius | km | mi |
| CalculatedAcres | m2 (Square Meters) | ac (Acres) |