Weather - Get Tropical Storm Forecast

Reference

Service:: Maps

API Version:: 1.1

Use to get a list of tropical storms forecasted by national weather forecasting agencies.

The Get Tropical Storm Forecasts API is an HTTP GET request that returns individual government-issued tropical storm forecasts. Information about the forecasted tropical storms includes, location, status, date the forecast was created, window, wind speed and wind radii.

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}

With optional parameters:

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}&unit={unit}&details={details}&radiiGeometry={radiiGeometry}&windowGeometry={windowGeometry}

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.
basinId	query	True	basinId	Basin identifier
govId	query	True	integer int32	Government storm Id
year	query	True	integer int32	Year of the cyclone(s)
details	query		boolean	When true, wind radii summary data is included in the response
radiiGeometry	query		boolean	When true, wind radii summary data and geoJSON details are included in the response
unit	query		WeatherDataUnit	Specifies to return the data in either metric units or imperial units. Default value is metric.
windowGeometry	query		boolean	When true, window geometry data (geoJSON) is included in the response

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	StormForecastResult	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.

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	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

Get Tropical Storm Forecasts

Sample request

HTTP

GET https://atlas.microsoft.com/weather/tropical/storms/forecasts/json?api-version=1.1&year=2021&basinId=NP&govId=2

Sample response

Status code:: 200

{
  "results": [
    {
      "dateTime": "2021-04-25T06:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 22,
        "longitude": 137.8
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 22.56387,
          "longitude": 137.739517
        },
        "right": {
          "latitude": 21.4361,
          "longitude": 137.860489
        }
      }
    },
    {
      "dateTime": "2021-04-25T18:00:00+00:00",
      "initializedDateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 23.7,
        "longitude": 142.4
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "status": "Tropical Storm",
      "window": {
        "left": {
          "latitude": 24.45283,
          "longitude": 142.055313
        },
        "right": {
          "latitude": 22.94641,
          "longitude": 142.744675
        }
      }
    }
  ]
}

Definitions

Name	Description
basinId	Basin identifier
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GeoJsonGeometry	A valid `GeoJSON` geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to RFC 7946 for details.
GeoJsonGeometryCollection	A valid `GeoJSON GeometryCollection` object type. Please refer to RFC 7946 for details.
GeoJsonLineString	A valid `GeoJSON LineString` geometry type. Please refer to RFC 7946 for details.
GeoJsonMultiLineString	A valid `GeoJSON MultiLineString` geometry type. Please refer to RFC 7946 for details.
GeoJsonMultiPoint	A valid `GeoJSON MultiPoint` geometry type. Please refer to RFC 7946 for details.
GeoJsonMultiPolygon	A valid `GeoJSON MultiPolygon` object type. Please refer to RFC 7946 for details.
GeoJsonPoint	A valid `GeoJSON Point` geometry type. Please refer to RFC 7946 for details.
GeoJsonPolygon	A valid `GeoJSON Polygon` geometry type. Please refer to RFC 7946 for details.
JsonFormat	Desired format of the response. Only `json` format is supported.
LatLongPair	A location represented as a latitude and longitude.
RadiusSector	Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.
StormForecast	Government-issued storm forecast
StormForecastResult	The list of Government-issued forecasts
StormWindRadiiSummary	Displayed when details=true or radiiGeometry=true in the request.
UnitType	Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to Weather services in Azure Maps for details.
WeatherDataUnit	Specifies to return the data in either metric units or imperial units. Default value is metric.
WeatherUnit	Specific value of a given unit related to weather.
WeatherWindow	Forecast window for the storm

basinId

Basin identifier

Name	Type	Description
AL	string	Atlantic
CP	string	Central Pacific
EP	string	Eastern Pacific
NI	string	North Indian Ocean
NP	string	Northwest Pacific
SI	string	Southwest Indian Ocean
SP	string	South Pacific

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.

GeoJsonGeometry

A valid GeoJSON geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to RFC 7946 for details.

Name	Type	Description
type	GeoJsonObjectType	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonGeometryCollection

A valid GeoJSON GeometryCollection object type. Please refer to RFC 7946 for details.

Name	Type	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contains a list of valid `GeoJSON` geometry objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude).
type	string: GeometryCollection	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonLineString

A valid GeoJSON LineString geometry type. Please refer to RFC 7946 for details.

Name	Type	Description
coordinates	number[]	Coordinates for the `GeoJson LineString` geometry.
type	string: LineString	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiLineString

A valid GeoJSON MultiLineString geometry type. Please refer to RFC 7946 for details.

Name	Type	Description
coordinates	number[]	Coordinates for the `GeoJson MultiLineString` geometry.
type	string: MultiLineString	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiPoint

A valid GeoJSON MultiPoint geometry type. Please refer to RFC 7946 for details.

Name	Type	Description
coordinates	number[]	Coordinates for the `GeoJson MultiPoint` geometry.
type	string: MultiPoint	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiPolygon

A valid GeoJSON MultiPolygon object type. Please refer to RFC 7946 for details.

Name	Type	Description
coordinates	number[]	Contains a list of valid `GeoJSON Polygon` objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude).
type	string: MultiPolygon	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonPoint

A valid GeoJSON Point geometry type. Please refer to RFC 7946 for details.

Name	Type	Description
coordinates	number[]	A `Position` is an array of numbers with two or more elements. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.
type	string: Point	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonPolygon

A valid GeoJSON Polygon geometry type. Please refer to RFC 7946 for details.

Name	Type	Description
coordinates	number[]	Coordinates for the `GeoJson Polygon` geometry type.
type	string: Polygon	Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

JsonFormat

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

Name	Type	Description
json	string	The JavaScript Object Notation Data Interchange Format

LatLongPair

A location represented as a latitude and longitude.

Name	Type	Description
latitude	number	Latitude property
longitude	number	Longitude property

RadiusSector

Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.

Name	Type	Description
beginBearing	number	Bearing, in degrees, of the beginning of the quadrant.
endBearing	number	Bearing, in degrees, of the end of the quadrant.
range	number	The radius of the quadrant, in nautical miles.

StormForecast

Government-issued storm forecast

Name	Type	Description
dateTime	string	Datetime the forecast is valid, displayed in ISO8601 format.
initializedDateTime	string	Datetime the forecast was created, displayed in ISO8601 format.
location	LatLongPair	Coordinates of the storm
maxWindGust	WeatherUnit	Maximum wind gust speed associated with the storm. May be NULL.
status	string	Possible status values include: Cyclonic storm Deep depression Depression Extremely severe cyclonic storm Hurricane category (1-5) Intense tropical cyclone Moderate tropical storm Post-tropical cyclone Potential tropical cyclone Severe cyclonic storm Severe tropical storm Subtropical Super cyclonic storm Tropical cyclone Tropical cyclone category (1-5) Tropical depression Tropical disturbance Tropical storm Typhoon Very intense tropical cyclone Very severe cyclonic storm Very strong typhoon Violent typhoon
sustainedWind	WeatherUnit	Maximum sustained wind speed associated with the storm. May be NULL.
windRadiiSummary	StormWindRadiiSummary[]	Displayed when details=true or radiiGeometry=true in the request.
window	WeatherWindow	Contains information about the forecast window for the storm during the specified time period (not the entire cone). If windowGeometry=true in the request, this object will include geoJSON details for window geometry.

StormForecastResult

The list of Government-issued forecasts

Name	Type	Description
nextLink	string	The is the link to the next page of the features returned. If it's the last page, no this field.
results	StormForecast[]	The list of Government-issued forecasts

StormWindRadiiSummary

Displayed when details=true or radiiGeometry=true in the request.

Name	Type	Description
dateTime	string	DateTime for which the wind radii summary data is valid, displayed in ISO8601 format.
radiiGeometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	GeoJSON object. Displayed when radiiGeometry=true in request. Describes the outline of the wind radius quadrants.
radiusSectorData	RadiusSector[]	Contains the information needed to plot wind radius quadrants. Bearing 0–90 = NE quadrant; 90–180 = SE quadrant; 180–270 = SW quadrant; 270–360 = NW quadrant.
windSpeed	WeatherUnit	Wind speed associated with the radiusSectorData.

UnitType

Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to Weather services in Azure Maps for details.

Name	Type	Description
0	Integer
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
3	Integer
31	Integer
4	Integer
5	Integer
6	Integer
7	Integer
8	Integer
9	Integer

WeatherDataUnit

Specifies to return the data in either metric units or imperial units. Default value is metric.

Name	Type	Description
imperial	string	Return data in imperial units. Some example units of imperial system are Fahrenheit and mile.
metric	string	Return data in metric units. Some example units of metric system are Celsius and kilometer.

WeatherUnit

Specific value of a given unit related to weather.

Name	Type	Description
unit	string	Type of unit for the returned value.
unitType	UnitType	Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to Weather services in Azure Maps for details.
value	number	Rounded value.

WeatherWindow

Forecast window for the storm

Name	Type	Description
beginDateTime	string	DateTime of the beginning of the window of movement, displayed in ISO8601 format.
beginStatus	string	Storm status at the beginning of the window.
endDateTime	string	DateTime of the end of the window of movement, displayed in ISO8601 format.
endStatus	string	Storm status at the end of the window.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Displayed when windowGeometry=true in request. GeoJSON object containing coordinates describing the window of movement during the specified timeframe.
left	LatLongPair	Location of the point on the left side of the window at the time of the timeframe.
right	LatLongPair	Location of the point on the right side of the window at the end of the timeframe.

Share via