Weather - Get Daily Forecast
Use to get a daily detailed weather forecast for the next 1, 5, 10, 15, 25, or
45 days.
The Get Daily Forecast API is an HTTP GET request that returns detailed
weather forecast such as temperature and wind by day for the next 1, 5, 10, 15,
25, or 45 days for a given coordinate location. The response includes details
such as temperature, wind, precipitation, air quality, and UV index. For more
information, see Request daily weather forecast
data.
GET {endpoint}/weather/forecast/daily/json?api-version=1.1&query={query}
GET {endpoint}/weather/forecast/daily/json?api-version=1.1&query={query}&unit={unit}&duration={duration}&language={language}
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
The Azure Maps service hostname. Use |
|
format
|
path | True |
Desired format of the response. Only |
|
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
|
query
|
query | True |
number[] |
The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline. |
|
duration
|
query |
integer (int32) |
Specifies for how many days the daily forecast responses are returned. Available values are
|
|
|
language
|
query |
string |
Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to Supported Languages for details. |
|
|
unit
|
query |
Specifies to return the data in either metric units or imperial units. Default value is metric. |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see Manage authentication in Azure Maps. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request has succeeded. |
|
| Other Status Codes |
An unexpected error response. |
Security
AadToken
These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.
To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.
Note
- This security definition requires the use of the
x-ms-client-idheader to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API. - The
Authorization URLis specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. - The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
- Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
- For more information on Microsoft identity platform, see Microsoft identity platform overview.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.
With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.
For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.
Type:
apiKey
In:
header
SAS Token
This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.
For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.
Type:
apiKey
In:
header
Examples
Successfully retrieve detailed daily weather forecast for a given coordinate location
Sample request
GET https://atlas.microsoft.com/weather/forecast/daily/json?api-version=1.1&query=62.6490341,30.0734812&duration=5
Sample response
{
"forecasts": [
{
"airAndPollen": [
{
"name": "AirQuality",
"type": "Ozone",
"category": "Good",
"categoryValue": 1,
"value": 0
},
{
"name": "Grass",
"category": "Low",
"categoryValue": 1,
"value": 0
},
{
"name": "Mold",
"category": "Low",
"categoryValue": 1,
"value": 0
},
{
"name": "Ragweed",
"category": "Low",
"categoryValue": 1,
"value": 0
},
{
"name": "Tree",
"category": "Low",
"categoryValue": 1,
"value": 0
},
{
"name": "UVIndex",
"category": "Low",
"categoryValue": 1,
"value": 0
}
],
"date": "2019-11-13T21:00:00-08:00",
"day": {
"cloudCover": 100,
"hasPrecipitation": true,
"hoursOfIce": 0,
"hoursOfPrecipitation": 3.5,
"hoursOfRain": 3.5,
"hoursOfSnow": 0,
"ice": {
"unit": "mm",
"unitType": 3,
"value": 0
},
"iceProbability": 0,
"iconCode": 12,
"iconPhrase": "Showers",
"longPhrase": "Cloudy with a couple of showers, mainly later",
"precipitationIntensity": "Light",
"precipitationProbability": 75,
"precipitationType": "Rain",
"rain": {
"unit": "mm",
"unitType": 3,
"value": 6.1
},
"rainProbability": 75,
"shortPhrase": "Cloudy with a few showers",
"snow": {
"unit": "cm",
"unitType": 4,
"value": 0
},
"snowProbability": 40,
"thunderstormProbability": 20,
"totalLiquid": {
"unit": "mm",
"unitType": 3,
"value": 6.1
},
"wind": {
"direction": {
"degrees": 160,
"localizedDescription": "SSE"
},
"speed": {
"unit": "km/h",
"unitType": 7,
"value": 16.7
}
},
"windGust": {
"direction": {
"degrees": 160,
"localizedDescription": "SSE"
},
"speed": {
"unit": "km/h",
"unitType": 7,
"value": 48.2
}
}
},
"degreeDaySummary": {
"cooling": {
"unit": "C",
"unitType": 17,
"value": 0
},
"heating": {
"unit": "C",
"unitType": 17,
"value": 15
}
},
"hoursOfSun": 1.1,
"night": {
"cloudCover": 98,
"hasPrecipitation": true,
"hoursOfIce": 0,
"hoursOfPrecipitation": 2.5,
"hoursOfRain": 2.5,
"hoursOfSnow": 0,
"ice": {
"unit": "mm",
"unitType": 3,
"value": 0
},
"iceProbability": 0,
"iconCode": 12,
"iconPhrase": "Showers",
"longPhrase": "Breezy this evening; otherwise, low clouds",
"precipitationIntensity": "Light",
"precipitationProbability": 65,
"precipitationType": "Rain",
"rain": {
"unit": "mm",
"unitType": 3,
"value": 4
},
"rainProbability": 64,
"shortPhrase": "Breezy early; cloudy",
"snow": {
"unit": "cm",
"unitType": 4,
"value": 0
},
"snowProbability": 40,
"thunderstormProbability": 0,
"totalLiquid": {
"unit": "mm",
"unitType": 3,
"value": 4
},
"wind": {
"direction": {
"degrees": 181,
"localizedDescription": "S"
},
"speed": {
"unit": "km/h",
"unitType": 7,
"value": 20.4
}
},
"windGust": {
"direction": {
"degrees": 170,
"localizedDescription": "S"
},
"speed": {
"unit": "km/h",
"unitType": 7,
"value": 42.6
}
}
},
"realFeelTemperature": {
"maximum": {
"unit": "C",
"unitType": 17,
"value": 1.3
},
"minimum": {
"unit": "C",
"unitType": 17,
"value": -3.4
}
},
"realFeelTemperatureShade": {
"maximum": {
"unit": "C",
"unitType": 17,
"value": 1.6
},
"minimum": {
"unit": "C",
"unitType": 17,
"value": -3.4
}
},
"sources": [
"AccuWeather"
],
"temperature": {
"maximum": {
"unit": "C",
"unitType": 17,
"value": 5.3
},
"minimum": {
"unit": "C",
"unitType": 17,
"value": 0.8
}
}
}
],
"summary": {
"category": "rain",
"endDate": "2019-11-17T15:00:00-08:00",
"phrase": "Rain Sunday evening",
"severity": 5,
"startDate": "2019-11-17T09:00:00-08:00"
}
}
Definitions
| Name | Description |
|---|---|
|
Air |
One entry in
|
|
Daily |
The forecast for one calendar day at the specified location, returned as
one entry per day in the |
|
Daily |
Forecast details for one half of a day. The same shape is used for
both |
|
Daily |
The response returned by the Get Daily Forecast operation, providing a
day-by-day weather forecast for a specified location. Includes a top-level
|
|
Daily |
A high-level summary of the dominant weather conditions across part or
all of the requested daily-forecast window. The summarized window can be
narrower than the full request - for example, when significant weather
(such as a storm system) is expected during only a portion of the
period - and is delimited by |
|
Degree |
Heating and cooling degree-day totals for a single day, used to estimate
the energy demand for heating or cooling a building. Each value is the
number of degrees by which the day's mean temperature differs from the
65°F (18°C) baseline, in the temperature unit specified in the
request - degrees below the baseline contribute to |
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
|
Icon |
The numeric weather-condition code that identifies which icon to display.
Each value in this enumeration corresponds to an Azure Maps weather icon
(such as Sunny, Cloudy, or Thunderstorms) and pairs with a human-readable
For the complete list of codes, the icons they map to, and example imagery, see Weather services in Azure Maps. |
|
Json |
Desired format of the response. Only |
|
Local |
Information about a local weather data provider used to source the
forecast on |
|
Precipitation |
Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero. |
|
Unit |
An integer value associated with the type of unit being displayed. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For more information, see Weather services in Azure Maps. |
|
Weather |
Specifies whether to return data in metric or imperial units, with metric as the default. For example:
|
|
Weather |
Values for weather-related metrics such as temperature, dew point, and wind speed, presented in either metric or imperial units, as specified in the unit URI parameter. For more information, see Unit types in the article Weather services in Azure Maps. |
|
Weather |
Provides the highest and lowest forecasted temperatures for the specified timeframe, measured in degrees Celsius (°C) or Fahrenheit (°F), based on the unit specified in the request. |
|
Wind |
Provides the forecasted wind speed, measured in units such as kilometers per hour (km/h) or miles per hour (mph), depending on the unit specified in the request. Also indicates the wind direction measured in azimuth degrees, starting at true North and moving clockwise. North corresponds to 0°, east to 90°, south to 180°, and west to 270°. Possible values range from 0° to 359°. |
|
Wind |
Provides details about wind direction, including the direction in azimuth degrees and a localized abbreviation of the wind direction. |
AirAndPollen
One entry in DailyForecast.airAndPollen describing a single pollen,
air-quality, or UV-index indicator for the day. The name property
determines which kind of indicator the entry represents:
- Pollen:
nameis Tree, Grass, Ragweed, or Mold.valuegives the forecast amount andcategory/categoryValuerate it from Low to High. - Air quality:
nameis AirQuality andtypeidentifies the pollutant being measured (one of PM2.5, PM10, O3, NO2, SO2, or CO).category/categoryValuerate the air quality from Good to Hazardous. - UV index:
nameis UVIndex.valueis the UV index (0 to 11+), andcategory/categoryValuerate the exposure risk from Low to Extreme.
category is the qualitative label for the indicator and
categoryValue is the matching 1-6 rating, where 1 indicates
the safest conditions and 6 the most hazardous.
| Name | Type | Description |
|---|---|---|
| category |
string |
A short qualitative label for the indicator, returned in the
language specified in the request. Possible values depend on
|
| categoryValue |
integer (int32) |
A 1-6 numeric rating that pairs with |
| name |
string |
Identifies which indicator this entry represents. Either the name
of a pollen source (Tree, Grass, Ragweed, or Mold),
AirQuality (in which case |
| type |
string |
When
|
| value |
integer (int32) |
The numeric measurement for this indicator. The unit depends on
Both air quality and UV index are themselves indices, so they are reported as unitless numbers. |
DailyForecast
The forecast for one calendar day at the specified location, returned as
one entry per day in the forecasts array on DailyForecastResult.
Includes the day's high/low temperature range, RealFeel ranges (regular
and shaded), expected hours of sunshine, heating/cooling degree-day
totals, an array of air-quality, pollen, and UV-index indicators, and
separate detail blocks for the daytime and nighttime portions of the day
(precipitation, wind, cloud cover, and more). The sources array lists
the data providers contributing to the forecast.
| Name | Type | Description |
|---|---|---|
| airAndPollen |
Forecasted air-quality, pollen, and UV-index indicators for the day.
Each entry reports a name (such as Tree, Grass, Ragweed, Mold,
AirQuality, or UVIndex), a numeric value, and a qualitative
|
|
| date |
string (date-time) |
The calendar date this forecast covers, in ISO
8601 format
( |
| day |
The detailed forecast for the daytime portion of the day - including temperature, precipitation, wind, cloud cover, and other key attributes. |
|
| degreeDaySummary |
Heating and cooling degree-day totals for the day, used to estimate energy demand for building climate control. |
|
| hoursOfSun |
number (float) |
The expected number of hours of sunshine during the day, useful for planning outdoor activities and gauging overall daytime conditions. |
| night |
The detailed forecast for the nighttime portion of the day - including temperature, precipitation, wind, cloud cover, and other key attributes. |
|
| realFeelTemperature |
The high and low RealFeel™ Temperature values for the day, in degrees Celsius (°C) or Fahrenheit (°F), depending on the unit specified in the request. Developed by AccuWeather, RealFeel combines air temperature with humidity, wind, cloud cover, sun intensity, and other factors to indicate how the weather actually feels. For more information, see What is the AccuWeather RealFeel Temperature? |
|
| realFeelTemperatureShade |
The high and low RealFeel™ Temperature values for the day in shaded
areas, in degrees Celsius (°C) or Fahrenheit (°F), depending on the
unit specified in the request. Like |
|
| sources |
string[] |
The data providers that contributed to this day's forecast. |
| temperature |
The forecasted high and low air temperatures for the day, in degrees Celsius (°C) or Fahrenheit (°F), depending on the unit specified in the request. |
DailyForecastDetail
Forecast details for one half of a day. The same shape is used for
both DailyForecast.day (sunrise to sunset) and DailyForecast.night
(sunset to next sunrise), so all references to "this period" below
mean that specific daytime or nighttime portion - never the full
24-hour day. Includes a forecast icon and phrases, precipitation
type / intensity / probabilities, accumulation totals, hours of
precipitation, wind, and cloud cover.
| Name | Type | Description |
|---|---|---|
| cloudCover |
integer (int32) |
The percentage of the sky covered by clouds during this period, from 0 (clear skies) to 100 (completely overcast). May be NULL. |
| hasPrecipitation |
boolean |
|
| hoursOfIce |
number (float) |
The total number of hours during this period when ice formation is expected. |
| hoursOfPrecipitation |
number (float) |
The total number of hours during this period when any precipitation (rain, snow, sleet, or hail) is expected. |
| hoursOfRain |
number (float) |
The total number of hours during this period when rain is expected. |
| hoursOfSnow |
number (float) |
The total number of hours during this period when snow is expected. |
| ice |
The amount of ice accumulation expected during this period, in millimeters (mm) or inches (in) depending on the unit specified in the request. |
|
| iceProbability |
integer (int32) |
The probability of ice formation during this period, expressed as a percentage from 0 to 100, where 0 means no chance of ice and 100 means icy conditions are certain. |
| iconCode |
Numeric value representing an image that corresponds to the
forecasted weather condition for this period, described by the
|
|
| iconPhrase |
string |
A short phrase that describes the icon, returned in the language specified in the request. For example, Sunny. |
| localSource |
Information about the local weather data provider whose icon code and weather code were used for this period, when one was selected. |
|
| longPhrase |
string |
A longer, more descriptive phrase for this period, returned in the language specified in the request. Azure Maps tries to keep this phrase under 100 characters, but some languages or weather events may produce a longer string. |
| precipitationIntensity |
string |
A short qualitative description of the precipitation intensity for
this period - for example, Light, Moderate, or Heavy.
Returned in the language specified in the request, and only when
|
| precipitationProbability |
integer (int32) |
The probability of any precipitation during this period, expressed as a percentage from 0 to 100, where 0 means no chance of precipitation and 100 means precipitation is certain. |
| precipitationType |
The dominant type of precipitation expected during this period -
one of Rain, Snow, Ice, or Mix. Returned only when
|
|
| rain |
The amount of rainfall expected during this period, in millimeters (mm) or inches (in) depending on the unit specified in the request. |
|
| rainProbability |
integer (int32) |
The probability of rain during this period, expressed as a percentage from 0 to 100, where 0 means no chance of rain and 100 means rain is certain. |
| shortPhrase |
string |
A short phrase that describes the forecast for this period, returned in the language specified in the request. Azure Maps tries to keep this phrase under 30 characters, but some languages or weather events may produce a longer string. |
| snow |
The amount of snow accumulation expected during this period, in centimeters (cm) or inches (in) depending on the unit specified in the request. |
|
| snowProbability |
integer (int32) |
The probability of snow during this period, expressed as a percentage from 0 to 100, where 0 means no chance of snow and 100 means snow is certain. |
| thunderstormProbability |
integer (int32) |
The probability of a thunderstorm during this period, expressed as a percentage from 0 to 100, where 0 means no chance of a thunderstorm and 100 means a thunderstorm is certain. |
| totalLiquid |
The total amount of liquid precipitation (such as rain, plus the liquid equivalent of any snow or ice) expected during this period, in millimeters (mm) or inches (in) depending on the unit specified in the request. |
|
| wind |
The forecasted wind speed and direction for this period. Wind speed is in kilometers per hour (km/h) or miles per hour (mph) depending on the unit specified in the request. Wind direction is measured in azimuth degrees, from 0° (true North) to 359°, moving clockwise - east is 90°, south is 180°, west is 270°. |
|
| windGust |
The expected maximum short-burst wind speed and direction during
this period. Wind gusts are sudden, brief increases in wind speed
that matter for activities such as aviation, sailing, and kite
flying. Speed is in kilometers per hour (km/h) or miles per hour
(mph) depending on the unit specified in the request, and direction
uses the same azimuth convention as |
DailyForecastResult
The response returned by the Get Daily Forecast operation, providing a
day-by-day weather forecast for a specified location. Includes a top-level
summary describing the dominant conditions and severity for the requested
window, plus a forecasts array with one DailyForecast entry per day.
The number of entries matches the requested duration
(1, 5, 10, 15, 25, or 45 days; 25 and 45 require an S1 SKU).
| Name | Type | Description |
|---|---|---|
| forecasts |
The per-day forecasts, in chronological order with one entry per day
in the requested |
|
| summary |
A high-level summary of the dominant weather conditions across the requested forecast window. The summary may cover only part of the window
|
DailyForecastSummary
A high-level summary of the dominant weather conditions across part or
all of the requested daily-forecast window. The summarized window can be
narrower than the full request - for example, when significant weather
(such as a storm system) is expected during only a portion of the
period - and is delimited by startDate and endDate. The conditions
themselves are described both as a free-form phrase, a one or
two-word category label, and a numeric severity rating.
| Name | Type | Description |
|---|---|---|
| category |
string |
A one or two-word label categorizing the dominant weather conditions for the summarized window - for example, Sunny, Partly Cloudy, Rain, or Snow. |
| endDate |
string (date-time) |
The end of the window covered by this summary, in RFC 3339 format - for example, 2019-10-29T07:00:00-08:00. May be earlier than the end of the requested forecast window if the summarized event ends before it. |
| phrase |
string |
A brief, free-form textual summary of the dominant weather conditions for the summarized window, returned in the language specified in the request. For example, Expect showers Tuesday through Thursday. |
| severity |
integer (int32) |
A numeric severity rating for the summarized weather event. Lower numbers (excluding 0) indicate higher severity:
|
| startDate |
string (date-time) |
The start of the window covered by this summary, in RFC 3339 format - for example, 2019-10-27T19:39:57-08:00. May be later than the start of the requested forecast window if the summarized event begins partway through it. |
DegreeDaySummary
Heating and cooling degree-day totals for a single day, used to estimate
the energy demand for heating or cooling a building. Each value is the
number of degrees by which the day's mean temperature differs from the
65°F (18°C) baseline, in the temperature unit specified in the
request - degrees below the baseline contribute to heating, degrees
above it contribute to cooling.
| Name | Type | Description |
|---|---|---|
| cooling |
Cooling Degree Days (CDD) - the number of degrees the day's mean temperature rises above the 65°F (18°C) baseline. Higher values indicate greater cooling demand. Reported in degrees Celsius (°C) or Fahrenheit (°F) depending on the unit specified in the request. |
|
| heating |
Heating Degree Days (HDD) - the number of degrees the day's mean temperature falls below the 65°F (18°C) baseline. Higher values indicate greater heating demand. Reported in degrees Celsius (°C) or Fahrenheit (°F) depending on the unit specified in the request. |
ErrorAdditionalInfo
The resource management error additional info.
| Name | Type | Description |
|---|---|---|
| info |
maps.weather.getdailyforecast |
The additional info. |
| type |
string |
The additional info type. |
ErrorDetail
The error detail.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
IconCode
The numeric weather-condition code that identifies which icon to display.
Each value in this enumeration corresponds to an Azure Maps weather icon
(such as Sunny, Cloudy, or Thunderstorms) and pairs with a human-readable
iconPhrase returned alongside it. The same code can appear in current,
hourly, daily, quarter-day, and minute-by-minute responses, allowing
applications to render a consistent icon set across all weather services.
For the complete list of codes, the icons they map to, and example imagery, see Weather services in Azure Maps.
| Value | Description |
|---|---|
| 1 |
Sunny |
| 2 |
Mostly Sunny |
| 3 |
Partly Sunny |
| 4 |
Intermittent Clouds |
| 5 |
Hazy Sunshine |
| 6 |
Mostly Cloudy |
| 7 |
Cloudy |
| 8 |
Dreary (Overcast) |
| 11 |
Fog |
| 12 |
Showers |
| 13 |
Mostly Cloudy with Showers |
| 14 |
Partly Sunny with Showers |
| 15 |
Thunderstorms |
| 16 |
Mostly Cloudy with Thunderstorms |
| 17 |
Partly Sunny with Thunderstorms |
| 18 |
Rain |
| 19 |
Flurries |
| 20 |
Mostly Cloudy with Flurries |
| 21 |
Partly Sunny with Flurries |
| 22 |
Snow |
| 23 |
Mostly Cloudy with Snow |
| 24 |
Ice |
| 25 |
Sleet |
| 26 |
Freezing Rain |
| 29 |
Rain and Snow |
| 30 |
Hot |
| 31 |
Cold |
| 32 |
Windy |
| 33 |
Clear |
| 34 |
Mostly Clear |
| 35 |
Partly Cloudy |
| 36 |
Intermittent Clouds |
| 37 |
Hazy Moonlight |
| 38 |
Mostly Cloudy |
| 39 |
Partly Cloudy with Showers |
| 40 |
Mostly Cloudy with Showers |
| 41 |
Partly Cloudy with Thunderstorms |
| 42 |
Mostly Cloudy with Thunderstorms |
| 43 |
Mostly Cloudy with Flurries |
| 44 |
Mostly Cloudy with Snow |
JsonFormat
Desired format of the response. Only json format is supported.
| Value | Description |
|---|---|
| json |
LocalSource
Information about a local weather data provider used to source the
forecast on DailyForecastDetail.localSource. Identifies the provider
(id, name) and exposes the provider's native weatherCode so that
applications can render the provider's own icon set instead of the
default Azure Maps icons.
| Name | Type | Description |
|---|---|---|
| id |
integer (int32) |
A numeric identifier that uniquely identifies the local data provider. |
| name |
string |
The name of the local data provider, returned in the language specified in the request when available; otherwise returned in English or the language in which the provider supplied it. |
| weatherCode |
string |
The provider-native weather code for this forecast, suitable for
mapping to the provider's own icon set instead of the default Azure
Maps |
PrecipitationType
Specifies the type of precipitation. Valid values are Rain, Snow, Ice, or Mix. This property is included in the response when dBZ is greater than zero.
| Value | Description |
|---|---|
| Ice |
Ice |
| Mix |
Mix |
| Rain |
Rain |
| Snow |
Snow |
UnitType
An integer value associated with the type of unit being displayed. For example, 17 for Celsius, 18 for Fahrenheit. Can be used for unit translation. For more information, see Weather services in Azure Maps.
| Value | Description |
|---|---|
| 0 |
feet |
| 1 |
inches |
| 2 |
miles |
| 3 |
millimeter |
| 4 |
centimeter |
| 5 |
meter |
| 6 |
kilometer |
| 7 |
kilometersPerHour |
| 8 |
knots |
| 9 |
milesPerHour |
| 10 |
metersPerSecond |
| 11 |
hectoPascals |
| 12 |
inchesOfMercury |
| 13 |
kiloPascals |
| 14 |
millibars |
| 15 |
millimetersOfMercury |
| 16 |
poundsPerSquareInch |
| 17 |
Celsius |
| 18 |
Fahrenheit |
| 19 |
kelvin |
| 20 |
percent |
| 21 |
float |
| 22 |
integer |
| 31 |
MicrogramsPerCubicMeterOfAir |
WeatherDataUnit
Specifies whether to return data in metric or imperial units, with metric as the default. For example:
- Metric: millimeter (mm), meter (m), kilometer (km), Celsius (C)
- Imperial: inch (in), foot (ft), mile (mi), Fahrenheit (F)
| Value | Description |
|---|---|
| imperial |
Return data using imperial units such as Fahrenheit (F) for temperature and miles (mi) for distance. |
| metric |
Return data using metric units such as Celsius (C) for temperature and kilometer (km) for distance. |
WeatherValue
Values for weather-related metrics such as temperature, dew point, and wind speed, presented in either metric or imperial units, as specified in the unit URI parameter. For more information, see Unit types in the article Weather services in Azure Maps.
| Name | Type | Description |
|---|---|---|
| unit |
string |
The unit of measurement used in the return value, such as "C" for Celsius, "F" for Fahrenheit. |
| unitType |
An integer representing the type of unit. For example, 0 for feet, 1 for inches, 2 for miles. For a complete list, see Unit types in the article Weather services in Azure Maps. |
|
| value |
number (float) |
The measured value expressed in the specified unit. |
WeatherValueRange
Provides the highest and lowest forecasted temperatures for the specified timeframe, measured in degrees Celsius (°C) or Fahrenheit (°F), based on the unit specified in the request.
| Name | Type | Description |
|---|---|---|
| maximum |
Provides the maximum temperature for the specified timeframe, measured in degrees Celsius (°C) or Fahrenheit (°F), based on the unit specified in the request. |
|
| minimum |
Provides the minimum temperature for the specified timeframe, measured in degrees Celsius (°C) or Fahrenheit (°F), based on the unit specified in the request. |
WindDetails
Provides the forecasted wind speed, measured in units such as kilometers per hour (km/h) or miles per hour (mph), depending on the unit specified in the request. Also indicates the wind direction measured in azimuth degrees, starting at true North and moving clockwise. North corresponds to 0°, east to 90°, south to 180°, and west to 270°. Possible values range from 0° to 359°.
| Name | Type | Description |
|---|---|---|
| direction |
Wind direction is measured in azimuth degrees, starting at true North (0°) and moving clockwise. East corresponds to 90°, south to 180°, and west to 270°. Possible values range from 0° to 359°. This property returns an integer representing the wind direction. |
|
| speed |
The expected wind speed, measured in kilometers per hour (km/h) or miles per hour (mph), depending on the unit specified in the request. |
WindDirection
Provides details about wind direction, including the direction in azimuth degrees and a localized abbreviation of the wind direction.
| Name | Type | Description |
|---|---|---|
| degrees |
integer (int32) |
Wind direction is measured in azimuth degrees, starting at true North and moving clockwise. North corresponds to 0 degrees, east to 90 degrees, south to 180 degrees, and west to 270 degrees. Possible values range from 0 to 359 degrees. |
| localizedDescription |
string |
A localized abbreviation of the wind direction, returned in the language
specified in the request. For example, |