Current position of government-issued storm by year, basin, and government Id
Returns current position 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
includeLandmarksbooleanA boolean value that specifies whether or not to include landmark-specific information.
Default: truedetailsbooleanA boolean value that specifies whether or not to include extended information.
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
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.
position| nullAn object containing the location details.
maxWindGust| nullAn 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.
sustainedWind| nullAn 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.
minimumPressure| nullAn object containing information about the measured air pressure at ground level with a rounded value for Inches of Mercury and Millibar. The object may be NULL.
movement| nullAn object containing information about the depression movement.
isSubtropicalboolean | nullA boolean flag indicating when the depression is classified as a subtropical cyclone.
namestring | nullThe name of the depression.
hasTropicalPotentialbooleanA boolean value determining if the storm could be tropical.
isPostTropicalbooleanA boolean value describing if the storm is post tropical.
landmarkReferencesarray | nullA list of objects containing details of surrounding landmarks.
windRadiiSummaryarray | nullA list of objects containing containing wind radii information.
Positions of government-issued storm by year, basin, and government Id
Returns all position 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: falseincludeLandmarksbooleanA boolean value that specifies whether or not to include landmark-specific information.
Default: trueradiiGeometrybooleanA 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
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.
position| nullAn object containing the location details.
maxWindGust| nullAn 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.
sustainedWind| nullAn 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.
minimumPressure| nullAn object containing information about the measured air pressure at ground level with a rounded value for Inches of Mercury and Millibar. The object may be NULL.
movement| nullAn object containing information about the depression movement.
isSubtropicalboolean | nullA boolean flag indicating when the depression is classified as a subtropical cyclone.
namestring | nullThe name of the depression.
hasTropicalPotentialbooleanA boolean value determining if the storm could be tropical.
isPostTropicalbooleanA boolean value describing if the storm is post tropical.
landmarkReferencesarray | nullA list of objects containing details of surrounding landmarks.
windRadiiSummaryarray | nullA list of objects containing containing wind radii information.