GET /regions/{{region}}/history/{{datatype}}

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

Description

Returns a regional spatial file of weather history for the specified datatype. The json format will return metadata for the associated spatial files.

Requires a subscription plan with the “read_history” 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}}/history/{{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}}

The Hour class of weather data fields (period parameter is set to hour):

The Day class of weather data fields (period parameter is set to day):

{{format}}

The desired response format. Allowed formats are:

  • geojson.gz
  • shp.zip
  • geotiff
  • png
  • json

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

Parameters

timestamp_eq optional

REQUIRED if {{format}} is geotiff, shp.zip, geojson.gz, or png. If {{format}} is json, either timestamp_eq or timestamp_between must be provided.

Timestamps must be in ISO 8601 format.

If the period is day, the timestamp is assumed to be a local day. If period is hour the timestamp is assumed to be UTC, unless a UTC offset is provided (as part of the 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 geotiff, shp.zip, geojson.gz, or png. If {{format}} is json, either timestamp_eq or timestamp_between must be provided.

Timestamps must be in ISO 8601 format.

If the period is day, the timestamps are assumed to be local day. If period is hour the timestamps are assumed to be UTC, unless a UTC offset is provided (as part of the 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: 2007-02-12T08:00-07:00,2007-02-12T23:00-07:00

period optional

Identifies the class of weather observations (i.e. weather for a day or for an hour).

Allowed Values: hour, day

Default Value: day

oceans optional

A flag to indicate whether coverage of oceans should be turned off ("0") or turned on ("1") in the returned contour map.

Allowed Values: 0,1

Default Value: 0

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.gz, shp.zip, geotiff, png

Resource Information

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

Related Documentation

Example Request

GET https://api.weathersource.com/v1/{{api_key}}/regions/global/history/precip.json?timestamp_eq=2018-02-01T00:00:00+00:00&filetype=geojson.gz

[{"region":"global","resource":"history","datatype":"precip","filetype":"geojson.gz","timestamp":"2018-02-01","period":"day","oceans":0,"lastModified":"2018-02-02T20:52:14+00:00","bytes":5242360,"md5":"7f48be8807bed2843cfc47036df395a2","url":"https://onpoint-spatial-files.weathersource.com/history/geojson/global/land/day/precip/2018/02/01/global_land_history_precip_day_20180201.geojson.gz?Expires=1518203919&Signature=Rhr2Fn0EnoBhp~OwUzZXtVmA4-vqO30XcKWsY2Q7lsVd8RKWI-HdaESJWnjLNzh1jdBz6-wHuoTZ9TUthehhrAZhw8C7Uld1UEENqkmffKarSw57yB2D11Qo9XIoJL2pdYFgeJtguQ~3avgWtfYXTp-dnTxhiK3Rfdi12c7ZIWvZcr5BBHZhwqMCW8nvv0Uuivx41s2AdQEqSHFiG-FyYTYsXSpZOyEx2P3uDrAyA9AIRjnMRLKUqV9VcfYb7AWXwH6iXx2kbVPu42uKUoEXcexppMuRUwOD9afsDoMbzdMme8bX8axgOt5RW0nWaYvyIQnMl0ToMBg5UX4-2Ulsiw__&Key-Pair-Id=APKAJTO4SYEB4NTNUODQ","urlExpires":"2018-02-09T19:18:39+00:00","apiRequest":"https://api.weathersource.com/v1/{{api_key}}/regions/global/history/precip.geojson.gz?period=day&oceans=0×tamp_eq=2018-02-01"}]