GET /storms/{{storm_id}}/hazards/{{datatype}}

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

Description

Returns a storm-specific spatial file of hazard data for the specified datatype. The json format will return metadata for the associated spatial files.

Requires a subscription plan with the “read_hazards” and “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/{{storm_id}}/hazards/{{datatype}}.{{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.

{{storm_id}}

An ATCF storm id. The expected format is the concatenation of a 2-character basin, 2-digit storm number, and 4-digit year (i.e. "SH212018"). Available storm ids can be queried via the storms resource

{{datatype}}

Available data types are:

  • hurricanes
{{format}}

The desired response format. Allowed formats are:

  • geojson.zip
  • shp.zip
  • json

NOTE: the json format returns metadata for the target contour files, not the files themselves.

Parameters

timestamp_eq optional

REQUIRED if {{format}} is geojson.zip or shp.zip.

OPTIONAL if {{format}} is json{{format}} is json. Either timestamp_eq or timestamp_between may be provided, but not both. If neither is provided, all storm data will be returned.

Timestamps must be in ISO 8601 format.

Allowed Values: ISO 8601 timestamp

Example Value: 2007-02-12T08:00-07:00

timestamp_between optional

NOT ALLOWED if {{format}} is geojson.zip or shp.zip.

OPTIONAL if {{format}} is json{{format}} is json. Either timestamp_eq or timestamp_between may be provided, but not both. If neither is provided, all storm data will be returned.

Timestamps must be 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.

Allowed Values: Two comma separated ISO 8601 timestamps

Example Value: 2018-07-12T08:00-07:00,2018-08-12T23:00-07:00

filetype optional

REQUIRED if {{format}} is json.

NOTE: the json format returns metadata for the target contour files, not the files themselves.

Allowed Values: geojson.zip, shp.zip

Resource Information

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

Related Documentation

Example Request

GET https://api.weathersource.com/v1/{{api_key}}/storms/SH212018/hazards/hurricanes.json?filetype=shp.zip

[
    {
        "stormId": "SH212018",
        "resource": "hazards",
        "datatype": "hurricanes",
        "filetype": "shp.zip",
        "timestamp": "2018-04-29T18:00:00+00:00",
        "lastModified": "2018-05-04T20:14:41+00:00",
        "bytes": 108668,
        "md5": "5339ef5f2bcc17673eef7bd059781e82",
        "url": "https://onpoint-spatial-files.weathersource.com/hazards/shp/hurricanes/2018SH21/2018/04/29/SH212018_hazards_hurricanes_201804291800.shp.zip?Expires=1525469991&Signature=mu~mjVtLajbA1nbo8NN2MI86hU2vxdEDPDVFriJUDKOgDi3zDcGHK0OMi6KWpAgFyiSw4W8Um4T9etlm0ANJHt1MuFXXnbKcOvLBFJrbL-3TaZn3X2qxOJOtlUpGLZABJNJlZk21d1I8wF2FsDi1HQWXaOKncNUHBV8THUKQfdosOxo6Rvc3gnpAbFELlMyHhCpllw0OECectvjWklbjrjBr99vukPvf2YmACBGC2rvCJxulwv~dSnwv7yyoL-eVRBdR3W7~GZck7U97Zvqgq39JsDPySGXHChA3mpzLj0ZFOncX2HXeXLzYlclSaMeIZwHO2L5WaaFI8btztuxu~Q__&Key-Pair-Id=APKAJTO4SYEB4NTNUODQ",
        "urlExpires": "2018-05-04T21:39:51+00:00",
        "apiRequest": "https://api.weathersource.localhost/v1/{{api_key}}/storms/SH212018/hazards/hurricanes.shp.zip?timestamp_eq=2018-04-29T18:00:00+00:00"
    },
    ...
]