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
year
integer · int32 · requiredA numerical value indicating the four digit year.
Example: 2024basin
string · requiredA unique ID that designates a specific basin (NP, CP, SP, EP, NI, SI, AL).
Example: ALgovId
integer · int32 · requiredA numerical ID that matches the depression ID.
Example: 2
query Parameters
includeLandmarks
booleanA boolean value that specifies whether or not to include landmark-specific information.
Default: truedetails
booleanA boolean value that specifies whether or not to include extended information.
Default: falseradiiGeometry
booleanA boolean value that specifies whether or not to include wind radii summary data.
Default: falseformat
stringA string value that specifies what type of format to provide the response.
Default: jsonlanguage
stringA string that indicates the language in which to return the response. More information can be found here.
Default: en-us
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
status
string · 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.
localizedStatus
string · minLength: 1 · requiredThe storm status in the requested language.
validDateTime
string · date-timeThe date and time at which the forecast is valid, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).
validEpochDateTime
integer · 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.
isSubtropical
boolean | nullA boolean flag indicating when the depression is classified as a subtropical cyclone.
name
string | nullThe name of the depression.
hasTropicalPotential
booleanA boolean value determining if the storm could be tropical.
isPostTropical
booleanA boolean value describing if the storm is post tropical.
landmarkReferences
array | nullA list of objects containing details of surrounding landmarks.
windRadiiSummary
array | 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
year
integer · int32 · requiredA numerical value indicating the four digit year.
Example: 2024basin
string · requiredA unique ID that designates a specific basin (NP, CP, SP, EP, NI, SI, AL).
Example: ALgovId
integer · int32 · requiredA numerical ID that matches the depression ID.
Example: 2
query Parameters
details
booleanA boolean value that specifies whether or not to include extended information.
Default: falseincludeLandmarks
booleanA boolean value that specifies whether or not to include landmark-specific information.
Default: trueradiiGeometry
booleanA boolean value that specifies whether or not to include wind radii summary data.
Default: falseformat
stringA string value that specifies what type of format to provide the response.
Default: jsonlanguage
stringA string that indicates the language in which to return the response. More information can be found here.
Default: en-us
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
status
string · 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.
localizedStatus
string · minLength: 1 · requiredThe storm status in the requested language.
validDateTime
string · date-timeThe date and time at which the forecast is valid, displayed in ISO 8601 format (yyyy-mm-ddThh:mm:ss±hh:mm).
validEpochDateTime
integer · 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.
isSubtropical
boolean | nullA boolean flag indicating when the depression is classified as a subtropical cyclone.
name
string | nullThe name of the depression.
hasTropicalPotential
booleanA boolean value determining if the storm could be tropical.
isPostTropical
booleanA boolean value describing if the storm is post tropical.
landmarkReferences
array | nullA list of objects containing details of surrounding landmarks.
windRadiiSummary
array | nullA list of objects containing containing wind radii information.