---
title: "Use to get a locationally precise, up-to-the-minute forecast that includes
weather hazard assessments and notifications along a route."
method: GET
path: "/weather/route/{format}"
---

# Use to get a locationally precise, up-to-the-minute forecast that includes
weather hazard assessments and notifications along a route.

`GET /weather/route/{format}`

The `Get Weather Along Route` API is an HTTP `GET` request that returns hyper
local (one kilometer or less), up-to-the-minute weather nowcasts, weather
hazard assessments, and notifications along a route described as a sequence of
waypoints.
This includes a list of weather hazards affecting the waypoint or route, and
the aggregated hazard index for each waypoint might be used to paint each
portion of a route according to how safe it is for the driver. When submitting
the waypoints, it is recommended to stay within, or close to, the distance that
can be traveled within 120-mins or shortly after. Data is updated every five
minutes.

The service supplements Azure Maps [Route
Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to
first request a route between an origin and a destination and use that as an
input for Weather Along Route endpoint.

In addition, the service supports scenarios to generate weather notifications
for waypoints that experience an increase in intensity of a weather hazard. For
example, if the vehicle is expected to begin experiencing heavy rain as it
reaches a waypoint, a weather notification for heavy rain will be generated for
that waypoint allowing the end product to display a heavy rain notification
before the driver reaches that waypoint.
The trigger for when to display the notification for a waypoint could be
based, for example, on a
[geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps),
or selectable distance to the waypoint.

The API covers all regions of the planet except latitudes above Greenland and
Antarctica.

## Path parameters

- `format` 'json', required

## Query parameters

- `api-version` string, required
- `query` string, required
- `language` string

## Headers

- `x-ms-client-id` string

## Response `200`

The request has succeeded.

- WeatherAlongRouteResult — This object is returned from a successful Weather Along Route.
  - `summary` WeatherAlongRouteSummary — Short summary of the weather along the route.
    - `iconCode` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 — Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.
    - `hazards` WeatherHazards — Description of the weather hazard affecting the trip.
      - `maxHazardIndex` 0 | 1 | 2 | 3 | 4 — The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency.
      - `hazardDetails` HazardDetail[] — Details of the weather hazards affecting the trip.
        - `hazardIndex` 0 | 1 | 2 | 3 | 4 — The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency.
        - `hazardCode` string — A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.
        - `shortPhrase` string — A displayable short phrase describing the forecasted conditions and precipitation intensity/type.
  - `waypoints` WaypointForecast[] — Data for each waypoint returned in the same order as specified in the request.
    - `iconCode` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 — Numeric value representing an image that corresponds to the current weather condition described by the `Phrase` property. For more information, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#weather-icons). May be NULL.
    - `shortPhrase` string — A displayable short phrase describing the forecasted conditions and precipitation intensity/type.
    - `isDayTime` boolean — Indicates the time of the day. True indicates 'day',', false indicates 'night.
    - `cloudCover` integer — Percent representing cloud cover.
    - `temperature` WeatherValue — Specific value of a given unit related to weather.
      - `value` number, float — Rounded value.
      - `unit` string — Type of unit for the returned value.
      - `unitType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 31 — An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).
    - `wind` WindDetails — Wind details being returned including speed and direction.
      - `direction` WindDirection — Wind direction
        - `degrees` integer — Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359.
        - `localizedDescription` string — Direction abbreviation in the specified language.
      - `speed` WeatherValue — Specific value of a given unit related to weather.
        - `value` number, float — Rounded value.
        - `unit` string — Type of unit for the returned value.
        - `unitType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 31 — An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).
    - `windGust` WindDetails — Wind details being returned including speed and direction.
      - `direction` WindDirection — Wind direction
        - `degrees` integer — Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359.
        - `localizedDescription` string — Direction abbreviation in the specified language.
      - `speed` WeatherValue — Specific value of a given unit related to weather.
        - `value` number, float — Rounded value.
        - `unit` string — Type of unit for the returned value.
        - `unitType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 31 — An integer representing the unit type. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For a complete list, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types).
    - `precipitation` WeatherAlongRoutePrecipitation — Precipitation forecast of the weather along the route.
      - `dbz` number, double — The forecasted precipitation intensity in dBZ (decibels relative to Z) from 0.0 to 100.0.
      - `type` string — Precipitation type. If precipitation should occur, the type that it will be: "RAIN," "HAIL," "SNOW," "ICE," or "MIX."
    - `lightningCount` integer — Estimation of thunderstorm intensity on an open scale. A value of 0 means there is no thunderstorm; values of 1 and higher mean there is a thunderstorm in increasing intensity.
    - `sunGlare` SunGlare — A rating that indicates how blinding the sun is for the driver.
      - `calculatedVehicleHeading` integer — If the vehicle heading value is not provided for a waypoint, then the service will calculate a heading based upon the location of neighboring waypoints if provided.
      - `glareIndex` integer — An index from 0 to 100 indicating sun glare intensity for a driver. A value of 50 and above can be considered a hazard for some drivers and a value of 100 signifies the driver is driving straight into the sun and atmospheric conditions are clear allowing for the full intensity of the sun to blind the driver.
    - `hazards` WeatherHazards — Description of the weather hazard affecting the trip.
      - `maxHazardIndex` 0 | 1 | 2 | 3 | 4 — The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency.
      - `hazardDetails` HazardDetail[] — Details of the weather hazards affecting the trip.
        - `hazardIndex` 0 | 1 | 2 | 3 | 4 — The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency.
        - `hazardCode` string — A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.
        - `shortPhrase` string — A displayable short phrase describing the forecasted conditions and precipitation intensity/type.
    - `notifications` WeatherNotification[] — List of weather hazard notifications.
      - `type` string — A type of notification generated to warn drivers of the onset of a hazard, or increase in intensity of a hazard.
      - `hazardIndex` 0 | 1 | 2 | 3 | 4 — The aggregated severity/hazard index for each waypoint, which can be used to color-code route segments to indicate driver safety. * `0` - No hazard. * `1` - Be informed, be aware. * `2` - Pay attention, be prepared. * `3` - Take action. * `4` - Life threatening, emergency.
      - `hazardCode` string — A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.
      - `shortPhrase` string — A displayable short phrase describing the forecasted conditions and precipitation intensity/type.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/maps-weather.md) · [All operations](https://skmtc.net/azure/apis/maps-weather/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/maps-weather/revisions/3c076fdd2918/schema)