Forecasts of government-issued storm by year, basin, and government Id
Returns forecast information for a government-issued tropical cyclone by year, basin and government id
Basins
| Name | Id |
|---|---|
| Atlantic | AL |
| Central Pacific | CP |
| Eastern Pacific | EP |
| North Indian Ocean | NI |
| Northwest Pacific | NP |
| South Indian Ocean | SI |
| Southwest Pacific | SP |
path Parameters
yearinteger · int32 · requiredA numerical value indicating the four digit year.
Example: 2024basinstring · requiredA unique ID that designates a specific basin (NP, CP, SP, EP, NI, SI, AL).
Example: ALgovIdinteger · int32 · requiredA numerical ID that matches the depression ID.
Example: 2
query Parameters
detailsbooleanA boolean value that specifies whether or not to include extended information.
Default: falsewindowGeometrybooleanA boolean value that specifies whether or not to include window geometry data.
Default: falseradiiGeometrybooleanA boolean value that specifies whether or not to include wind radii summary data.
Default: falseformatstringA string value that specifies what type of format to provide the response.
Default: jsonlanguagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-us
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
positionrequiredAn object containing the location details.
maxWindGustrequiredAn object containing information about the maximum short-burst wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.
sustainedWindrequiredAn object containing information about the maximum sustained wind speed with a rounded value for Miles per hour and Kilometer per hour. The object may be NULL.
statusstring · minLength: 1 · requiredStorm status, in English, including category values of hurricanes and tropical cyclones. Some examples are: Hurricane – Category 3, Tropical Depression, Tropical Cyclone - Category 1, Depression, and Typhoon.
localizedStatusstring · minLength: 1 · requiredThe storm status in the requested language.
validDateTimestring · date-timeThe date and time at which the forecast is valid, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).
validEpochDateTimeinteger · int64The date and time at which the forecast is valid, displayed as the number of seconds that have elapsed since midnight UTC/GMT on January 1, 1970.
initializedDateTimestring · date-timeDatetime the forecast was created, displayed in ISO8601 format.
epochInitializedDateTimeinteger · int64Datetime the forecast was created, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).
window| nullAn object containing 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.
windRadiiSummaryarray | nullA list of objects containing wind radii information.