Frames

A frame is a product or forecast “snapshot” at a particular moment in time, such as the surface temperature at noon today.

The time that a frame represents is called its valid time. The time when a frame’s underlying data was generated is called its run time. Sometimes more than one frame is generated for the same valid time (later on, with newer or better data). These are called re-runs.

Every frame identifies a range of zoom levels and media types that can be used for map tile requests. A frame’s “native” zoom level is what best matches the native resolution of the underlying data.


Product Frame List

GET /products/{product-id-or-name}/frames

Optional Parameters

A product may have hundreds of frames. The default response contains the 10 latest frames for the product, in ascending order, without re-runs (i.e., only the latest available run per valid time).

Use the start, end, or limit parameter to obtain a different number of results. When start and end are both specified, limit has no effect–the response contains all available frames in the time range.

Name Type Description Accepted Values / Range Example
start string UTC start time (ISO8601) any valid timestamp 2016-06-01T00:00:00Z
end string UTC end time (ISO8601) any valid timestamp 2016-06-01T01:00:00Z
limit number max number of results any positive integer 10
sort string sort order asc, desc desc
reruns boolean include re-runs true, false true

Request Examples

See Headers for request header details.

$ curl -n -X GET https://platform.api.wdtinc.com/products/4a79aeab-84f0-4dde-ae39-a20b4ccee878/frames \
-H "Accept: application/vnd.wdt+json; version=1"
$ curl -n -X GET https://platform.api.wdtinc.com/products/skywise-base-reflectivity/frames \
-H "Accept: application/vnd.wdt+json; version=1"

Response Example

See Status Codes for response code details.

HTTP/1.1 200 OK
[
  {
    "id": "77d3b884-3833-495f-9b64-dfefe527fd28",
    "validTime": "2016-06-01T00:00:00Z",
    "runTime": "2016-06-01T00:01:00Z",
    "zoomLevels": {
      "minimum": 2,
      "native": 5,
      "maximum": 17
    },
    "mediaTypes": [
      "image/jpeg",
      "image/png",
      "image/tiff"
    ],
    "tileSize": 256,
    "creationTime": "2016-06-01T00:01:35Z",
    "expirationTime": "2016-06-01T01:00:00Z",
    "forecast": null,
    "product": "/products/4a79aeab-84f0-4dde-ae39-a20b4ccee878"
  },
  {
    "id": "89cbee3c-0031-45d5-8651-cf15ebce0fe9",
    "validTime": "2016-06-01T00:15:00Z",
    "runTime": "2016-06-01T00:16:00Z",
    "zoomLevels": {
      "minimum": 2,
      "native": 5,
      "maximum": 17
    },
    "mediaTypes": [
      "image/jpeg",
      "image/png",
      "image/tiff"
    ],
    "tileSize": 256,
    "creationTime": "2016-06-01T01:19:22Z",
    "expirationTime": "2016-06-01T12:00:00Z",
    "forecast": null,
    "product": "/products/4a79aeab-84f0-4dde-ae39-a20b4ccee878"
  }
]

Forecast Frame List

GET /forecasts/{forecast-id}/frames

Optional Parameters

A forecast may have hundreds of frames. The default response contains the first 10 frames in the forecast, in ascending order, without re-runs (i.e., only the latest available run per valid time).

Use the start, end, or limit parameter to obtain a different number of results. When start and end are both specified, limit has no effect–the response contains all available frames in the time range.

Name Type Description Accepted Values / Range Example
start string UTC start time (ISO8601) any valid timestamp 2016-06-01T00:00:00Z
end string UTC end time (ISO8601) any valid timestamp 2016-06-01T01:00:00Z
limit number max number of results any positive integer 10
sort string sort order asc, desc desc
reruns boolean include re-runs true, false true

Request Examples

See Headers for request header details.

$ curl -n -X GET https://platform.api.wdtinc.com/forecasts/9318fe5c-2ea8-4c5c-b930-4ae81a89776f/frames \
-H "Accept: application/vnd.wdt+json; version=1"

Response Example

See Status Codes for response code details.

HTTP/1.1 200 OK
[
  {
    "id": "953fcf5e-e7ee-4d2d-aee5-f206beb85792",
    "validTime": "2016-06-01T00:00:00Z",
    "runTime": "2016-06-01T01:12:07Z",
    "zoomLevels": {
      "minimum": 2,
      "native": 3,
      "maximum": 17
    },
    "mediaTypes": [
      "image/jpeg",
      "image/png",
      "image/tiff"
    ],
    "tileSize": 256,
    "creationTime": "2016-06-01T01:19:22Z",
    "expirationTime": "2016-06-01T12:00:00Z",
    "forecast": "/forecasts/9318fe5c-2ea8-4c5c-b930-4ae81a89776f",
    "product": "/products/7d8f1c29-35cd-4028-b034-509fcf48cdf0"
  },
  {
    "id": "146e17b0-379d-11e4-916c-0800200c9a66",
    "validTime": "2016-06-01T06:00:00Z",
    "runTime": "2016-06-01T07:09:32Z",
    "zoomLevels": {
      "minimum": 2,
      "native": 3,
      "maximum": 17
    },
    "mediaTypes": [
      "image/jpeg",
      "image/png",
      "image/tiff"
    ],
    "tileSize": 256,
    "creationTime": "2016-06-01T07:22:19Z",
    "expirationTime": "2016-06-01T18:00:00Z",
    "forecast": "/forecasts/9318fe5c-2ea8-4c5c-b930-4ae81a89776f",
    "product": "/products/7d8f1c29-35cd-4028-b034-509fcf48cdf0"
  }
]

Frame Information

GET /frames/{frame-id}

Request Example

See Headers for request header details.

$ curl -n -X GET https://platform.api.wdtinc.com/frames/953fcf5e-e7ee-4d2d-aee5-f206beb85792 \
-H "Accept: application/vnd.wdt+json; version=1"

Response Example

See Status Codes for response code details.

HTTP/1.1 200 OK
{
  "id": "953fcf5e-e7ee-4d2d-aee5-f206beb85792",
  "validTime": "2016-06-01T00:00:00Z",
  "runTime": "2016-06-01T01:12:07Z",
  "zoomLevels": {
    "minimum": 2,
    "native": 3,
    "maximum": 17
  },
  "mediaTypes": [
    "image/jpeg",
    "image/png",
    "image/tiff"
  ],
  "tileSize": 256,
  "creationTime": "2016-06-01T01:19:22Z",
  "expirationTime": "2016-06-01T12:00:00Z",
  "forecast": "/forecasts/9318fe5c-2ea8-4c5c-b930-4ae81a89776f",
  "product": "/products/7d8f1c29-35cd-4028-b034-509fcf48cdf0"
}