Endpoint: convective/outlook

The convective/outlook endpoint provides convective outlook information based on the SPC convective outlooks.  Coverage of this endpoint is for the US only.

https://api.aerisapi.com/convective/outlook

Data CoverageContinental US

Included With API Developer,  API Premium

Supported Actions

The following actions are supported with the convective/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.

Supported Parameters

The following parameters are options 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.

Examples:
from=tomorrow
from=friday
from=1302883980
from=7/10/2011
from=2011/07/10
from=+2hours
from=2017-02-27 5:00 PM
limit limit=:total 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.

Examples:
to=+6hours
to=+5days
to=1302883980
to=7/10/2011
to=2011/07/10
to=2017-02-27 5:00 PM
fields fields=:string Provides a comma separated list of values for the API to return. This parameter is often used to limit the amount of data returned. See Reducing Output.
format format=:string Defines the API output format. The available options include:
format=json - Standard JSON output. This is the default.
format=geojson - API will output GeoJSON


Supported Filters

The following filters can be passed to the filter parameter to reduce the results that are returned:

cat Return outlooks for the SPC categorical convective outlook. Available for Days 1-3
prob Return the outlooks for the SPC probability outlook. Available for Days 4-8
conhazo Return outlooks for both categorical and probability outlooks. Most commonly used filter as provides access to days 1-8. The default filter is none provided.
torn Return SPC tornado outlook. Available for Day 1
xtorn, sigtorn Return SPC significant tornado outlook. Available for Day 1
alltorn Returns both the SPC tornado and significant tornado outlook.
hail Return SPC hail outlook. Available for Day 1
xhail, sighail Return SPC significant hail outlook. Available for Day 1
allhail Returns both the SPC hail and significant hail outlook.
wind Return SPC wind outlook. Available for Day 1
xwind, sigwind Return SPC significant wind outlook. Available for Day 1
allwind Returns both the SPC wind and significant wind outlook.
all Returns all SPC convective outlooks
general Limit results to the general thunderstorms categorical outlook
marginal Limit results to the marginal categorical outlook
slight Limit results to the slight categorical outlook
enhanced Limit results to the enhanced categorical outlook
moderate, mod Limit results to the moderate categorical outlook
high Limit results to the high categorical outlook
day1 Limit results to day 1 outlooks
day2 Limit results to day 2 outlooks
day3 Limit results to day 3 outlooks
day4 Limit results to day 4 outlooks
day5 Limit results to day 5 outlooks
day6 Limit results to day 6 outlooks
day7 Limit results to day 7 outlooks
day8 Limit results to day 8 outlooks

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.

Examples:
cat
prob
torn
sigtorn
hail
sighail
wind
sigwind
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

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

Return the convective categorical outlooks for today. Since no from parameter provided, defaults to today.
/convective/outlook/search?filter=conhazo

Return the convective categorical outlooks for today.
/convective/outlook/search?filter=conhazo&from=today

Return the convective categorical outlooks for tomorrow.
/convective/outlook/search?filter=conhazo&from=+1day

Return the convective categorical outlooks for today and include the polygons for the outlooks.
/convective/outlook/search?filter=conhazo,geo

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

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

Return the convective categorical outlooks for today that Atlanta, GA is contained in.

This query is equivalent to /convective/outlook/contains?p=atlanta,ga

Note: The endpoint uses a default filter of "conhazo" and from=today, since they were not included.
/convective/outlook/atlanta,ga

Return the convective categorical outlooks for today that Atlanta, GA is contained in.
/convective/outlook/contains?p=atlanta,ga&filter=conhazo

Return the convective categorical outlooks for today that contain the specified latitude/longitude
/convective/outlook/contains?p=44.96,-93.27&filter=conhazo

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

Return the convective 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.
/convective/outlook/atlanta,ga?filter=conhazo&from=today&to=+7days&sort=day&fields=details.range,details.risk.type

Return the outlook with id of "ec31f2f9654addad2e4f773522f7b2c3"
/convective/outlook/ec31f2f9654addad2e4f773522f7b2c3

Return the outlook with id of "ec31f2f9654addad2e4f773522f7b2c3" and include the polygon(s) data for the outlook
/convective/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"
/convective/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.

Default
GeoJSON

{
   "id":"ec31f2f9654addad2e4f773522f7b2c3",
   "details":{
      "product":"convective",
      "category":"cat",
      "day":1,
      "range":{
         "minTimestamp":1429979400,
         "maxTimestamp":1430049600,
         "minDateTimeISO":"2015-04-25T12:30:00-04:00",
         "maxDateTimeISO":"2015-04-26T08:00:00-04:00"
      },
      "issuedTimestamp":1429979400,
      "issuedDateTimeISO":"2015-04-25T12:30:00-04:00",
      "risk":{
         "type":"slight",
         "name":"slight risk",
         "code":4
      }
   },
   "geoPoly":null
}
								

{
   "type":"FeatureCollection",
   "features":[
      {
         "type":"Feature",
         "id":"2d0f535a3862ed95977353b087136da5",
         "geometry":{
            "type":"MultiPolygon",
            "coordinates":[
               [
                  [
                     [
                        -107.24025539099,
                        45.998191053111
                     ],
                     [
                        -107.16765039547,
                        46.120771720032
                     ],
                     [
                        -107.10892536043,
                        46.103896062314
                     ],
                     [
                        -107.03594370839,
                        46.226371879847
                     ],
                     [
                        -97.083678902016,
                        48.95580784391
                     ],
                     [
                        -97.142020436214,
                        48.976899784128
                     ]
                  ]
               ]
            ]
         }
      }
   ]
}
								

Response Properties

The following properties will be provided in every response object:

id (string) The outlook ID
details (object) Object of the outlook details
details.product (string) The product type. Should normally be "convective"
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) Unix timestamp of the start of the coverage period for the outlook
details.range.minDateTimeISO (string) ISO 8601 date of the start of the coverage period for the outlook
details.range.maxTimestamp (number) Unix timestamp of the end of the coverage period for the outlook
details.range.maxDateTimeISO (string) ISO 8601 date of the end of the coverage period for the outlook
details.issuedTimestamp (number) Unix timestamp of the issue date/time for the outlook
details.issuedDateTimeISO (string) ISO 8601 date of the issue date/time for the outlook
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
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.