Weather - Get Minute Forecast

  • Reference
Service:
Maps
API Version:
1.1

Use to get a minute-by-minute forecast for the next 120 minutes in intervals of 1, 5 and 15 minutes.

The Get Minute Forecast API is an HTTP GET request that returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in intervals of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ). For more information, see Request minute-by-minute weather forecast data.

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}
With optional parameters: 
GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

URI Parameters

Name In Required Type Description
format
 path True

JsonFormat

Desired format of the response. Only json format is supported.
api-version
 query True

string

Version number of Azure Maps API.
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".
interval
 query

integer

Specifies time interval in minutes for the returned weather forecast. Supported values are

  • 1 - Retrieve forecast for 1-minute intervals. Returned by default.
  • 5 - Retrieve forecasts for 5-minute intervals.
  • 15 - Retrieve forecasts for 15-minute intervals.
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.

Request Header

Name Required Type Description
x-ms-client-id

string

Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance.

Responses

Name Type Description
200 OK

MinuteForecastResult

OK
Other Status Codes

ErrorResponse

An unexpected error occurred.

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.

Notes

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default 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: query

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 minute-by-minute forecasts for a given location

Sample Request

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query=47.632346,-122.138874&interval=15

Sample Response

Status code:
200 
{
  "summary": {
    "briefPhrase60": "Rain ending in 25 min",
    "shortPhrase": "Rain ending in 25 min",
    "briefPhrase": "Rain ending in 25 min",
    "longPhrase": "Rain ending in 25 min",
    "iconCode": 12
  },
  "intervalSummaries": [
    {
      "startMinute": 0,
      "endMinute": 24,
      "totalMinutes": 25,
      "shortPhrase": "Rain ending in %minute_value min",
      "briefPhrase": "Rain ending in %minute_value min",
      "longPhrase": "Rain ending in %minute_value min",
      "iconCode": 12
    },
    {
      "startMinute": 25,
      "endMinute": 119,
      "totalMinutes": 95,
      "shortPhrase": "No precip for %MINUTE_VALUE min",
      "briefPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "longPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "iconCode": 7
    }
  ],
  "intervals": [
    {
      "startTime": "2019-11-14T15:18:00-08:00",
      "minute": 0,
      "dbz": 23,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 8,
        "green": 98,
        "blue": 2,
        "hex": "#086202"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:33:00-08:00",
      "minute": 15,
      "dbz": 18,
      "shortPhrase": "Light Rain",
      "threshold": "LIGHT",
      "color": {
        "red": 32,
        "green": 133,
        "blue": 9,
        "hex": "#208509"
      },
      "simplifiedColor": {
        "red": 35,
        "green": 190,
        "blue": 39,
        "hex": "#23BE27"
      },
      "precipitationType": "Rain",
      "iconCode": 12,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T15:48:00-08:00",
      "minute": 30,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:03:00-08:00",
      "minute": 45,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:18:00-08:00",
      "minute": 60,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:33:00-08:00",
      "minute": 75,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T16:48:00-08:00",
      "minute": 90,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    },
    {
      "startTime": "2019-11-14T17:03:00-08:00",
      "minute": 105,
      "dbz": 0,
      "shortPhrase": "No Precipitation",
      "iconCode": 7,
      "cloudCover": 100
    }
  ]
}

Definitions

Name Description
ColorValue
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ForecastInterval
IconCode

Numeric value representing an image that displays the iconPhrase. Please refer to Weather services in Azure Maps for details.
IntervalSummary
JsonFormat

Desired format of the response. Only json format is supported.
MinuteForecastResult
MinuteForecastSummary

Phrase summaries for the entire forecast period.
PrecipitationType

Specifies the type of precipitation ("Rain" "Snow" "Ice" or "Mix"). If dbz is zero, precipitationType is not present in the response.

ColorValue

Name Type Description
blue

integer

Blue component of the RGB value
green

integer

Green component of the RGB value.
hex

string

Hexadecimal color value.
red

integer

Red component of the RGB value.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ForecastInterval

Name Type Description
cloudCover

integer

Percent representing cloud cover.
color

ColorValue

The full spectrum color that maps to the dBZ (decibel relative to Z). If dbz is zero, color is not present in the response.
dbz

number

A unit that represents forecasted precipitation intensity.
iconCode

IconCode

Numeric value representing an image that displays the iconPhrase. Please refer to Weather services in Azure Maps for details.
minute

integer

The first minute for the interval.
precipitationType

PrecipitationType

Specifies the type of precipitation ("Rain" "Snow" "Ice" or "Mix"). If dbz is zero, precipitationType is not present in the response.
shortPhrase

string

A short phrase describing precipitation condition for the interval.
simplifiedColor

ColorValue

The band color that maps to the precipitation type and threshold. If dbz is zero, not present in the response.
startTime

string

The date and time for the start of the interval in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.
threshold

string

Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dbz is zero, not present in the response.

IconCode

Numeric value representing an image that displays the iconPhrase. Please refer to Weather services in Azure Maps for details.

Name Type Description
1

Integer

10

Integer

11

Integer

12

Integer

13

Integer

14

Integer

15

Integer

16

Integer

17

Integer

18

Integer

19

Integer

2

Integer

20

Integer

21

Integer

22

Integer

23

Integer

24

Integer

25

Integer

26

Integer

27

Integer

28

Integer

29

Integer

3

Integer

30

Integer

31

Integer

32

Integer

33

Integer

34

Integer

35

Integer

36

Integer

37

Integer

38

Integer

39

Integer

4

Integer

40

Integer

41

Integer

42

Integer

43

Integer

44

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

IntervalSummary

Name Type Description
briefPhrase

string

Brief summary phrase. Phrase length is approximately 60 characters.
endMinute

integer

The last minute to which the summary applies.
iconCode

IconCode

Numeric value representing an image that displays the iconPhrase. Please refer to Weather services in Azure Maps for details.
longPhrase

string

Long summary phrase. Phrase length is 60+ characters.
shortPhrase

string

Short summary phrase. Phrase length is approximately 25 characters.
startMinute

integer

The first minute to which the summary applies.
totalMinutes

integer

The number of minutes for which the summary applies.

JsonFormat

Desired format of the response. Only json format is supported.

Name Type Description
json

string

The JavaScript Object Notation Data Interchange Format

MinuteForecastResult

Name Type Description
intervalSummaries

IntervalSummary[]

Summary information for each interval in the forecast. The Summaries breaks down each potential interval where precipitation starts and stops.
intervals

ForecastInterval[]

Forecast data for each interval in the forecast.
summary

MinuteForecastSummary

Phrase summaries for the entire forecast period.

MinuteForecastSummary

Phrase summaries for the entire forecast period.

Name Type Description
briefPhrase

string

Summary phrase for the next 120 minutes. Phrase length is approximately 60 characters.
briefPhrase60

string

Summary phrase for the next 60 minutes. Phrase length is approximately 60 characters.
iconCode

IconCode

Numeric value representing an image that displays the iconPhrase. Please refer to Weather services in Azure Maps for details.
longPhrase

string

Long summary phrase for the next 120 minutes. Phrase length is 60+ characters.
shortPhrase

string

Short summary phrase for the next 120 minutes. Phrase length is approximately 25 characters.

PrecipitationType

Specifies the type of precipitation ("Rain" "Snow" "Ice" or "Mix"). If dbz is zero, precipitationType is not present in the response.

Name Type Description
Ice

string

Ice
Mix

string

Mix
Rain

string

Rain
Snow

string

Snow