GET /storms

BETA. Beta resources may undergo minor revisions and may not have the benefit of complete documentation.

Description

Returns a list of storm metadata.

Requires a subscription plan with the “access_regions” capabilities to access this resource.

This resource is not available to free 30-day developer plans. However, postal code history is available. Please email sales@weathersource.com or call (844) 813-2617 if you need access to this resource.

Resource URL

https://api.weathersource.com/v1/{{api_key}}/storms.{{format}}

Resource URL Replacement Parts

{{api_key}}

Your API Key. If you do not have an API key, you may sign up for a free developer account 30-day trial.

{{format}}

The desired response format. Allowed formats are:

  • json

Parameters

timestamp_eq optional

A response condition that filters the list of storm metadata to storms that were occurring at the time of the provided.

Either timestamp_eq or timestamp_between must be provided in ISO 8601 format.

All timestamps are assumed to be UTC unless a UTC offset is provided (as part of the ISO 8601 format).

Allowed Values: ISO 8601 timestamp

Example Value: 2018-05-02T00:00:00+00:00

timestamp_between optional

A response condition that filters the list of storm metadata to storms that were occurring (in whole or in part) during the range of time of the provided.

Either timestamp_eq or timestamp_between must be provided in ISO 8601 format.

The total date range must not exceed 1 year in length. If a longer date range is required, multiple requests must be made.

All timestamps are assumed to be UTC unless a UTC offset is provided (as part of the ISO 8601 format).

Allowed Values: Two comma separated ISO 8601 timestamps

Example Value: 2018-05-01T00:00:00+00:00,2018-05-05T00:00:00+00:00

Resource Information

API Versions v1
Rate Limited? Yes
Requires Authentication? Yes
Response Formats JSON
JSONP
HTTP Method GET

Related Documentation

Example Request

GET https://api.weathersource.com/v1/{{api_key}}/storms.json?timestamp_eq=2018-05-02T00:00:00+00:00

[{"stormId":"SH212018","timestampFirst":"2018-04-29T18:00:00+00:00","timestampLast":"2018-05-02T06:00:00+00:00","lastModified":"2018-05-04T20:15:21+00:00"},{"stormId":"WP962018","timestampFirst":"2018-05-01T18:00:00+00:00","timestampLast":"2018-05-03T18:00:00+00:00","lastModified":"2018-05-04T20:15:32+00:00"}]