Endpoint: stormreports/summary

The stormreports/summary endpoint provides an overall summary of received storm reports based on search / filter criteria.  Example uses include obtaining the number of storm reports received within a time frame and/or geographical area, maximum rainfall or snowfall reported, the number of tornado storm reports within a 50 mile radius. Coverage area includes the 50 US states.

Supported Actions

The following actions are supported with the stormreports/summary 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.
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.
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.
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. For best practices we recommend using the to parameter as well to define a specific time frame.

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
p p=:place Defines the location to query data for. Refer to the list of supported place value formats.
to to=:string Returns the results between now and the value specified. For best practices we recommend using the from parameter as well to define a specific time frame. 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
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.
query query=:string Used to filter results based on certain fields in the data set. See Advanced Queries for more details.

Supported Filters

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

avalanche Returns summary for avalanche-related storm reports.
blizzard Returns summary for blizzard-related storm reports.
dust Return summary for dust related storm reports.
flood Returns summary for flood-related storm reports.
fog Returns summary for fog-related storm reports.
ice Returns summary for ice-related storm reports.
hail Returns summary for hail-related storm reports.
lightning Returns summary for lightning-related storm reports.
marine Returns summary for marine related storm reports.
rain Returns summary for rain-related storm reports.
snow Returns summary for snow-related storm reports.
tides Returns summary for tide-related storm reports.
tornado Returns summary for tornado and waterspout-related storm reports.
tropical Returns summary for tropical storm / hurricane related storm reports
wind Returns summary for wind-related storm reports.

Supported Query Properties

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

code Query storm reports based on the coded type.

Example:
/stormreports/summary/search?query=code:S (returns summary on storm reports that are of the code "S", which is snow)
type Query storm reports based on the named type.

Example:
/stormreports/summary/search?query=type:snow (returns summary on storm reports that are of the type snow)
state Query storm reports within a state. The state should be lower case and a two letter abbreviation.

Example:
/stormreports/summary/search?query=state:mn (returns summary on storm reports that the state matches Minnesota, "mn")
name Query storm reports based on the closest location.
wfo Query storm reports within a WFO. The WFO should be lower case and three characters.

Example:
/stormreports/summary/search?query=wfo:mpx (returns summary on storm reports that the wfo matches mpx)
detail Query storm reports based on the reported magnitude. i.e. rain/snow amount, wind speed

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.

https://api.aerisapi.com/[:endpoint]/[:action]?client_id=[ID]&client_secret=[SECRET]

Return summary for all storm reports received today
/stormreports/summary?

Return a summary for only storm reports today within the state of Georgia.
/stormreports/summary/search?query=state:ga&

Return a summary for storm reports that are within the states of Georgia or Alabama.
Note the semicolon is used to represent a logical 'OR'.
/stormreports/summary/search?query=state:ga;state:al&

Return a summary for storm reports within a 50 mile radius of Minneapolis, MN today.
/stormreports/summary/minneapolis,mn?

Return a summary for all storm reports received over the past week.
/stormreports/summary?from=-1week&to=now&

Return a summary for all tornado, funnel cloud and waterspout related storm reports
/stormreports/summary?filter=tornado&

Return a summary for all tornado, funnel cloud and waterspout related storm reports over the past week
/stormreports/summary?filter=tornado&from=-1week&to=now&

Return a summary for all tornado, funnel cloud and waterspout related storm reports on Aug 17, 2016 (UTC)
/stormreports/summary?filter=tornado&from=2016-08-17&to=+1day&

Return a summary of rain and snow related storm reports today.
Note the semicolon is used to represent a logical 'OR'.
/stormreports/summary?filter=rain;snow&

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.


{
    "success": true,
    "error": null,
    "response": [{
        "summary": {
            "range": {
                "count": 2,
                "fromTimestamp": 709171200,
                "fromDateTimeISO": "1992-06-22T00:00:00+00:00",
                "toTimestamp": 709171200,
                "toDateTimeISO": "1992-06-22T00:00:00+00:00",
                "maxTimestamp": 709171200,
                "maxDateTimeISO": "1992-06-22T00:00:00+00:00",
                "minTimestamp": 709171200,
                "minDateTimeISO": "1992-06-22T00:00:00+00:00"
            },
            "states": ["co", "tx"],
            "typeCats": ["tornado"],
            "types": [{
                "type": "tornado",
                "code": "T",
                "range": {
                    "count": 2,
                    "maxTimestamp": 709171200,
                    "maxDateTimeISO": "1992-06-22T00:00:00+00:00",
                    "minTimestamp": 709171200,
                    "minDateTimeISO": "1992-06-22T00:00:00+00:00"
                },
                "detail": {
                    "count": 2
                },
                "states": ["co", "tx"],
                "cat": "tornado"
            }]
        }
    }]
}
								

Response Properties

The following properties will be provided in every response object:

summary (object) Summary object
summary.range (object) Object with count and date range of the summary
summary.range.count (number) The total number of storm reports within the summary
summary.range.fromTimestamp (number) The unix timestamp of the from parameter.
summary.range.fromDateTimeISO (string) The ISO8601 date of the from parameter.
summary.range.toTimestamp (number) The unix timestamp of the to parameter.
summary.range.toDateTimeISO (string) The ISO8601 date of the from parameter.
summary.range.maxTimestamp (number) UNIX timestamp of the date/time of the last storm report within the summary.
summary.range.maxDateTimeISO (string) ISO 8601 date of the date/time of the last storm report within the summary
summary.range.minTimestamp (number) UNIX timestamp of the date/time of the first storm report within the summary.
summary.range.minDateTimeISO (string) ISO 8601 date of the date/time of the first storm report within the summary
summary.states (array) Array of two letter state abbreviations that had storm reports used within the summary
summary.typeCats (array) Array of categories of the storm reports used within the summary.
summary.types (array) Array of objects providing a summary of each storm report type
summary.types[#].type (string) The storm report type
summary.types[#].code (string) The storm report code
summary.types[#].range (object) Object with the count and date range of the summary for the specific storm report type
summary.types[#].count (number) The total number of storm reports of this type
summary.types[#].maxTimestamp (number) UNIX timestamp of the date/time of the last storm report of the type within the summary
summary.types[#].maxDateTimeISO (string) ISO 8601 date of the date/time of the last storm report of the type within the summary
summary.types[#].minTimestamp (number) UNIX timestamp of the date/time of the first storm report of the type within the summary
summary.types[#].minDateTimeISO (string) ISO 8601 date of the date/time of the first storm report of the type within the summary
summary.types[#].detail (object) Object of summary of storm report details
summary.types[#].detail.count (number) Number of storm reports of the type that included detail information
summary.types[#].detail.maxMPH (number) Summary of the maximum wind speed in miles per hour. Included only for wind related storm report types.
summary.types[#].detail.maxKPH (number) Summary of the maximum wind speed in kilometers per hour. Included only for wind related storm report types.
summary.types[#].detail.maxKTS (number) Summary of the maximum wind speed in knots. Included only for wind related storm report types.
summary.types[#].detail.minMPH (number) Summary of the minimum wind speed in miles per hour. Included only for wind related storm report types.
summary.types[#].detail.minKPH (number) Summary of the minimum wind speed in kilometers per hour. Included only for wind related storm report types.
summary.types[#].detail.minKTS (number) Summary of the minimum wind speed in knots. Included only for wind related storm report types.
summary.types[#].detail.avgMPH (number) Summary of the average wind speed in miles per hour. Included only for wind related storm report types.
summary.types[#].detail.avgKPH (number) Summary of the average wind speed in kilometers per hour. Included only for wind related storm report types.
summary.types[#].detail.avgKTS (number) Summary of the average wind speed in knots. Included only for wind related storm report types.