# Parameters

## Request parameters

| Parameter | Description | Default | Required |
| --- | --- | --- | --- |
| `apikey` | A unique code to access AccuWeather's APIs. | — | Yes |
| `version` | The API version (currently V1). | v1 | Yes |
| `year` | Year of the cyclone(s). | — | Yes (required for storm search, positions, forecast; optional for active storms) |
| `basinID` | A unique ID used to identify a basin (NP, SP, NI, SI, AL, EP). | — | Yes (required for storm search, positions, forecast; optional for active storms) |
| `depressionID` | The tropical cyclone's numeric ID (deprecated). | — | Yes (required for storm search, positions, forecast; optional for active storms) |
| `governmentID` | A unique government-issued ID. | — | Yes (required for storm search, positions, forecast; optional for active storms) |
| `format` | The response data format. Currently only JSON is available. | JSON | No |
| `details` | A boolean value that specifies whether or not to include extended information. | False | No |
| `radiigeometry` | Includes wind radii summary data and geoJSON details in the response when set to "true". | False | No |
| `windowgeometry` | Includes window geometry data (geoJSON) in the response when set to "true". | False | No |
| `includelandmarks` | Includes a landmarkReferences array with landmark-specific information when set to "true". | True | No |

---

## Active storms — response parameters

| Field | Type | Description |
| --- | --- | --- |
| `year` | integer | Year of origination. |
| `basinID` | string | Basin identifier (AL, EP, SI, NI, CP, NP, SP). |
| `depressionNumber` | integer | Government depression number. May be NULL. |
| `name` | string | The name of the depression. |
| `isActive` | boolean | True if the depression has been updated recently. |
| `isSubtropical` | boolean | True when the depression is classified as a subtropical cyclone. |
| `accuId` | string | AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed. |
| `atcfId` | string | Automated Tropical Cyclone Forecasting (ATCF) storm ID. May be NULL. If NULL, this parameter will not be displayed. |
| `govId` | string | Government storm ID. This will match the depression number. |
| `eventKey` | string | A unique identifier in the format *BBDDYYYY* where *BB* is the basin code, *DD* is the depression number, and *YYYY* is the year. |
| `govBaseLink` | string | Link to the specific government storm URL. |
| `accuBaseLink` | string | Link to the specific AccuWeather storm URL. May be NULL. If NULL, this parameter will not be displayed. |
| `atcfBaseLink` | string | Link to the specific ATCF storm URL. May be NULL. If NULL, this parameter will not be displayed. |

---

## Storm search — response parameters

| Field | Type | Description |
| --- | --- | --- |
| `year` | integer | Year of origination. |
| `basinID` | string | Basin identifier (AL, EP, SI, NI, CP, NP, SP). |
| `depressionNumber` | integer | Government depression number. May be NULL. |
| `name` | string | The name of the depression. |
| `isActive` | boolean | True if the depression has been updated recently. |
| `isRetired` | boolean | True if the storm name has been permanently retired in the source basin. |
| `isSubtropical` | boolean | True when the depression is classified as a subtropical cyclone. |
| `accuId` | string | AccuWeather storm ID. May be NULL. If NULL, this parameter will not be displayed. |
| `atcfId` | string | ATCF storm ID. May be NULL. If NULL, this parameter will not be displayed. |
| `govId` | string | Government storm ID. This will match the depression number. |
| `eventKey` | string | A unique identifier in the format *BBDDYYYY* where *BB* is the basin code, *DD* is the depression number, and *YYYY* is the year. |
| `duration` | object | An object containing information about the total length of time the storm lasted. Only available after the storm has ended. |
| `duration.startDateTime` | string | The date and time at which the storm began in ISO 8601 format (yyyy-mm-ddThh:mm:ss+hh:mm). |
| `duration.startEpochDateTime` | integer | The date and time at which the storm began as a count of the number of seconds that had elapsed since midnight on January 1st, 1970 UTC/GMT. |
| `duration.endDateTime` | string | The date and time at which the storm ended in ISO 8601 format (yyyy-mm-ddThh:mm:ss+hh:mm). |
| `duration.endEpochDateTime` | integer | The date and time at which the storm ended as a count of the number of seconds that had elapsed since midnight on January 1st, 1970 UTC/GMT. |
| `peakIntensity` | object | An object containing information about the storm's maximum strength. |
| `peakIntensity.validDateTime` | string | The date and time at which the peak intensity was observed, displayed in ISO 8601 format. |
| `peakIntensity.validEpochDateTime` | integer | The date and time at which the peak intensity was observed, displayed as epoch seconds. |
| `peakIntensity.status` | string | A short text string describing the type of tropical storm. |
| `peakIntensity.localizedStatus` | string | A short text string describing the type of tropical storm in the requested language. |
| `peakIntensity.position` | object | An object containing latitude and longitude values indicating the peak intensity location. |
| `peakIntensity.position.latitude` | number | The north/south position value, displayed with one decimal place. |
| `peakIntensity.position.longitude` | number | The east/west position value, displayed with one decimal place. |
| `peakIntensity.sustainedWind` | object | An object containing information about the maximum sustained wind speed associated with the storm. Contains metric and imperial values. |
| `peakIntensity.sustainedWind.metric.value` | number | The maximum sustained wind speed's rounded numerical value in kilometers per hour (km/h). |
| `peakIntensity.sustainedWind.metric.unit` | string | The maximum sustained wind speed's unit type (km/h). |
| `peakIntensity.sustainedWind.metric.unitType` | integer | A unique numeric ID that designates the wind speed measurement's unit type. |
| `peakIntensity.sustainedWind.imperial.value` | number | The maximum sustained wind speed's rounded numerical value in miles per hour (mi/h). |
| `peakIntensity.sustainedWind.imperial.unit` | string | The maximum sustained wind speed's unit type (mi/h). |
| `peakIntensity.sustainedWind.imperial.unitType` | integer | A unique numeric ID that designates the wind speed measurement's unit type. |
| `govBaseLink` | string | Link to the specific government storm URL. |
| `accuBaseLink` | string | Link to the specific AccuWeather storm URL. May be NULL. |
| `atcfBaseLink` | string | Link to the specific ATCF storm URL. May be NULL. |

---

## Forecast — response parameters

| Field | Type | Description |
| --- | --- | --- |
| `validDateTime` | string | Datetime the forecast is valid, displayed in ISO8601 format. |
| `validEpochDateTime` | integer | Datetime the forecast is valid, displayed as epoch seconds. |
| `initializedDateTime` | string | Datetime the forecast was created, displayed in ISO8601 format. |
| `epochInitializedDateTime` | integer | Datetime the forecast was created, displayed as epoch seconds. |
| `position` | object | An object containing the storm's position. |
| `position.latitude` | number | The latitude of the storm's position. |
| `position.longitude` | number | The longitude of the storm's position. |
| `maxWindGust` | object | Maximum wind gust speed associated with the storm. May be NULL. Contains metric and imperial values. |
| `maxWindGust.metric.Value` | number | Rounded value of the maximum wind gust speed in kilometers per hour. |
| `maxWindGust.metric.Unit` | string | Type of unit for the maximum wind gust speed value (kilometers per hour). |
| `maxWindGust.metric.UnitType` | integer | Numeric value that can be used for unit translations. |
| `maxWindGust.imperial.Value` | number | Rounded value of the maximum wind gust speed in miles per hour. |
| `maxWindGust.imperial.Unit` | string | Type of unit for the maximum wind gust speed value (miles per hour). |
| `maxWindGust.imperial.UnitType` | integer | Numeric value that can be used for unit translations. |
| `sustainedWind` | object | Maximum sustained wind speed associated with the storm. May be NULL. Contains metric and imperial values. |
| `sustainedWind.metric.Value` | number | Rounded value of the sustained wind speed in kilometers per hour. |
| `sustainedWind.metric.Unit` | string | Type of unit for the sustained wind speed value (kilometers per hour). |
| `sustainedWind.metric.UnitType` | integer | Numeric value that can be used for unit translations. |
| `sustainedWind.imperial.Value` | number | Rounded value of the sustained wind speed in miles per hour. |
| `sustainedWind.imperial.Unit` | string | Type of unit for the sustained wind speed value (miles per hour). |
| `sustainedWind.imperial.UnitType` | integer | Numeric value that can be used for unit translations. |
| `status` | string | Storm status, in English. |
| `localizedStatus` | string | Storm status, in the requested language. |
| `window` | object | Contains information about the forecast window for the storm during the specified time period. If windowgeometry=true, includes geoJSON details. |
| `window.left.latitude` | number | Latitude of the point on the left side of the window. |
| `window.left.longitude` | number | Longitude of the point on the left side of the window. |
| `window.right.latitude` | number | Latitude of the point on the right side of the window. |
| `window.right.longitude` | number | Longitude of the point on the right side of the window. |
| `window.beginDateTime` | string | DateTime of the beginning of the window of movement, displayed in ISO8601 format. |
| `window.epochBeginDateTime` | integer | DateTime of the beginning of the window of movement, displayed as epoch seconds. |
| `window.endDateTime` | string | DateTime of the end of the window of movement, displayed in ISO8601 format. |
| `window.epochEndDateTime` | integer | DateTime of the end of the window of movement, displayed as epoch seconds. |
| `window.beginStatus` | string | Storm status at the beginning of the window. |
| `window.endStatus` | string | Storm status at the end of the window. |
| `window.geometry` | object | Displayed when windowgeometry=true. GeoJSON object containing coordinates describing the window of movement. |
| `windRadiiSummary` | object | Displayed when details=true or radiigeometry=true in the request. |
| `windRadiiSummary.validDateTime` | string | DateTime for which the wind radii summary data is valid, displayed in ISO8601 format. |
| `windRadiiSummary.validEpochDateTime` | integer | DateTime for which the wind radii summary data is valid, displayed as epoch seconds. |
| `windRadiiSummary.windSpeed` | object | Wind speed associated with the radiusSectorData. Contains metric and imperial values. |
| `windRadiiSummary.radiusSectorData` | array | Contains the information needed to plot wind radius quadrants. Bearing 0-90 = NE quadrant; 90-180 = SE quadrant; 180-270 = SW quadrant; 270-360 = NW quadrant. |
| `windRadiiSummary.radiusSectorData[].beginBearing` | number | Bearing, in degrees, of the beginning of the quadrant. |
| `windRadiiSummary.radiusSectorData[].endBearing` | number | Bearing, in degrees, of the end of the quadrant. |
| `windRadiiSummary.radiusSectorData[].range` | number | The radius of the quadrant, in nautical miles. |
| `windRadiiSummary.radiiGeometry` | object | GeoJSON object describing the outline of the wind radius quadrants. Displayed when radiigeometry=true and if tropical/storm/hurricane force winds are present. |

---

## Positions — response parameters

| Field | Type | Description |
| --- | --- | --- |
| `validDateTime` | string | Datetime the position is valid, displayed in ISO8601 format. |
| `validEpochDateTime` | integer | Datetime the position is valid, displayed as epoch seconds. |
| `position` | object | An object containing the storm's position. |
| `position.latitude` | number | Storm latitude. |
| `position.longitude` | number | Storm longitude. |
| `maxWindGust` | object | Maximum wind gust speed associated with the storm. May be NULL. Contains metric and imperial values. |
| `maxWindGust.metric.Value` | number | Rounded value of the maximum wind gust speed in kilometers per hour. |
| `maxWindGust.metric.Unit` | string | Type of unit (kilometers per hour). |
| `maxWindGust.metric.UnitType` | integer | Numeric value that can be used for unit translations. |
| `maxWindGust.imperial.Value` | number | Rounded value of the maximum wind gust speed in miles per hour. |
| `maxWindGust.imperial.Unit` | string | Type of unit (miles per hour). |
| `maxWindGust.imperial.UnitType` | integer | Numeric value that can be used for unit translations. |
| `sustainedWind` | object | Maximum sustained wind speed associated with the storm. May be NULL. Contains metric and imperial values. |
| `sustainedWind.metric.Value` | number | Rounded value of the sustained wind speed in kilometers per hour. |
| `sustainedWind.metric.Unit` | string | Type of unit (kilometers per hour). |
| `sustainedWind.metric.UnitType` | integer | Numeric value that can be used for unit translations. |
| `sustainedWind.imperial.Value` | number | Rounded value of the sustained wind speed in miles per hour. |
| `sustainedWind.imperial.Unit` | string | Type of unit (miles per hour). |
| `sustainedWind.imperial.UnitType` | integer | Numeric value that can be used for unit translations. |
| `minimumPressure` | object | Minimum pressure associated with the storm. May be NULL. Contains metric and imperial values. |
| `minimumPressure.metric.Value` | number | Rounded value of the minimum pressure in millibars (mb). |
| `minimumPressure.metric.Unit` | string | Type of unit (millibar). |
| `minimumPressure.metric.UnitType` | integer | Numeric value that can be used for unit translations. |
| `minimumPressure.imperial.Value` | number | Rounded value of the minimum pressure in inch of mercury (inHg). |
| `minimumPressure.imperial.Unit` | string | Type of unit (inch of mercury). |
| `minimumPressure.imperial.UnitType` | integer | Numeric value that can be used for unit translations. |
| `movement` | object | An object containing movement information. |
| `movement.direction.degrees` | number | Direction of movement in degrees. |
| `movement.direction.localized` | string | Localized compass direction. |
| `movement.direction.english` | string | English compass direction. |
| `movement.speed` | object | Contains metric and imperial speed values. |
| `status` | string | Storm status, in English. |
| `localizedStatus` | string | Storm status, in the requested language. |
| `isSubtropical` | boolean | True when classified as a subtropical cyclone. |
| `landmarkReferences[]` | array | Array of nearby landmarks (when includelandmarks=true). |
| `landmarkReferences[].landmark` | string | Name of the landmark. |
| `landmarkReferences[].direction` | string | Direction from the storm to the landmark. |
| `landmarkReferences[].range` | object | Distance from the storm to the landmark. Contains Metric and Imperial values. |
| `windRadiiSummary` | object | Displayed when details=true or radiigeometry=true. |