v2

latestSwagger 2.02026-07-131892241.6 KB

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/weather/tropical/storms/forecasts/{format}

Path parameters

format'json' required

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

Query parameters

api-versionstring required

The API version to use for this operation.

yearinteger required

Year of the cyclone(s)

basinId'AL' | 'CP' | 'EP' | 'NI' | 'NP' | 'SI' | 'SP' required

The basinId enum categorizes the different ocean basins where tropical storms can originate. Each basin is assigned a unique identifier to help specify the location of the storm's origin.

govIdinteger required

Government storm Id

unit'imperial' | 'metric'

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

detailsboolean

When true, wind radii summary data is included in the response

radiiGeometryboolean

When true, wind radii summary data and geoJSON details are included in the response

windowGeometryboolean

When true, window geometry data (geoJSON) is included in the response

Headers

x-ms-client-idstring

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.

Response

The request has succeeded.

nextLinkstring

Contains the URL to fetch the next page of results if the response is paginated. This is useful when the response is too large to be returned in a single call, allowing users to navigate through multiple pages of results.