Tropical API Parameters

 

Request parameters |  Response parameters



Tropical API query string parameters

Parameter Description Default value
api Hostname to be used only in production: api.accuweather.com N/A Required
apidev Hostname to be used only in development: apidev.accuweather.com N/A Required
apikey Unique code used to access the API N/A Required
version Current version of the API v1 Required
year Year of the cyclone(s) N/A
basinID Unique id used to identify a basin (NP, SP, NI, SI, AL, EP) N/A
depressionID Numeric id of the tropical cyclone (deprecated) N/A
governmentID Government storm ID N/A
format Format of the response JSON Optional
details When true, wind radii summary data is included in the response False Optional
radiigeometry When true, wind radii summary data and geoJSON details are included in the response False Optional
windowgeometry When true, window geometry data (geoJSON) is included in the response False Optional

Top of Page

 

 

 

Active storms response parameters

Parameter Description
year Year of origination
basinID Basin identifier (AL, EP, SI, NI, CP, NP, SP)
depressionNumber Government depression number. May be NULL.
name The name of the depression.
isActive True if the depression has been updated recently.
isSubtropical True when the depression is classified as a subtropical cyclone.
accuId AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed.
atcfId Automated Tropical Cyclone Forecasting (ATCF) storm ID. May be NULL. If NULL, this parameter will not be displayed.
govId Government storm ID. This will match the depression number.
govLink Link to the specific government storm URL.
accuLink Link to the specific AccuWeather storm URL. May be NULL. If NULL, this parameter will not be displayed.
atcfLink Link to the specific ATCF storm URL. May be NULL. If NULL, this parameter will not be displayed.

Top of Page

 

 

Storm search response parameters

Parameter Description
year Year of origination
basinID Basin identifier (AL, EP, SI, NI, CP, NP, SP)
depressionNumber Government depression number. May be NULL.
name The name of the depression.
isActive True if the depression has been updated recently.
isSubtropical True when the depression is classified as a subtropical cyclone.
accuId AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed.
atcfId ATCF storm ID. May be NULL. If NULL, this parameter will not be displayed.
govId Government storm ID. This will match the depression number.
govLink Link to the specific government storm URL.
accuLink Link to the specific AccuWeather storm URL. May be NULL. If NULL, this parameter will not be displayed.
atcfLink Link to the specific ATCF storm URL. May be NULL. If NULL, this parameter will not be displayed.

Top of Page

 

 

Forecast response parameters

Parameter Description
validDateTime Datetime the forecast is valid, displayed in ISO8601 format.
validEpochDateTime Datetime the forecast is valid, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).
initializedDateTime Datetime the forecast was created, displayed in ISO8601 format.
epochInitializedDateTime Datetime the forecast was created, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).
position
maxWindGust Maximum wind gust speed associated with the storm. May be NULL. Contains metric and imperial values.
sustainedWind Maximum sustained wind speed associated with the storm. May be NULL. Contains metric and imperial values.
status Storm status, in English.
window Contains 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. Not available for AL or EP basins.
windRadiiSummary Displayed when details=true or radiigeometry=true in the request. Not available for AL or EP basins.

Top of Page

 

 

Positions response parameters

Parameter Description
validDateTime Datetime the forecast is valid, displayed in ISO8601 format.
validEpochDateTime Datetime the forecast is valid, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).
position
maxWindGust Maximum wind gust speed associated with the storm. May be NULL. Contains metric and imperial values.
sustainedWind Maximum sustained wind speed associated with the storm. May be NULL. Contains metric and imperial values.
minimumPressure Minimum pressure associated with the storm. May be NULL. Contains metric and imperial values.
movement
status Storm status, in English.
isSubtropical True when depression is classified as a subtropical cyclone.
windRadiiSummary Displayed when details=true or radiigeometry=true in the request.
landmarkReferences

Top of Page

 

 

Tropical storm response parameters (deprecated)

Parameter Description
Year Year of origination.
BasinID Basin identifier (NP, SP, NI, SI, AL, EP).
DepressionNumber The government depression number.
Name The name of the depression.
IsActive True if the depression has been updated recently.
IsSubtropical True when depression is classified as a subtropical cyclone.
AccuID AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed.
HurdatID Hurdat (hurricane database) storm ID. May be NULL. If NULL, this parameter will not be displayed.
AtcfID ATCF storm ID. May be NULL. If NULL, this parameter will not be displayed.

Top of Page

 

 

Tropical storm position response parameters (deprecated)

Parameter Description
Storm
Advisory
Position
MaxWindGust Maximum wind gust associated with the storm.
SustainedWind Maximum sustained wind associated with the storm.
MinimumPressure Minimum pressure associated with the storm.
Movement
status Storm 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.
landmarkReferences

Top of Page

 

 

Tropical storm forecast response parameters (deprecated)

Parameter Description
DateCreated Datetime that the forecast was created, displayed in ISO8601 format: yyyy-mm-ddThh:mm:ss±hh:mm.
EpochDateCreated Datetime that the forecast was created, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).
ForecastDateTime Datetime that the forecast is valid, displayed in ISO8601 format: yyyy-mm-ddThh:mm:ss±hh:mm.
ForecastEpochDateTime Datetime that the forecast is valid, displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).
Storm
Position
MaxWindGust Maximum wind gust associated with the storm.
SustainedWind Maximum sustained wind associated with the storm.
status Storm 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.

Top of Page