v2

latestSwagger 2.02026-07-131892241.6 KB

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

The Get Tropical Storm Search API is an HTTP GET request that returns a list of government-issued tropical storms by year, basin ID, and government ID. Information about the tropical storms includes, government ID, basin ID, status, year, name and if it is subtropical.

get/weather/tropical/storms/{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'

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

Government storm Id

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.