Products

Time series of catalog products at up to 25 locations.

Multi-location form of GET /v1/series: the same grammar as JSON fields, with locations[] of {lat, lon, label?} (at most 25) in place of lat and lon. Products x locations is at most 100. Elements come back location-major in request order, each echoing its location's label. Every rule of GET /v1/series applies; points, top-level lat/lon and at are not words of this route, and an unknown field is a 400.

Experimental (x-stability: experimental), as GET /v1/series.

Caching

Cache-Control: private, no-store.

Auth and cost

Standard sw-api Bearer auth and rate limits apply. Cost class data, weight 1 per location (len(locations)), whatever each element's status; products, variables, hours and limit never change it.

post/v1/series/batch

Request

  • Base URL: https://api.smarterweather.com
  • URL: https://api.smarterweather.com/v1/series/batch
  • Auth: HTTP bearer

Request body

productstring
varstring[]
selectstring[]
units'si' | 'metric' | 'imperial' required
hoursinteger
startstring date-time
endstring date-time
runstring date-time
limitinteger
cursorstring

Example request

{
  "locations": [
    {
      "lat": 41.88,
      "lon": -87.63,
      "label": "chicago"
    }
  ],
  "product": "hrrr_surface",
  "var": [
    "temperature_2m"
  ],
  "select": [
    "hrrr_surface:temperature_2m"
  ]
}

Response

One series element per (location, product).

units'si' | 'metric' | 'imperial' required

The requested units system.

truncatedboolean required

True when limit cut the series; next_cursor resumes them.

next_cursorstring nullable required

Opaque cursor for the next page, null when not truncated.

Example response

{
  "meta": {
    "sources": [
      {
        "id": "hrrr",
        "attribution": "Data provided by NOAA/NWS",
        "license": "public_domain"
      }
    ]
  },
  "series": [
    {
      "product": "hrrr_surface",
      "related": "hrrr_alaska_surface",
      "meta": {
        "timezone": "America/Chicago"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.