GET /regions/{{region}}/hazards/{{datatype}}

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

Description

Returns a regional 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}}/regions/{{region}}/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.

{{region}}

A region covered by the contour file. Allowed regions are:

  • global
{{datatype}}

Available data types are:

  • drought (Source SPEI)
  • earthquakes
  • volcano-ash
  • wildfires
{{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. If {{format}} is json, either timestamp_eq or timestamp_between must be provided.

Timestamps must be in ISO 8601 format.

Allowed Values: ISO 8601 timestamp

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

timestamp_between optional

NOT ALLOWED if {{format}} is geojson.zip or shp.zip. If {{format}} is json, either timestamp_eq or timestamp_between must be provided.

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}}/regions/global/hazards/wildfires.json?filetype=shp.zip&timestamp_between=2018-07-12,2018-08-12

[
    {
        "region": "global",
        "resource": "hazards",
        "datatype": "wildfires",
        "filetype": "shp.zip",
        "timestamp": "2018-08-06",
        "lastModified": "2018-08-06T17:14:23+00:00",
        "bytes": 2953984,
        "md5": "98d8217384efbc15ed929df7d4c6ee0e",
        "url": "https://onpoint-spatial-files.weathersource.com/hazards/shp/wildfires/global/2018/08/06/global_hazards_wildfires_20180806.shp.zip?Expires=1533764037&Signature=Q7qv96MRK5nPNeZl3kre~IUB3zht-lpCIWt9LYATAauNLiQdoKPiBH-51Dxvcfdd9t6FOVIqFe7EVGWbG1UvdZQDi8vpfJMP7dTaA~W6hS3NUBs5DhQHZAYSu~M4ucjDzchCMgO33E-qEehLWXdap8jILZ3StYzzzznRnQFxVP6o-gzapnK~QqryLGFOmqobw~PlSxvawTNiMegxJ~ClUWT3iagABR-PCSL9S-w-J5LeuO45pc8~FZ88EZNbTk8aSjZvCa61Px2Kq7SMSLGo6zgeeh8P6jOFj9KbzGL1hNFK4QhmDLcvRuMX2YWy1jSeQ09UrrJZL6tgXLWyL7~pdg__&Key-Pair-Id=APKAJTO4SYEB4NTNUODQ",
        "urlExpires": "2018-08-08T21:33:57+00:00",
        "apiRequest": "https://api.weathersource.com/v1/{{api_key}}/regions/global/hazards/wildfires.shp.zip?timestamp_eq=2018-08-06"
    },
    ...
]