# Wildfire Tracker+ API v1
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
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
# 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. | 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
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=48.857456&lon=2.354611&radius=20 # Response Data Fields
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):
For the list of the data fields returned with each feature, see Features List
# Features List
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. |
| geometry | 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 the last 72 hours |
| 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 |
|---|---|---|
| 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
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 |
# Unit Systems
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) |
# Burnt Area API
The Burnt Area API allows you to get all burnt areas surrounding a given location within a certain radius.
# Request Parameters
An API request returns the burnt areas for a specific location, in accordance with a lookback window. With the lookback window, you can choose the amount of time past the fire extinguished time, either in days or hours.
https://api.breezometer.com/fires/v1/burnt-area?key=YOUR_API_KEY&lat={latitude}&lon={longitude}&radius={radius}&daysFromExtinguish={days} 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 | Required |
| daysFromExtinguish | integer | Desired time from extinguished in Days
Notes:
| Optional |
| hoursFromExtinguish | integer | Desired time from extinguished in Hours
Notes:
| Optional |
| 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:
| Optional |
# Example
This example shows a use case of tracking burnt areas of an active wildfire. In order to have no burnt areas visible on the map, after the wildfire is flagged as ‘Extinguished’, set up the daysFromExtinguish = 0. In practice, both active fire perimeters and their burnt areas are removed together, when the fire is out.
https://api.breezometer.com/fires/v1/burnt-area?key=YOUR_API_KEY&lat=14&lon=-10.7&radius=20&daysFromExtinguish=0 # Response Data Fields
Burnt Area API provides a list of fields for each burnt area, based on the following statement: "Get all the burnt areas around your chosen point".
You will need to submit a single API request and supply the point’s input to receive the following response fields.
Below you can find the default fields.
For the list of the data fields returned with each feature, see Features List
# Response Example 1
# Burnt Area API as an additional service to the Locate & Track API
This example shows a use case of tracking burnt areas of an active wildfire, and demonstrates the polygons of both active fire and its related burnt areas.
# Request
https://api.breezometer.com/fires/v1/burnt-area?key=YOUR_API_KEY&lat=33.222074&lon=-107.956063&radius=50&daysFromExtinguish=3&features=EventDescription # Response
"metadata" : null , "type" : "FeatureCollection" , "id" : "0" , "type" : "Feature" , "BurntAcres" : 206933.96022359707 , "BurntLat" : 33.2019910460457 , "BurntLon" : -107.87501884588494 , "DiscoveryDateTime" : "2022-05-14T04:53:00Z" , "EventDescription" : "Fire is located 53 Km North of SANTA RITA" , "ExtinguishedTS" : null , "InitialLat" : 33.20543686047492 , "InitialLon" : -108.05470798428146 } , "type" : "MultiPolygon" , -107.780200871847 , 33.3018732126964 ] , -107.780806678628 , 33.3008042235735 ] , -108.037939738318 , 33.1762811893365 ] , -107.831855714805 , 32.9808378895128 ] , -107.831829088293 , 32.9808639727681 ] ] ] ] } } ] } , "error" : null }# *Visualization
This visualization allows you to see both polygons side-by-side, when the burnt area api is used with the locate and track api.
TIP
Note:
Both APIs do not provide any visualizations.
The example shown below demonstrate a common usage of both products.
The image above used the following request-response from the Locate & Track API. For visualizing purposes, it is highly recommended to use a different color for each type of polygon
Request (Locate & Track)
https://api.breezometer.com/fires/v1/locate-and-track?key=YOUR_API_KEY&lat=33.222074&lon=-107.956063&radius=50&features=EventDescription Response (Locate & Track)
"metadata" : null , "type" : "FeatureCollection" , "id" : "0" , "type" : "Feature" , "CurrentLat" : 32.99140538860025 , "CurrentLon" : -107.90087781802667 , "DiscoveryDateTime" : "2022-05-14T04:53:00Z" , "EventDescription" : "Fire is located 53 Km North of SANTA RITA" , "LastUpdated" : "2022-06-12T09:20:00Z" } , "type" : "MultiPolygon" , -107.773619981498 , 33.0310060908309 ] , -107.773619981498 , 33.0310060908309 ] ] ] , -107.83368816933 , 32.9808262742739 ] , -107.834209880104 , 32.9719669321816 ] , -107.83368816933 , 32.9808262742739 ] ] ] ] } } ] } , "error" : null }# Response Example 2
# Burnt Area API as a stand alone package
This example shows a use case of 2 wildfires for a given location with a desired radius=100 [km].
The request for daysFromExtinguish=30, allows clients to get all the burnt areas of wildfires that have been extinguished during a lookback window of the last 30 days.
# Request
https://api.breezometer.com/fires/v1/burnt-area?key=YOUR_API_KEY&lat=14&lon=-10.7&radius=100&daysFromExtinguish=30&features=EventDescription # Response
"metadata" : null , "type" : "FeatureCollection" , "id" : "0" , "type" : "Feature" , "BurntAcres" : 827.3626086412154 , "BurntLat" : 14.019523458124308 , "BurntLon" : -10.677628815171923 , "DiscoveryDateTime" : "2022-05-23T13:23:00Z" , "EventDescription" : "Fire is located 98 Km South East of KAYES" , "ExtinguishedTS" : "2022-05-26T12:00:00Z" , "InitialLat" : 14.018030649117826 , "InitialLon" : -10.677915354380056 } , "type" : "Polygon" , -10.6717898751093 , 14.0213666283727 ] , -10.6726988045653 , 14.008022485597 ] , -10.6717898751093 , 14.0213666283727 ] ] ] } } , "id" : "1" , "type" : "Feature" , "BurntAcres" : 1367.9666878120436 , "BurntLat" : 13.275174062822572 , "BurntLon" : -10.511013733889868 , "DiscoveryDateTime" : "2022-05-23T02:13:00Z" , "EventDescription" : "Fire is located 169 Km South East of KAYES" , "ExtinguishedTS" : "2022-05-26T12:00:00Z" , "InitialLat" : 13.276054782540887 , "InitialLon" : -10.512608500283276 } , "type" : "Polygon" , -10.5220731477689 , 13.2658527505221 ] , -10.5099127096799 , 13.2656457514425 ] , -10.4994218293326 , 13.2823005486811 ] , -10.5220731477689 , 13.2658527505221 ] ] ] } } ] } , "error" : null }# Features List
You will get a list of all the burnt areas within the specified radius of the designated location, and receive in-depth information about each burnt area boundaries, distance, fire name, start date and size.
Here are the various supported features:
# Burnt Area Fields
| Field Name | Type | Description |
|---|---|---|
| ShapeBurnt | GEOGRAPHY | The burnt area geometry represents accumulated areas, that got no indication of fire burning in the last 72 hours. |
| BurntLat | FLOAT | Last burnt area location average of latitudes (center of ShapeBurnt's mass). |
| BurntLon | FLOAT | Last burnt area location average of longitudes (center of ShapeBurnt's mass). |
| BurntAcres | FLOAT | The total size of the burnt areas [acres]. Accumulations are based on the ShapeBurnt |
| BurntTS | TIMESTAMP | Last timestamp the burnt area was updated |
| LastSatelliteTime | DATETIME | Latest pixel acquisition time by the satellite |
| ExtinguishedTS | DATETIME | The fire extinguished timestamp indicates when (at least) 72 hours have passed since the fire was burning. |
# Date & Time
| Field Name | Type | Description |
|---|---|---|
| DiscoveryDateTime | DATETIME | The DateTime of the earliest hotspot detected for this event |
# Location
| Field Name | Type | Description |
|---|---|---|
| InitialLat | FLOAT | Initial location of the wildfire, average of latitudes (center of mass). |
| InitialLon | FLOAT | Initial location of the wildfire, 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. For Australia only |
| City | STRING | The closest city to the incident point of origin. |
# Event Info
| Field Name | Type | Description |
|---|---|---|
| EventId | STRING | see wildfire tracker |
| EventName | STRING | Name of the closest city to the wildfire's initial central location |
| EventDescription | STRING | Direction and distance to the closest city to the wildfire's initial central location |
# Source Data Enrichment
| Field Name | Type | Description |
|---|---|---|
| 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 | DATETIME | Date/time that the Agency Incident record was last modified. |
| SourceDiscoveryDateTime | DATETIME | The date and time a wildfire was reported as discovered or confirmed to exist. May also be the start date for reporting purposes. |
| SourceDetailURL | STRING | 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’. |
| SourcePrescribed | BOOLEAN | When wildfires are reported as ‘prescribed’ by local sources (if local sources provide this information) |
| SourceCreatedOnDateTime | DATETIME | Date/time that the Local source Incident record was created. |
| SourceInitialLatitude | FLOAT | Initial latitude value for the wildfire given by local source |
| SourceInitialLongitude | FLOAT | Initial Longitude value for the wildfire given by local source |
TIP
Note:
The Burnt Area API can be used as a stand alone service: “Sources & Burnt Area” or as an additional service to the “Current Conditions” of the Locate & Track API.
Get API Key