Tomorrow.io · Schema

TimelinesRequest

Advanced Timelines request body.

WeatherClimateForecastHistorical WeatherAir QualityPollenFireFloodRoutesMap TilesAviationMaritimePublic APIs

Properties

Name Type Description
location object
fields array
units string
timesteps array
startTime string Accepts `now`, relative `nowPlus/MinusXm/h/d`, or ISO 8601.
endTime string
timezone string
dailyStartHour integer
View JSON Schema on GitHub

JSON Schema

timelines-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tomorrow/refs/heads/main/json-schema/timelines-request-schema.json",
  "title": "TimelinesRequest",
  "description": "Advanced Timelines request body.",
  "type": "object",
  "properties": {
    "location": {
      "oneOf": [
        {
          "type": "string",
          "description": "Pre-defined location ID, place name, or latlong string.",
          "example": "42.3478,-71.0466"
        },
        {
          "type": "object",
          "description": "GeoJSON geometry \u2014 Point, LineString, or Polygon.",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "Point",
                "LineString",
                "Polygon"
              ],
              "example": "Point"
            },
            "coordinates": {
              "type": "array",
              "items": {},
              "example": [
                -71.0466,
                42.3478
              ]
            }
          },
          "required": [
            "type",
            "coordinates"
          ]
        }
      ]
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "temperature",
        "humidity",
        "windSpeed"
      ]
    },
    "units": {
      "type": "string",
      "enum": [
        "metric",
        "imperial"
      ],
      "default": "metric"
    },
    "timesteps": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "1m",
          "5m",
          "15m",
          "30m",
          "1h",
          "1d",
          "current"
        ]
      },
      "example": [
        "1h"
      ]
    },
    "startTime": {
      "type": "string",
      "example": "now",
      "description": "Accepts `now`, relative `nowPlus/MinusXm/h/d`, or ISO 8601."
    },
    "endTime": {
      "type": "string",
      "example": "nowPlus6h"
    },
    "timezone": {
      "type": "string",
      "default": "UTC",
      "example": "America/New_York"
    },
    "dailyStartHour": {
      "type": "integer",
      "minimum": 0,
      "maximum": 23,
      "default": 6
    }
  },
  "required": [
    "location",
    "fields"
  ]
}