Road Weather

Road Weather

URL Path
https://api.aerisapi.com/roadweather/
Data Coverage
US, Europe, Japan, Canada
Update Interval
Every 15 Minutes
Time Range
N/A

The roadweather endpoint is powered by the advanced and precise Vaisala Xweather road weather forecasts. This innovative endpoint delivers essential information on road conditions through a summary index (green, yellow, or red), enabling users to gauge driving safety at a glance. For comprehensive road weather insights, including the road surface condition (dry, wet, snow, ice) and road surface temperature, the RoadWeather Conditions add-on is available. For the complete road weather offerings, the Road Weather Analytics add-on adds water, snow, and ice thickness, hydroplane and turnover probabilities, visibility probabilities, and more.

Requests

Every request to the endpoint must include one of the supported actions in the url.

https://api.aerisapi.com/roadweather/{action}?client_id={client_id}&client_secret={client_secret}&{params}

Supported Actions

The following actions are supported with the /roadweather endpoint:

ActionDescription
:idType: stringTypically used for passing a geographical location name or identifier such as city name, lat/long, or even US and Canadian postal codes. Learn more.
routeType: stringAllows you to pass several coordinates along a custom route to return data points at each location. Learn more.

Response

The following is an example of what each object in the response will consist of. Depending on your requested action, the response may contain multiple instances of this object within an array.

Properties

id (string)

The ID of the requested location.

dataSource (string)

An ID string of the data source provider utilized for the data set

road (object)

An object containing the nearby road information. Null if unavailable.

road.type (string)

The type of road. Can be:
- primary
- secondary
- tertiary
- bridge

road.name (string)

The road name. Null if unavailable.

loc (object)

The location of the record.

loc.lat (number)

The latitude coordinate of the record.

loc.long (number)

The place or nearest place to the record.

place (object)

Object containing information about the place or nearest place to the record.

place.name (string)

The place or nearest place to the record.

place.state (string)

The state abbreviation in which the response is located. This may be null or an empty string depending on the country.

place.country (string)

The 2 letter ISO-3166 country abbreviation in which the response is located.

periods (array)

An array of the road weather forecast periods

periods.#.timestamp (number)

The unix timestamp in seconds of the valid date/time of the forecast

periods.#.dateTimeISO (string)

The date and time of the forecast in ISO-8601 format

periods.#.summary (string)

A summary of road conditions broken down as:
- GREEN = dry roads with no issues
- YELLOW = Potential for wet roads, extend caution
- RED = Potential adverse road conditions.

Available to all Flex Subscribers.

periods.#.summaryIndex (number)

A numerical version of the road conditions summary:
- 0 = GREEN
- 1 = YELLOW
- 2 = RED

Available to all Flex Subscribers.

profile (object)

Object containing information about the location or event.

profile.elevM (number)

The elevation of the location in meters.

profile.elevFT (number)

The elevation of the location in feet.

profile.tz (string)

Timezone name of the location, such as America/New_York.

[
  {
    "id": "79wefx4",
    "dataSource": "vaisala-road-wx",
    "road": {
      "type": "primary",
      "name": "Washington Avenue South"
    },
    "loc": {
      "lat": 44.97997,
      "long": -93.26384
    },
    "place": {
      "name": "minneapolis",
      "state": "mn",
      "country": "us"
    },
    "periods": [
      {
        "timestamp": 1702596600,
        "dateTimeISO": "2023-12-14T17:30:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702597500,
        "dateTimeISO": "2023-12-14T17:45:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702598400,
        "dateTimeISO": "2023-12-14T18:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702599300,
        "dateTimeISO": "2023-12-14T18:15:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702600200,
        "dateTimeISO": "2023-12-14T18:30:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702601100,
        "dateTimeISO": "2023-12-14T18:45:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702602000,
        "dateTimeISO": "2023-12-14T19:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702605600,
        "dateTimeISO": "2023-12-14T20:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702609200,
        "dateTimeISO": "2023-12-14T21:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702612800,
        "dateTimeISO": "2023-12-14T22:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702616400,
        "dateTimeISO": "2023-12-14T23:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702620000,
        "dateTimeISO": "2023-12-15T00:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702623600,
        "dateTimeISO": "2023-12-15T01:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702627200,
        "dateTimeISO": "2023-12-15T02:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702630800,
        "dateTimeISO": "2023-12-15T03:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702634400,
        "dateTimeISO": "2023-12-15T04:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702638000,
        "dateTimeISO": "2023-12-15T05:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702641600,
        "dateTimeISO": "2023-12-15T06:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702645200,
        "dateTimeISO": "2023-12-15T07:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702648800,
        "dateTimeISO": "2023-12-15T08:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702652400,
        "dateTimeISO": "2023-12-15T09:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702656000,
        "dateTimeISO": "2023-12-15T10:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702659600,
        "dateTimeISO": "2023-12-15T11:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      },
      {
        "timestamp": 1702663200,
        "dateTimeISO": "2023-12-15T12:00:00-06:00",
        "summary": "GREEN",
        "summaryIndex": 0
      }
    ],
    "profile": {
      "elevM": 242,
      "elevFT": 793.96,
      "tz": "America/Chicago"
    }
  }
]