Weather - Get Tropical Storm Locations

Get Tropical Storm Locations

Applies to: see pricing tiers.

Get location of individual government-issued tropical storms. Information about the tropical storms includes, location coordinates, geometry, basin ID, date, wind details and wind radii.

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

URI Parameters

Name In Required Type Description
format
path True

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

api-version
query True
  • string

Version number of Azure Maps API.

basinId
query True

Basin identifier

govId
query True
  • integer
int32

Government storm Id

year
query True
  • integer
int32

Year of the cyclone(s)

current
query
  • boolean

When true, return the current storm location

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

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

Specifies which account is intended for usage in conjunction with the Azure AD 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 Azure AD security in Azure Maps see the following articles for guidance.

Responses

Name Type Description
200 OK

OK

Other Status Codes

An unexpected error occurred.

Security

AADToken

These are the Azure Active Directory OAuth2 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 Azure Active directory 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.

  • Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

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 Current Location
Get Tropical Storm Locations

Get Tropical Storm Current Location

Sample Request

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

Sample Response

{
  "results": [
    {
      "dateTime": "2021-04-24T18:00:00+00:00",
      "location": {
        "latitude": 21.7,
        "longitude": 134.1
      },
      "maxWindGust": {
        "value": 92.6,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 115,
          "localizedDescription": "ESE"
        },
        "speed": {
          "value": 22.2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Storm"
    }
  ]
}

Get Tropical Storm Locations

Sample Request

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

Sample Response

{
  "results": [
    {
      "dateTime": "2021-02-22T00:00:00+00:00",
      "location": {
        "latitude": 10.4,
        "longitude": 125.7
      },
      "maxWindGust": {
        "value": 64.8,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 46.3,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 305,
          "localizedDescription": "NW"
        },
        "speed": {
          "value": 9.3,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Depression"
    },
    {
      "dateTime": "2021-02-21T18:00:00+00:00",
      "location": {
        "latitude": 10.2,
        "longitude": 125.9
      },
      "maxWindGust": {
        "value": 64.8,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 46.3,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 300,
          "localizedDescription": "WNW"
        },
        "speed": {
          "value": 22.2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Depression"
    },
    {
      "dateTime": "2021-02-21T12:00:00+00:00",
      "location": {
        "latitude": 10.3,
        "longitude": 125.8
      },
      "maxWindGust": {
        "value": 83.3,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 64.8,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 300,
          "localizedDescription": "WNW"
        },
        "speed": {
          "value": 42.6,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Storm"
    },
    {
      "dateTime": "2021-02-19T06:00:00+00:00",
      "location": {
        "latitude": 7.2,
        "longitude": 129.8
      },
      "maxWindGust": {
        "value": 101.9,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 83.3,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 270,
          "localizedDescription": "W"
        },
        "speed": {
          "value": 18.5,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Storm"
    },
    {
      "dateTime": "2021-02-19T00:00:00+00:00",
      "location": {
        "latitude": 7.2,
        "longitude": 131.2
      },
      "maxWindGust": {
        "value": 101.9,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 83.3,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 270,
          "localizedDescription": "W"
        },
        "speed": {
          "value": 7.4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Storm"
    },
    {
      "dateTime": "2021-02-18T18:00:00+00:00",
      "location": {
        "latitude": 7.2,
        "longitude": 131.7
      },
      "maxWindGust": {
        "value": 83.3,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 64.8,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 270,
          "localizedDescription": "W"
        },
        "speed": {
          "value": 3.7,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Storm"
    },
    {
      "dateTime": "2021-02-18T12:00:00+00:00",
      "location": {
        "latitude": 7.3,
        "longitude": 131.8
      },
      "maxWindGust": {
        "value": 83.3,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 64.8,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 270,
          "localizedDescription": "W"
        },
        "speed": {
          "value": 5.6,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Storm"
    },
    {
      "dateTime": "2021-02-18T06:00:00+00:00",
      "location": {
        "latitude": 7.3,
        "longitude": 132.1
      },
      "maxWindGust": {
        "value": 83.3,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 64.8,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 305,
          "localizedDescription": "NW"
        },
        "speed": {
          "value": 9.3,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Storm"
    },
    {
      "dateTime": "2021-02-18T00:00:00+00:00",
      "location": {
        "latitude": 7,
        "longitude": 132.6
      },
      "maxWindGust": {
        "value": 83.3,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 64.8,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 290,
          "localizedDescription": "WNW"
        },
        "speed": {
          "value": 5.6,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Storm"
    },
    {
      "dateTime": "2021-02-17T18:00:00+00:00",
      "location": {
        "latitude": 7,
        "longitude": 132.7
      },
      "maxWindGust": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 55.6,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 290,
          "localizedDescription": "WNW"
        },
        "speed": {
          "value": 9.3,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Depression"
    },
    {
      "dateTime": "2021-02-17T12:00:00+00:00",
      "location": {
        "latitude": 6.8,
        "longitude": 132.4
      },
      "maxWindGust": {
        "value": 74.1,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 55.6,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 285,
          "localizedDescription": "WNW"
        },
        "speed": {
          "value": 13,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Depression"
    },
    {
      "dateTime": "2021-02-17T06:00:00+00:00",
      "location": {
        "latitude": 6.6,
        "longitude": 133.1
      },
      "maxWindGust": {
        "value": 64.8,
        "unit": "km/h",
        "unitType": 7
      },
      "sustainedWind": {
        "value": 46.3,
        "unit": "km/h",
        "unitType": 7
      },
      "movement": {
        "direction": {
          "degrees": 270,
          "localizedDescription": "W"
        },
        "speed": {
          "value": 22.2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "status": "Tropical Depression"
    }
  ]
}

Definitions

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.

StormLocation

Location for an individual Government-issued storm

StormLocationsResult

Locations for an individual government-issued storm

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 Service Concepts 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.

WindDetails

Wind details being returned including speed and direction.

WindDirection

Wind direction

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

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

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[]:

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
  • array[]

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
  • array[]

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
  • array[]

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
  • array[]

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
  • array[]

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.

StormLocation

Location for an individual Government-issued storm

Name Type Description
dateTime
  • string

Datetime the forecast is valid, displayed in ISO8601 format.

hasTropicalPotential
  • boolean

True when storm may develop into a Tropical System.

isPostTropical
  • boolean

True when the storm is weakening away, and will no longer become a tropical system.

isSubtropical
  • boolean

True when the depression is classified as a subtropical cyclone.

location

Coordinates of the storm

maxWindGust

Maximum wind gust speed associated with the storm. May be NULL.

minimumPressure

Minimum pressure associated with the storm. May be NULL.

movement

The storm movement information.

status
  • string

Storm status, in English.

sustainedWind

Maximum sustained wind speed associated with the storm. May be NULL.

windRadiiSummary

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

StormLocationsResult

Locations for an individual government-issued storm

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

Locations for an individual government-issued storm

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:

GeoJSON object. Displayed when radiiGeometry=true in request. Describes the outline of the wind radius quadrants.

radiusSectorData

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

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

Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to Weather Service Concepts for details.

value
  • number

Rounded value.

WindDetails

Wind details being returned including speed and direction.

Name Type Description
direction

Wind direction

speed

Speed of the wind in specified unit.

WindDirection

Wind direction

Name Type Description
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.