Supported Actions

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

:id

Requesting data by using the :id action is used for returning data for a particular item that has an ID associated with it. This is the primary method for requesting general weather information for a single location (observations, forecasts, advisories, etc.) as the location's name or a zip code serves as the id. Other endpoints may expect a certain value for the ID, such as storm cells whose ID value is a combination of the radar site identifier and unique identifier assigned to every storm cell. Refer to an enpoint's detailed documentation for specific information regarding how to use the :id action.

affects

The affects action requests all places affected by a particular type of event, such as earthquake or storm cell. The query for places affected is unique for each endpoint it belongs to and can be a polygon (e.g., storm cell forecasts or warnings) or a circle with the center being the location of the event (e.g., earthquakes or fires). Instead of returning an array of objects specific to the endpoint, the affects action will always return an array of place objects in the same format as the within action on the places endpoint.

Note: Not all endpoints support this action, so refer to each endpoint's complete documentation to determine if supported and its usage.

contains

The contains action returns data that a specified location is contained within. This action is normally associated with endpoints that contain polygon data, allowing to return only the polygons a point / geometry is contained in. This action can be considered the opposite of the within endpoint.

search

The search action is used as a more general query method and expects the query to be defined with the custom query for the request. Unlike the closest action, results will not be returned in any particular order.

within

The within action allows for returning data within a variety of different geometrical regions. Currently supported geometries include a circle (requires a center point and radius), square (requires two coordinate points defining the top-left and bottom-right corners) and polygon (requires at least three coordinate points). Unlike the closest action, the results will not be returned in any particular order based on distance.

Supported Parameters

The following parameters are optional unless otherwise noted:

callback

callback=:functionName

Used with JSONP implementation.

Defines the callback function to use for the response. The response will be enclosed as C(response), where C is the callback function provided.

filter

filter=:string

Predefined filters for limiting the results. The filter value can be a single, comma-delimited or a semicolon delimited string of filter names.

from

from=:string

Returns the results starting form the value specified.

Supports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted.

The total number of results to return as an integer. Each endpoint may have a set maximum for this value depending on usage.

The default limit is 1 if not specified.

p

p=:place

Defines the location to query data for. Refer to the list of supported place value formats.

query

query=:string

Used to filter results based on certain fields in the data set. See Advanced Queries for more details.

radius

radius=:distance:unit

When requesting the closest results within a circle, the radius determines how far from the specified location to search. A valid unit value must be included in your radius value, e.g., "5mi", "10km", "25miles". If no unit is provided, your value is assumed to be in meters by default.

Most endpoints utilize a default radius of 50 miles, though some endpoints, such as lightning, may have tighter restrictions specified.

skip

skip=:number

Used to skip over a specific number of results in the data set.

sort

sort=:string

Used to sort results based on certain fields in the data set. See Sorting for more details.

to

to=:string

Returns the results between now and the value specified. When used in conjunction with the from parameter, the value of to will be relative to the value of from, not relative to the current time.

Supports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted.

Supported Query Properties

Use the following supported property keys when creating custom queries for your requests:

id

Query by the outlook ID

cat

Query by outlook category.

day

Valid day of the outlook. Value from 1 - 8

type

The risk type

name

The risk type name from SPC

code

Numeric code for the risk type:

elevated = 2
critical = 4
extreme = 6

isodryt = 20
sctdryt = 22

Sortable Fields

You can use the following fields to sort the data returned in your response:

id

Sort by the outlook ID

cat

Sort by the outlook category

day

Sort by the valid day of the outlook.

type

Sort by the risk type

name

Sort by the risk type name form SPC

code

Sort by the coded risk type

bdt

Sort by the start / beginning of the outlooks valid coverage date / time

edt

Sort by the end of the outlooks valid coverage date / time

idt

Sort by the issue date / time of the outlook

Examples

The /[:endpoint]/[:action]? portion within the query template below can be exchanged with any of the examples. Also, please note you will need to input your client credentials in the [ID] and [SECRET] fields which can be found under the Apps section of the members area.

Return fire weather categorical outlooks for today and include the polygons for the outlooks./fires/outlook/search?filter=firewx,geo&

Return the fire weather categorical outlooks for today, sorted by the least significant to the highest./fires/outlook/search?filter=firewx&sort=code&from=today&

Return the fire weather categorical outlooks for today, sorted by the highest significant to the lowest./fires/outlook/search?filter=firewx&sort=code:-1&from=today&

Return the fire weather categorical outlooks for today that Atlanta, GA is contained in.
This query is equivalent to /fires/outlook/contains?p=atlanta,ga
Note: The endpoint uses a default filter of "firewx" and from=today, since they were not included./fires/outlook/atlanta,ga?

Return the fire weather categorical outlooks for today that contain the specified latitude/longitude/fires/outlook/contains?p=44.96,-93.27&filter=firewx&

Return the fire weather categorical outlooks for days 1 - 8 that Atlanta, GA is contained within. The results will be sorted by the coverage day/fires/outlook/atlanta,ga?filter=firewx&from=today&to=+7days&sort=day&

Return the fire weather categorical outlooks for days 1 - 8 that Atlanta, GA is contained within. The results will be sorted by the coverage day. The fields parameter will limit the data to the elements needed. This greatly reduces bandwidth and resources./fires/outlook/atlanta,ga?filter=firewx&from=today&to=+7days&sort=day&fields=details.range,details.risk.type&

Return the outlook with id of "ec31f2f9654addad2e4f773522f7b2c3"/fires/outlook/ec31f2f9654addad2e4f773522f7b2c3?

Return the outlook with id of "ec31f2f9654addad2e4f773522f7b2c3" and include the polygon(s) data for the outlook/fires/outlook/ec31f2f9654addad2e4f773522f7b2c3?filter=geo&

Return the top 10 locations with at least a population of 50,000 that are within the outlook with id "ec31f2f9654addad2e4f773522f7b2c3"/fires/outlook/affects?p=ec31f2f9654addad2e4f773522f7b2c3&pop=50000&limit=10&

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.