Tomorrow.io · Schema

RouteRequest

Route weather request body.

WeatherClimateForecastHistorical WeatherAir QualityPollenFireFloodRoutesMap TilesAviationMaritimePublic APIs

Properties

Name Type Description
route object
fields array
units string
View JSON Schema on GitHub

JSON Schema

route-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/route-request-schema.json",
  "title": "RouteRequest",
  "description": "Route weather request body.",
  "type": "object",
  "properties": {
    "route": {
      "type": "object",
      "properties": {
        "waypoints": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "A waypoint on the route.",
            "properties": {
              "location": {
                "type": "array",
                "items": {
                  "type": "number",
                  "format": "double"
                },
                "minItems": 2,
                "maxItems": 2,
                "example": [
                  -71.0466,
                  42.3478
                ]
              },
              "arrivalTime": {
                "type": "string",
                "format": "date-time",
                "example": "2026-05-30T13:30:00Z"
              }
            },
            "required": [
              "location"
            ]
          },
          "minItems": 2
        }
      },
      "required": [
        "waypoints"
      ]
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "temperature",
        "precipitationIntensity",
        "visibility",
        "windSpeed"
      ]
    },
    "units": {
      "type": "string",
      "enum": [
        "metric",
        "imperial"
      ],
      "default": "metric"
    }
  },
  "required": [
    "route",
    "fields"
  ]
}