Active government-issued storms by basin and government Id
Returns an active government-issued tropical cyclone for a specific basin and government id.
A tropical cyclone is identified as active if no updates are received from the government provider for 24 hours.
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
basin
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
format
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
year
integer · int64 · requiredThe year of origination.
basinId
string · minLength: 1 · requiredBasin identifier (AL, EP, SI, NI, CP, NP, SP).
depressionNumber
integer · int32 · requiredGovernment depression number. May be NULL.
name
string · minLength: 1 · requiredThe name of the depression.
isActive
boolean · requiredA boolean flag indicating if the storm has been updated recently.
isSubtropical
boolean · requiredA boolean flag indicating when the depression is classified as a subtropical cyclone.
isRetired
booleanA boolean flag indicating if the storm name had been retired and false if it has not been retired.
govId
integer | null · int32The unique depression number associated with a tropical cyclone. Equivalent to depressionId.
accuId
integer | null · int32AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed.
atcfId
integer | null · int32ATCF storm ID. May be NULL. If NULL, this parameter will not be displayed.
hurdatId
integer | null · int32Hurdat (hurricane database) storm ID. May be NULL. If NULL, this parameter will not be displayed.
eventKey
string | nullA unique identifier in the format BBDDYYYY where BB is the basin code, DD is the depression number, and YYYY is the year.
govBaseLink
string | nullLink to the specific government storm URL. May be NULL. If NULL, this parameter will not be displayed.
accuBaseLink
string | nullLink to the specific AccuWeather storm URL. May be NULL. If NULL, this parameter will not be displayed.
atcfBaseLink
string | nullLink to the specific ATCF storm URL. May be NULL. If NULL, this parameter will not be displayed.
Active government-issued storms
Returns all active government-issued tropical cyclones.
A tropical cyclone is identified as active if no updates are received from the government provider for 24 hours.
query Parameters
format
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
year
integer · int64 · requiredThe year of origination.
basinId
string · minLength: 1 · requiredBasin identifier (AL, EP, SI, NI, CP, NP, SP).
depressionNumber
integer · int32 · requiredGovernment depression number. May be NULL.
name
string · minLength: 1 · requiredThe name of the depression.
isActive
boolean · requiredA boolean flag indicating if the storm has been updated recently.
isSubtropical
boolean · requiredA boolean flag indicating when the depression is classified as a subtropical cyclone.
isRetired
booleanA boolean flag indicating if the storm name had been retired and false if it has not been retired.
govId
integer | null · int32The unique depression number associated with a tropical cyclone. Equivalent to depressionId.
accuId
integer | null · int32AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed.
atcfId
integer | null · int32ATCF storm ID. May be NULL. If NULL, this parameter will not be displayed.
hurdatId
integer | null · int32Hurdat (hurricane database) storm ID. May be NULL. If NULL, this parameter will not be displayed.
eventKey
string | nullA unique identifier in the format BBDDYYYY where BB is the basin code, DD is the depression number, and YYYY is the year.
govBaseLink
string | nullLink to the specific government storm URL. May be NULL. If NULL, this parameter will not be displayed.
accuBaseLink
string | nullLink to the specific AccuWeather storm URL. May be NULL. If NULL, this parameter will not be displayed.
atcfBaseLink
string | nullLink to the specific ATCF storm URL. May be NULL. If NULL, this parameter will not be displayed.
Active government-issued storms by basin
Returns all active government-issued tropical cyclones for a specific basin.
A tropical cyclone is identified as active if no updates are received from the government provider for 24 hours.
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
basin
string · requiredA unique ID that designates a specific basin (NP, CP, SP, EP, NI, SI, AL).
Example: AL
query Parameters
format
stringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorization
string · requiredThe
Authorization
header is used to authenticate using your API key. Format isBearer YOUR_API_KEY
.
Responses
OK
year
integer · int64 · requiredThe year of origination.
basinId
string · minLength: 1 · requiredBasin identifier (AL, EP, SI, NI, CP, NP, SP).
depressionNumber
integer · int32 · requiredGovernment depression number. May be NULL.
name
string · minLength: 1 · requiredThe name of the depression.
isActive
boolean · requiredA boolean flag indicating if the storm has been updated recently.
isSubtropical
boolean · requiredA boolean flag indicating when the depression is classified as a subtropical cyclone.
isRetired
booleanA boolean flag indicating if the storm name had been retired and false if it has not been retired.
govId
integer | null · int32The unique depression number associated with a tropical cyclone. Equivalent to depressionId.
accuId
integer | null · int32AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed.
atcfId
integer | null · int32ATCF storm ID. May be NULL. If NULL, this parameter will not be displayed.
hurdatId
integer | null · int32Hurdat (hurricane database) storm ID. May be NULL. If NULL, this parameter will not be displayed.
eventKey
string | nullA unique identifier in the format BBDDYYYY where BB is the basin code, DD is the depression number, and YYYY is the year.
govBaseLink
string | nullLink to the specific government storm URL. May be NULL. If NULL, this parameter will not be displayed.
accuBaseLink
string | nullLink to the specific AccuWeather storm URL. May be NULL. If NULL, this parameter will not be displayed.
atcfBaseLink
string | nullLink to the specific ATCF storm URL. May be NULL. If NULL, this parameter will not be displayed.