Filter the property results using the fields below. Click on a column header to toggle the table sorting using that column.
| Term | Timeframe | Description | Property | Endpoint | Plans |
|---|---|---|---|---|---|
| Timestamp of the period. | Current | UNIX timestamp of the period. | periods.#.timestamp |
airquality | |
| Date of the period | Current | ISO 8601 date of the period. | periods.#.dateTimeISO |
airquality | |
| Air Quality index | Current | The standardized Air Quality Index value from 0 - 500. See AirNow |
periods.#.aqi |
airquality | |
| Air Quality Category | Current | The Air Quality category based on the AQI: See AirNow - good - moderate - usg (Unhealthy for Sensitive Groups) - unhealthy - very Unhealthy - hazardous If using filter=china, the following categories are utilized:More info on China AQI / Categories. - excellent - good - slightly polluted - lightly polluted - moderately polluted - severely polluted If using the filter=india, the following categories are utilizes:More info on India AQI / Categories. - good - satisfactory - moderately polluted - poor - very poor - severe |
periods.#.category |
airquality | |
| Color code for the specific category | Current | The 6 character hexadecimal color code for the specific category. See AirNow |
periods.#.color |
airquality | |
| How AQI is calculated | Current | The method used for the AQI calculation: - airnow = Used the EPA AirNow AQI specification (default) - china = Used the China AQI specification (filter=china) - india = Used the India AQI specification (filter=india) |
periods.#.method |
airquality | |
| The dominant pollutant | Current | The dominant pollutant. Normally set to one of the following: - co (Carbon Monoxide) - no2 (Nitrogen Dioxide) - o3 (Ozone) - pm10 (Particle Matter <10µm) - pm2.5 (Particle Matter <2.5µm) - so2 (Sulfur Dioxide) |
periods.#.dominant |
airquality | |
| Current | Vaisala Xweather Air Quality Health Index object | periods.#.health |
airquality | ||
| Current | The air quality health index. A simplified global health index using a scale of 0 to 20 to describe the effect of air quality on health - low: 0 - 3 - moderate: 4-6 - high: 7-10 - very high: > 10 |
periods.#.health.index |
airquality | ||
| Current | The air quality health index category name: - low: 0 - 3 - moderate: 4-6 - high: 7-10 - very high: > 10 |
periods.#.health.category |
airquality | ||
| Current | The air quality health index category color: The air quality health index. A simplified global health index using a scale of 0 to 20 to describe the effect of air quality on health - low: #0000FF - moderate: #00FF00 - high: #FFFF00 - very high: #FF0000 |
periods.#.health.color |
airquality | ||
| Pollutants | Current | Array of pollutants | periods.#.pollutants |
airquality | |
| Pollutant abbreviation | Current | The type abbreviation of the pollutant: co = carbon monoxide no2 = nitrogen dioxide o3 = ozone pm1 = partical matter (<1µm) pm10 = partical matter (<10µm) pm2.5 = partical matter (<2.5µm) so2 = sulfer dioxide Note that not all air quality stations provide information on all pollutants. |
periods.#.pollutants.#.type |
airquality | |
| Pollutant name | Current | Name of the pollutant | periods.#.pollutants.#.name |
airquality | |
| Pollutant measurement in parts per billion | Current | The pollutant measurement in parts per billion. Null if this unit is not utilized pm2.5 & pm10 do not utilize PPB. |
periods.#.pollutants.#.valuePPB |
airquality | |
| Pollutant measurement in parts per micrograms per cubic meter | Current | The pollutant measurement in parts per micrograms per cubic meter. Null if this unit is not utilized | periods.#.pollutants.#.valueUGM3 |
airquality | |
| Pollutant measurement in common AQI value | Current | The pollutant measurement converted to the common AQI value, from 0 to 500 | periods.#.pollutants.#.aqi |
airquality | |
| Air Quality category based on the AQI | Current | The Air Quality category based on the AQI: See AirNow - good - moderate - usg (Unhealthy for Sensitive Groups) - unhealthy - very Unhealthy - hazardous If using filter=china, the following categories are utilized:More info on China AQI / Categories. - excellent - good - slightly polluted - lightly polluted - moderately polluted - severely polluted If using the filter=india, the following categories are utilizes:More info on India AQI / Categories. - good - satisfactory - moderately polluted - poor - very poor - severe |
periods.#.pollutants.#.category |
airquality | |
| Color code for the specific category. | Current | The 6 character hexadecimal color code for the specific category. See AirNow |
periods.#.pollutants.#.color |
airquality | |
| Sources for air quality information | Current | Array of sources for the air quality information for this location | profile.sources |
airquality | |
| Source name | Current | The name of the source | profile.sources.#.name |
airquality | |
| Stations used | Current | Array of the observation station IDs used in the interpolated data | profile.stations |
airquality | |
| City | Current | The city name of your requested location | place.city |
airquality | |
| Timestamp of the period | Current/Forecast | UNIX timestamp of the period. | periods.#.timestamp |
airquality/forecasts |
Flex - Base API - Base |
| Date of the period | Current/Forecast | ISO 8601 date of the period. | periods.#.dateTimeISO |
airquality/forecasts |
Flex - Base API - Base |
| Standardized Air Quality Index | Current/Forecast | The standardized Air Quality Index, from 0 to 500 See AirNow |
periods.#.aqi |
airquality/forecasts |
Flex - Base API - Base |
| Air Quality category based on the AQI | Current/Forecast | The Air Quality category based on the AQI: See AirNow - good - moderate - usg (Unhealthy for Sensitive Groups) - unhealthy - very Unhealthy - hazardous If using filter=china, the following categories are utilized:More info on China AQI / Categories. - excellent - good - slightly polluted - lightly polluted - moderately polluted - severely polluted If using the filter=india, the following categories are utilizes:More info on India AQI / Categories. - good - satisfactory - moderately polluted - poor - very poor - severe |
periods.#.category |
airquality/forecasts |
Flex - Base API - Base |
| Color code for the specific category | Current/Forecast | The 6 character hexadecimal color code for the specific category. See AirNow |
periods.#.color |
airquality/forecasts |
Flex - Base API - Base |
| Method used for the AQI calculation | Current/Forecast | The method used for the AQI calculation: - airnow = Used the EPA AirNow AQI specification (default) - china = Used the China AQI specification (filter=china) - india = Used the India AQI specification (filter=india) |
periods.#.method |
airquality/forecasts |
Flex - Base API - Base |
| The dominant pollutant | Current/Forecast | The dominant pollutant. Normally set to one of the following: - co (Carbon Monoxide) - no2 (Nitrogen Dioxide) - o3 (Ozone) - pm10 (Particle Matter <10µm) - pm2.5 (Particle Matter <2.5µm) - so2 (Sulfur Dioxide) |
periods.#.dominant |
airquality/forecasts |
Flex - Base API - Base |
| Current/Forecast | Vaisala Xweather Air Quality Health Index object | periods.#.health |
airquality/forecasts |
Flex - Base API - Base |
|
| Current/Forecast | The air quality health index. A simplified global health index using a scale of 0 to 20 to describe the effect of air quality on health - low: 0 - 3 - moderate: 4-6 - high: 7-10 - very high: > 10 |
periods.#.health.index |
airquality/forecasts |
Flex - Base API - Base |
|
| Current/Forecast | The air quality health index category name: - low: 0 - 3 - moderate: 4-6 - high: 7-10 - very high: > 10 |
periods.#.health.category |
airquality/forecasts |
Flex - Base API - Base |
|
| Current/Forecast | The air quality health index category name: - low: 0 - 3 - moderate: 4-6 - high: 7-10 - very high: > 10 |
periods.#.health.color |
airquality/forecasts |
Flex - Base API - Base |
|
| Pollutants | Current/Forecast | Array of pollutants | periods.#.pollutants |
airquality/forecasts |
Flex - Base API - Base |
| Abbreviation of the pollutant | Current/Forecast | The type abbreviation of the pollutant: co = carbon monoxide no2 = nitrogen dioxide o3 = ozone pm1 = partical matter (<1µm) pm10 = partical matter (<10µm) pm2.5 = partical matter (<2.5µm) so2 = sulfer dioxide |
periods.#.pollutants.#.type |
airquality/forecasts |
Flex - Base API - Base |
| Name of the pollutant | Current/Forecast | Name of the pollutant | periods.#.pollutants.#.name |
airquality/forecasts |
Flex - Base API - Base |
| Pollutant measurement in parts per billion | Current/Forecast | The pollutant measurement in parts per billion. Null if this unit is not utilized pm2.5 & pm10 do not utilize PPB |
periods.#.pollutants.#.valuePPB |
airquality/forecasts |
Flex - Base API - Base |
| Pollutant measurement in parts per micrograms per cubic meter | Current/Forecast | The pollutant measurement in parts per micrograms per cubic meter. Null if this unit is not utilized | periods.#.pollutants.#.valueUGM3 |
airquality/forecasts |
Flex - Base API - Base |
| Pollutant measurement converted to the common AQI value | Current/Forecast | The pollutant measurement converted to the common AQI value, from 0 to 500 | periods.#.pollutants.#.aqi |
airquality/forecasts |
Flex - Base API - Base |
| Air Quality category based on the AQI | Current/Forecast | The Air Quality category based on the AQI: See AirNow - good - moderate - usg (Unhealthy for Sensitive Groups) - unhealthy - very Unhealthy - hazardous If using filter=china, the following categories are utilized:More info on China AQI / Categories. - excellent - good - slightly polluted - lightly polluted - moderately polluted - severely polluted If using the filter=india, the following categories are utilizes:More info on India AQI / Categories. - good - satisfactory - moderately polluted - poor - very poor - severe |
periods.#.pollutants.#.category |
airquality/forecasts |
Flex - Base API - Base |
| Color code for the specific category | Current/Forecast | The 6 character hexadecimal color code for the specific category. See AirNow |
periods.#.pollutants.#.color |
airquality/forecasts |
Flex - Base API - Base |
| Sources used for the air quality information | Current/Forecast | Array of sources for the air quality information for this location | profile.sources |
airquality/forecasts |
Flex - Base API - Base |
| Source | Current/Forecast | The name of the source | profile.sources.#.name |
airquality/forecasts |
Flex - Base API - Base |
| Timestamp of the period. | Current | UNIX timestamp of the period. | periods.#.timestamp |
airquality/index |
Flex - Base API - Base |
| Date of the period | Current | ISO 8601 date of the period. | periods.#.dateTimeISO |
airquality/index |
Flex - Base API - Base |
| Air Quality Index | Current | The standardized Air Quality Index value from 0 - 500. See AirNow |
periods.#.aqi |
airquality/index |
Flex - Base API - Base |
| Air Quality Category | Current | The Air Quality category based on the AQI: See AirNow - good - moderate - usg (Unhealthy for Sensitive Groups) - unhealthy - very Unhealthy - hazardous |
periods.#.category |
airquality/index |
Flex - Base API - Base |
| Color code for the specific category | Current | The 6 character hexadecimal color code for the specific category. See AirNow |
periods.#.color |
airquality/index |
Flex - Base API - Base |
| How AQI is calculated | Current | The calculations used. Always 'airnow' | periods.#.method |
airquality/index |
Flex - Base API - Base |
| Sources for air quality information | Current | Array of sources for the air quality information for this location | profile.sources |
airquality/index |
Flex - Base API - Base |
| Source name | Current | The name of the source | profile.sources.#.name |
airquality/index |
Flex - Base API - Base |
| Alert ID | Current | The unique ID attribute identifying the alert. The ID is based on a combination of the details.loc, details.type and an internal event ID. Normally, the same ID will be utilized if the weather offices update the alert. | id |
alerts |
Flex - Base API - Base |
| Alert Data Source | Current | The source of the official alert information. Potential values include: - noaa_nws - envca - meteoalarm - ukmet |
dataSource |
alerts |
Flex - Base API - Base |
| Latitude/longitude of the alert | Current | The object containing the latitude/longitude of the alert centroid. In some instances, such as high seas alerts, the loc may be unavailable and returned as Null. | loc |
alerts |
Flex - Base API - Base |
| Latitude of the weather zone or county | Current | The latitude of the weather zone or county centroid | loc.latitude |
alerts |
Flex - Base API - Base |
| Longitude of the weather zone or county | Current | The longitude of the weather zone or county centroid | loc.longitude |
alerts |
Flex - Base API - Base |
| Alert details | Current | The object containing the alert details | details |
alerts |
Flex - Base API - Base |
| Event code for the alert | Current | The valid-time event code (VTEC) for the alert. Review the list of supported Alert Types. | details.type |
alerts |
Flex - Base API - Base |
| The type name for the alert | Current | The type name for the alert. | details.name |
alerts |
Flex - Base API - Base |
| Weather Zone | Current | The weather zone for the alert. | details.loc |
alerts |
Flex - Base API - Base |
| Tells whether it's an emergency-specific alert | Current | Set to true if this is an emergency-specific alert, such as a tornado emergency. | details.emergency |
alerts |
Flex - Base API - Base |
| The alert numeric priority and/or significance. | Current | The numeric priority of the alert. The lower the priority the higher the alert significance. Will typically match the NOAA defined alert priorities. There may be some minor differences from the NOAA list, especially for international locations. If a location has multiple active alerts, the API will normally sort based on priority ascending, so the alert with the most significant is first. |
details.priority |
alerts |
Flex - Base API - Base |
| Color code for the alert | Current | The 6 character hex color code for the alert. Corresponds to the AMP Alert types/colors. | details.color |
alerts |
Flex - Base API - Base |
| Category of the alert type | Current | The default category of the alert type. May be null for non common alerts. | details.cat |
alerts |
Flex - Base API - Base |
| Shortened version of alert | Current | The shortened and formatted version of the alert body text. Primarily for US alerts, removing the National Weather Service alert header information. Often the same as the bodyFull for Canadian and European alerts. | details.body |
alerts |
Flex - Base API - Base |
| Detailed version of alert | Current | The complete, unmodified version of the alert body text, including headers. | details.bodyFull |
alerts |
Flex - Base API - Base |
| Timestamp of initial alert issuance | Current | UNIX timestamp when the alert was initially issued for the location. This value will not normally change during the lifetime of the alert. | timestamps.issued |
alerts |
Flex - Base API - Base |
| Date of the time of initial alert issuance | Current | ISO 8601 date of the time when the initially issued for the location. This value will not normally change during the lifetime of the alert. | timestamps.issuedISO |
alerts |
Flex - Base API - Base |
| Timestamp of when the alert was initially issued or updated | Current | UNIX timestamp when the alert was updated. For a new alert, the issue and updated will normally match. If an alert is updated during its lifetime, this updated timestamp will change. | timestamps.updated |
alerts |
Flex - Base API - Base |
| Date of when the alert was initially issued or updated | Current | ISO 8601 date of when the alert was updated. For a new alert, issue and updated will normally match. If an alert is updated during its lifetime, this updated timestamp will change. | timestamps.updatedISO |
alerts |
Flex - Base API - Base |
| When alert goes into effect | Current | UNIX timestamp when the alert goes into effect. Often this will match the issue/updated time, though for some alerts, such as winter storm warnings, this may be set to a future date/time. | timestamps.begins |
alerts |
Flex - Base API - Base |
| Date of the time when the alert goes into effect | Current | ISO 8601 date of the time when the alert goes into effect. Often this will match the issue/updated time, though for some alerts, such as winter storm warnings, this may be set to a future date/time. | timestamps.beginsISO |
alerts |
Flex - Base API - Base |
| When alert expires | Current | UNIX timestamp when the alert expires. | timestamps.expires |
alerts |
Flex - Base API - Base |
| Date of the time when the alert expires | Current | ISO 8601 date of the time when the alert expires. | timestamps.expiresISO |
alerts |
Flex - Base API - Base |
| When alerts was received and stored. | Current | UNIX timestamp when the issuance or last update for the alert was received and stored in the DB after initial issuance. | timestamps.added |
alerts |
Flex - Base API - Base |
| Date of the time when the alert was received and stored. | Current | ISO 8601 date when the issuance or last update for the alert was received and stored in the DB after initial issuance. | timestamps.addedISO |
alerts |
Flex - Base API - Base |
| Latitude and Longitude of where alert is happening | Current | DEPRECATED. A comma-delimited string of latitude, longitude coordinates defining the small polygon boundary for this alert; typically used for certain alerts, such as tornado and severe thunderstorm warnings. NULL if the alert does not include a small polygon boundary. This field has been deprecated in favor of the geoPoly attribute. |
poly |
alerts |
Flex - Base API - Base |
| A GeoJSON polygon defining the polygon boundary for this alert | Current | A GeoJSON polygon defining the small polygon boundary for this alert; typically used for certain alerts, such as tornado and severe thunderstorm warnings. NULL if the alert does not include a small polygon boundary. When filter=geo is utilized, if no small polygon exists for the alert, the polygon for the weather zone, fire zone, county or CLC they alert is issued for will be returned. |
geoPoly |
alerts |
Flex - Base API - Base |
| List of US states and counties that are affected by alert | Current | If a US alert will be a list of US counties in the XXC### format, where XX is the state abbreviation and ### is the 3 digit county fips number. If a Canadian alert will be null. | includes.counties |
alerts |
Flex - Base API - Base |
| US state and county FIPS that are affected by alert | Current | If a US alert will be a list of US counties in the XX### format, where XX is the state two digit fips number and ### is the 3 digit county fips number. If a Canadian alert will be null. | includes.fips |
alerts |
Flex - Base API - Base |
| NOAA weather zones affected by alert listed by state and public zone id | Current | If a US alert will be a list of US public weather zones in the NOAA XXZ### format, where XX is the state abbreviation and ### is the 3 digit public zone id. If a Canadian alert will be a list of Canadian location codes (CLCs) | includes.wxzones |
alerts |
Flex - Base API - Base |
| List of US zip codes that are affected by the alert | Current | List of US zip codes that are affected by the alert. Only US zip codes, where the zip code centroid are within the alert, including any small polygon will be returned. | includes.zipcodes |
alerts |
Flex - Base API - Base |
| The FIPS code of the county in which the alert is located | Current | The FIPS code of the county in which the alert is located. | place.county |
alerts |
Flex - Base API - Base |
| Summary | Current | Object containing the summary | summary |
alerts/summary |
API - Base Flex - Base |
| Total number of weather zones or FIPS that have active alerts | Current | The total number of weather zones or FIPS that have active alerts. | summary.count |
alerts/summary |
API - Base Flex - Base |
| Two letter US state abbreviations or Canadian province | Current | Array of two letter US state abbreviations or Canadian province in the format of "ca.xx", that have active alerts | summary.states |
alerts/summary |
API - Base Flex - Base |
| Active alerts | Current | Array of active VTEC or WMO (if no VTEC) codes for the active alerts. Please refer to the full list of available alerts, type and color codes: https://www.aerisweather.com/support/docs/aeris-maps/reference/alert-types/ |
summary.typeCodes |
alerts/summary |
API - Base Flex - Base |
| Active alert type | Current | Array of each active alert type, with summary information for each | summary.types |
alerts/summary |
API - Base Flex - Base |
| Alert type name | Current | The alert type name | summary.types[#].type |
alerts/summary |
API - Base Flex - Base |
| Codes for the alert | Current | The VTEC or WMO (if no VTEC) codes for the alert Please refer to the full list of available alerts, type and color codes. |
summary.types[#].code |
alerts/summary |
API - Base Flex - Base |
| The 6 character hex color code for the alert. Corresponds to the AMP Alert types/colors. | Current | The 6 character hex color code for the alert. Corresponds to the AMP Alert types/colors. | summary.types[#].color |
alerts/summary |
API - Base Flex - Base |
| The total number of weather zones or FIPS | Current | The total number of weather zones or FIPS that the alert is active within. | summary.types[#].count |
alerts/summary |
API - Base Flex - Base |
| Two letter US state abbreviations or Canadian province | Current | Array of two letter US state abbreviations or Canadian province in the format of "ca.xx",that the alert is active within | summary.types[#].states |
alerts/summary |
API - Base Flex - Base |
| NOAA public weather zones and/or FIPS codes | Current | Array of NOAA public weather zones and/or FIPS codes that the alert is active within. | summary.types[#].zones |
alerts/summary |
API - Base Flex - Base |
| The unix timestamp of the time of the conditions | Historical/Current/Forecast | The unix timestamp of the time of the conditions | periods.#.timestamp |
conditions |
Flex - Base API - Base |
| The ISO 8601 date/time of the conditions | Historical/Current/Forecast | The ISO 8601 date/time of the conditions | periods.#.dateTimeISO |
conditions |
Flex - Base API - Base |
| The temperature in Celsius | Historical/Current/Forecast | The temperature in Celsius. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.tempC |
conditions |
Flex - Base API - Base |
| The temperature in Fahrenheit | Historical/Current/Forecast | The temperature in Fahrenheit. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.tempF |
conditions |
Flex - Base API - Base |
| The feels like / apparent temperature in Celsius | Historical/Current/Forecast | The feels-like / apparent temperature in Celsius. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip).The feels-like temperature is often based on a combination of the NOAA heat index and/or wind chill specifications. Locations with a temperature of 80F (26.67C) or higher will high humidity will have a feels-like temperature higher than the air temperature. Likewise, locations with a temperature of 40F (4.44C) and lower winds speeds of 3 mph or higher will often have a feels like temperature less than the air temperature. |
periods.#.feelslikeC |
conditions |
Flex - Base API - Base |
| The feels like / apparent temperature in Fahrenheit | Historical/Current/Forecast | The feels like / apparent temperature in Fahrenheit. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip).The feels-like temperature is often based on a combination of the NOAA heat index and/or wind chill specifications. Locations with a temperature of 80F (26.67C) or higher will high humidity will have a feels-like temperature higher than the air temperature. Likewise, locations with a temperature of 40F (4.44C) and lower winds speeds of 3 mph or higher will often have a feels like temperature less than the air temperature. |
periods.#.feelslikeF |
conditions |
Flex - Base API - Base |
| The dew point in Celsius | Historical/Current/Forecast | The dew point in Celsius. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.dewpointC |
conditions |
Flex - Base API - Base |
| The dew point in Fahrenheit | Historical/Current/Forecast | The dew point in Fahrenheit. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.dewpointF |
conditions |
Flex - Base API - Base |
| The relative humidity, from 0 - 100 | Historical/Current/Forecast | The relative humidity, from 0 - 100. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.humidity |
conditions |
Flex - Base API - Base |
| The wind direction in degrees | Historical/Current/Forecast | The wind direction in degrees. 0 - 359, with 0 = North, Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.windDirDEG |
conditions |
Flex - Base API - Base |
| The wind direction | Historical/Current/Forecast | The wind direction, Null if unavailable: Not returned with minutely precipitation forecasts ( filter=minutelyprecip).Possible values: - N - North - NNE - North northeast - NE - Northeast - ENE - East northeast - E - East - ESE - East southeast - SE - Southeast - SSE - South southeast - S - South - SSW - South southwest - SW - Southwest - WSW - West southwest - W - West - WNW - West northwest - NW - Northwest - NNW - North northwest |
periods.#.windDir |
conditions |
Flex - Base API - Base |
| The wind speed in knots | Historical/Current/Forecast | The wind speed in knots. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.windSpeedKTS |
conditions |
Flex - Base API - Base |
| The wind speed in kilometers per hour | Historical/Current/Forecast | The wind speed in kilometers per hour. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.windSpeedKPH |
conditions |
Flex - Base API - Base |
| The wind speed in miles per hour | Historical/Current/Forecast | The wind speed in miles per hour. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.windSpeedMPH |
conditions |
Flex - Base API - Base |
| The wind gusts in knots | Historical/Current/Forecast | The wind gusts in knots. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.windGustKTS |
conditions |
Flex - Base API - Base |
| The wind gusts in kilometers per hour | Historical/Current/Forecast | The wind gusts in kilometers per hour. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.windGustKPH |
conditions |
Flex - Base API - Base |
| The wind gusts in miles per hour | Historical/Current/Forecast | The wind gusts in miles per hour. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.windGustMPH |
conditions |
Flex - Base API - Base |
| The estimated amount of precipitation in millimeters | Historical/Current/Forecast | For minutely precipitation forecasts, represents the precipitation rate in mm accumulated over the requested time range. For example, 1minute intervals will be for 1 minute, if filter=15min is utilized, then will be the total over each 15-minute interval in the response. For a point in time from now through the past 3 hours, represents the estimated precipitation rate in mm/hour occurring at the requested time. For archive requests prior to the past 3 hours, represents the estimated precipitation received during the previous hour ending at the requested time. Null if unavailable. |
periods.#.precipMM |
conditions |
Flex - Base API - Base |
| The estimated amount of precipitation in inches | Historical/Current/Forecast | For minutely precipitation forecasts, represents the precipitation rate in inches accumulated over the requested time range. For example, 1minute intervals will be for 1 minute, if filter=15min is utilized, then will be the total over each 15-minute interval in the response. For a point in time from now through the past 3 hours, represents the estimated precipitation rate in inches/hour occurring at the requested time. For archive requests prior to the past 3 hours represents the estimated precipitation received during the previous hour ending at the requested time. Null if unavailable. |
periods.#.precipIN |
conditions |
Flex - Base API - Base |
| The precipitation rate in millimeters / hour | Historical/Current/Forecast | The precipitation rate in mm/hour at the point in time of the period. | periods.#.precipRateMM |
conditions |
Flex - Base API - Base |
| The precipitation rate in inches / hour | Historical/Current/Forecast | The precipitation rate in inches/hour at the point in time of the period. | periods.#.precipRateIN |
conditions |
Flex - Base API - Base |
| The estimated amount of snowfall in centimeters | Historical/Current/Forecast | For minutely precipitation forecasts, represents the snowfall rate in cm/hour occurring at the specified minute within the forecast. For a point in time from now through the past 3 hours, represents the estimated snowfall rate in cm/hour occurring at the requested time. For archive requests prior to the past 3 hours, represents the estimated snowfall received during the previous hour ending at the requested time. Null if unavailable. |
periods.#.snowCM |
conditions |
Flex - Base API - Base |
| The estimated amount of snowfall in inches | Historical/Current/Forecast | For minutely precipitation forecasts, represents the snowfall rate in inches/hour occurring at the specified minute within the forecast. For a point in time from now through the past 3 hours, represents the estimated snowfall rate in inches/hour occurring at the requested time. For archive requests prior to the past 3 hours, represents the estimated snowfall received during the previous hour ending at the requested time. Null if unavailable. |
periods.#.snowIN |
conditions |
Flex - Base API - Base |
| The snow depth in centimeters | Historical/Current/Forecast | The estimated snow depth in cm at the point in time of the period. Historical data for snow depth is available after September, 7th 2023. | periods.#.snowDepthCM |
conditions |
Flex - Base API - Base |
| The snow depth in inches | Historical/Current/Forecast | The estimated snow depth in inches at the point in time of the period. Historical data for snow depth is available after September, 7th 2023. | periods.#.snowDepthIN |
conditions |
Flex - Base API - Base |
| The snowfall rate in centimeters/hour | Historical/Current/Forecast | The snowfall rate in cm/hour at the point in time of the period. | periods.#.snowRateCM |
conditions |
Flex - Base API - Base |
| The snowfall rate in inches/hour | Historical/Current/Forecast | The snowfall rate in inches/hour at the point in time of the period. | periods.#.snowRateIN |
conditions |
Flex - Base API - Base |
| Probability of precipitation. | Historical/Current/Forecast | Probability of precipitation. A percentage from 0 - 100%. Available for requests for the current time and forecast requests. Null for archive requests or if unavailable. | periods.#.pop |
conditions |
Flex - Base API - Base |
| The visibility in kilometers | Historical/Current/Forecast | The visibility in kilometers. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.visibilityKM |
conditions |
Flex - Base API - Base |
| The visibility in miles | Historical/Current/Forecast | The visibility in miles. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.visibilityMI |
conditions |
Flex - Base API - Base |
| The mean sea level pressure (MSLP) in millibars | Historical/Current/Forecast | The mean sea level pressure (MSLP) in millibars. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.pressureMB |
conditions |
Flex - Base API - Base |
| The mean sea level pressure (MSLP) in inches mercury (inHg) | Historical/Current/Forecast | The mean sea level pressure (MSLP) in inches mercury (inHg). Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.pressureIN |
conditions |
Flex - Base API - Base |
| The surface/station pressure in millibars | Historical/Current/Forecast | The surface pressure in millibars. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.spressureMB |
conditions |
Flex - Base API - Base |
| The surface/station pressure in inches of mercury (inHg) | Historical/Current/Forecast | The surface pressure in inches of mercury (inHg). Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.spressureIN |
conditions |
Flex - Base API - Base |
| The altimeter value in millibars | Historical/Current/Forecast | The altimeter value in millibars. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.altimeterMB |
conditions |
Flex - Base API - Base |
| The altimeter value in inches of mercury (inHg) | Historical/Current/Forecast | The altimeter value in inches mercury (inHg). Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.altimeterIN |
conditions |
Flex - Base API - Base |
| The percentage of the clouds in the sky | Historical/Current/Forecast | The percentage of the clouds in the sky. From 0 - 100. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.sky |
conditions |
Flex - Base API - Base |
| Phrase of weather conditions | Historical/Current/Forecast | Phrase of weather conditions. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.weather |
conditions |
Flex - Base API - Base |
| Coded version of weather conditions | Historical/Current/Forecast | Coded version of weather conditions. See the Coded Weather documentation for code options. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.weatherCoded |
conditions |
Flex - Base API - Base |
| Phrase of the primary weather conditions | Historical/Current/Forecast | Phrase of the primary weather conditions. Null if unavailable. | periods.#.weatherPrimary |
conditions |
Flex - Base API - Base |
| Coded version of the primary weather conditions | Historical/Current/Forecast | Coded version of the primary weather conditions. See the Coded Weather documentation for code options. Null if unavailable. | periods.#.weatherPrimaryCoded |
conditions |
Flex - Base API - Base |
| Coded version of cloud conditions | Historical/Current/Forecast | Coded version of cloud conditions. See the Coded Weather documentation for code options. Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.cloudsCoded |
conditions |
Flex - Base API - Base |
| Icon name corresponding to the primary weather conditions | Historical/Current/Forecast | Icon name corresponding to the primary weather conditions. | periods.#.icon |
conditions |
Flex - Base API - Base |
| Estimated 1 hour global solar radiation in watts / meter squared | Historical/Current/Forecast | (Deprecated) Estimated 1-hour global solar radiation in watts/meter squared. Not returned with minutely precipitation forecasts ( filter=minutelyprecip).Note: Utilize periods.#.solrad.ghiWM2 |
periods.#.solradWM2 |
conditions |
Flex - Base API - Base |
| Enhanced solar radiation information | Historical/Current/Forecast | Enhanced solar radiation information | periods.#.solrad |
conditions |
Flex - Base API - Base |
| The solar azimuth angle. | Historical/Current/Forecast | The solar azimuth angle. | periods.#.solrad.azimuthDEG |
conditions |
Flex - Base API - Base |
| The solar zenith angle. | Historical/Current/Forecast | The solar zenith angle. | periods.#.solrad.zenithDEG |
conditions |
Flex - Base API - Base |
| Estimated 1-hour Global Horizontal Irradiance (global solar radiation) in watts/meter squared. | Historical/Current/Forecast | Estimated 1-hour Global Horizontal Irradiance (global solar radiation) in watts/meter squared. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.solrad.ghiWM2 |
conditions |
Flex - Base API - Base |
| Estimated 1-hour Direct Normal Irradiation in watts/meter squared. | Historical/Current/Forecast | Estimated 1-hour Direct Normal Irradiation in watts/meter squared. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.solrad.dniWM2 |
conditions |
Flex - Base API - Base |
| Estimated 1-hour Diffused Horizontal Irradiance in watts/meter squared. | Historical/Current/Forecast | Estimated 1-hour Diffused Horizontal Irradiance in watts/meter squared. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.solrad.dhiWM2 |
conditions |
Flex - Base API - Base |
| Ultraviolet Index (from 1 to 12) | Historical/Current/Forecast | Ultraviolet Index (from 1 to 12). Null if unavailable. Not returned with minutely precipitation forecasts ( filter=minutelyprecip). |
periods.#.uvi |
conditions |
Flex - Base API - Base |
| Signifies if the observation occurred during daily hours | Historical/Current/Forecast | Signifies if the observation occurred during daily hours. True if between sunrise and sunset, false otherwise. | periods.#.isDay |
conditions |
Flex - Base API - Base |
| Timestamp of weather conditions summary | Historical/Current | The unix timestamp for the date/time the weather conditions summary. | periods.#.timestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time of the weather conditions summary | Historical/Current | The ISO 8601 date/time for the weather conditions summary | periods.#.dateTimeISO |
conditions/summary |
Flex - Base API - Base |
| First and last valid times for the summary and total intervals | Historical/Current | An object with the first, and last valid times for the summary and total intervals | periods.#.range |
conditions/summary |
Flex - Base API - Base |
| Last condition valid time used to generate the summary | Historical/Current | The unix timestamp for the last condition valid time used to generate the summary. | periods.#.range.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time for the last condition valid time used to generate the summary | Historical/Current | The ISO 8601 date/time for the last condition valid time used to generate the summary. | periods.#.range.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Timestamp for the earliest condition valid time used to generate the summary | Historical/Current | The unix timestamp for the earliest condition valid time used to generate the summary. | periods.#.range.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time for the earliest condition valid time used to generate the summary | Historical/Current | The ISO 8601 date/time for the earliest condition valid time used to generate the summary. | periods.#.range.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Number of weather conditions intervals used to create the summary | Historical/Current | The total number of weather conditions intervals used to create the summary | periods.#.range.count |
conditions/summary |
Flex - Base API - Base |
| Temperature Summary | Historical/Current | The temperature summary object, null if unavailable | periods.#.temp |
conditions/summary |
Flex - Base API - Base |
| Maximum temperature in Celsius | Historical/Current | The maximum temperature in Celsius | periods.#.temp.maxC |
conditions/summary |
Flex - Base API - Base |
| Maximum temperature in Fahrenheit | Historical/Current | The maximum temperature in Fahrenheit | periods.#.temp.maxF |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum temperature occurred | Historical/Current | The unix timestamp that the maximum temperature occurred | periods.#.temp.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum temperature occurred | Historical/Current | The ISO 8601 date/time that the maximum temperature occurred | periods.#.temp.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum temperature in Celsius | Historical/Current | The minimum temperature in Celsius | periods.#.temp.minC |
conditions/summary |
Flex - Base API - Base |
| Minimum temperature in Fahrenheit | Historical/Current | The minimum temperature in Fahrenheit | periods.#.temp.minF |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum temperature occurred | Historical/Current | The unix timestamp that the minimum temperature occurred | periods.#.temp.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum temperature occurred | Historical/Current | The ISO 8601 date/time that the minimum temperature occurred | periods.#.temp.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Average temperature in Celsius | Historical/Current | The average temperature in Celsius | periods.#.temp.avgC |
conditions/summary |
Flex - Base API - Base |
| Average temperature in Fahrenheit | Historical/Current | The average temperature in Fahrenheit | periods.#.temp.avgF |
conditions/summary |
Flex - Base API - Base |
| Feels Like / apparent temperature | Historical/Current | The Feels Like / apparent temperature summary object, null if unavailable | periods.#.feelslike |
conditions/summary |
Flex - Base API - Base |
| Maximum feels like temperature in Celsius | Historical/Current | The maximum feels like temperature in Celsius | periods.#.feelslike.maxC |
conditions/summary |
Flex - Base API - Base |
| Maximum feels like temperature in Fahrenheit | Historical/Current | The maximum feels like temperature in Fahrenheit | periods.#.feelslike.maxF |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum feels like temperature occurred | Historical/Current | The unix timestamp that the maximum feels like temperature occurred | periods.#.feelslike.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum feels like temperature occurred | Historical/Current | The ISO 8601 date/time that the maximum feels like temperature occurred | periods.#.feelslike.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum feels like temperature in Celsius | Historical/Current | The minimum feels like temperature in Celsius | periods.#.feelslike.minC |
conditions/summary |
Flex - Base API - Base |
| Minimum feels like temperature in Fahrenheit | Historical/Current | The minimum feels like temperature in Fahrenheit | periods.#.feelslike.minF |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum feels like temperature occurred | Historical/Current | The unix timestamp that the minimum feels like temperature occurred | periods.#.feelslike.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum feels like temperature occurred | Historical/Current | The ISO 8601 date/time that the minimum feels like temperature occurred | periods.#.feelslike.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Average feels like temperature in Celsius | Historical/Current | The average feels like temperature in Celsius | periods.#.feelslike.avgC |
conditions/summary |
Flex - Base API - Base |
| Average feels like temperature in Fahrenheit | Historical/Current | The average feels like temperature in Fahrenheit | periods.#.feelslike.avgF |
conditions/summary |
Flex - Base API - Base |
| Dew point summary | Historical/Current | The dew point summary object, null if unavailable | periods.#.dewpoint |
conditions/summary |
Flex - Base API - Base |
| Maximum dew point in Celsius | Historical/Current | The maximum dew point in Celsius | periods.#.dewpoint.maxC |
conditions/summary |
Flex - Base API - Base |
| Maximum dew point in Fahrenheit | Historical/Current | The maximum dew point in Fahrenheit | periods.#.dewpoint.maxF |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum dew point occurred | Historical/Current | The unix timestamp that the maximum dew point occurred | periods.#.dewpoint.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum dew point occurred | Historical/Current | The ISO 8601 date/time that the maximum dew point occurred | periods.#.dewpoint.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum dew point in Celsius | Historical/Current | The minimum dew point in Celsius | periods.#.dewpoint.minC |
conditions/summary |
Flex - Base API - Base |
| Minimum dew point in Fahrenheit | Historical/Current | The minimum dew point in Fahrenheit | periods.#.dewpoint.minF |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum dew point occurred | Historical/Current | The unix timestamp that the minimum dew point occurred | periods.#.dewpoint.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum dew point occurred | Historical/Current | The ISO 8601 date/time that the minimum dew point occurred | periods.#.dewpoint.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Average dew point in Celsius | Historical/Current | The average dew point in Celsius | periods.#.dewpoint.avgC |
conditions/summary |
Flex - Base API - Base |
| Average dew point in Fahrenheit | Historical/Current | The average dew point in Fahrenheit | periods.#.dewpoint.avgF |
conditions/summary |
Flex - Base API - Base |
| Relative humidity summary | Historical/Current | The relative humidity summary object, null if unavailable | periods.#.humidity |
conditions/summary |
Flex - Base API - Base |
| Maximum relative humidity | Historical/Current | The maximum relative humidity. From 0 to 100 | periods.#.humidity.max |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum relative humidity occurred | Historical/Current | The unix timestamp that the maximum relative humidity occurred | periods.#.humidity.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum relative humidity occurred | Historical/Current | The ISO 8601 date/time that the maximum relative humidity occurred | periods.#.humidity.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum relative humidity | Historical/Current | The minimum relative humidity. From 0 to 100 | periods.#.humidity.min |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum relative humidity occurred | Historical/Current | The unix timestamp that the minimum relative humidity occurred | periods.#.humidity.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum relative humidity occurred | Historical/Current | The ISO 8601 date/time that the minimum relative humidity occurred | periods.#.humidity.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Average relative humidity | Historical/Current | The average relative humidity. From 0 to 100 | periods.#.humidity.avg |
conditions/summary |
Flex - Base API - Base |
| Wind speed summary object | Historical/Current | The wind speed summary object, null if unavailable | periods.#.windSpeed |
conditions/summary |
Flex - Base API - Base |
| Maximum wind speed in knots | Historical/Current | The maximum wind speed in knots | periods.#.windSpeed.maxKTS |
conditions/summary |
Flex - Base API - Base |
| Maximum wind speed in kilometers per hour | Historical/Current | The maximum wind speed in kilometers per hour | periods.#.windSpeed.maxKPH |
conditions/summary |
Flex - Base API - Base |
| Maximum wind speed in miles per hour | Historical/Current | The maximum wind speed in miles per hour | periods.#.windSpeed.maxMPH |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum wind speed occurred | Historical/Current | The unix timestamp that the maximum wind speed occurred | periods.#.windSpeed.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum wind speed occurred | Historical/Current | The ISO 8601 date/time that the maximum wind speed occurred | periods.#.windSpeed.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Cardinal wind direction at the time of the maximum wind speed | Historical/Current | The cardinal wind direction at the time of the maximum wind speed. | periods.#.windSpeed.maxDir |
conditions/summary |
Flex - Base API - Base |
| Wind direction, in degrees, at the time of the maximum wind speed | Historical/Current | The wind direction, in degrees, at the time of the maximum wind speed. | periods.#.windSpeed.maxDirDEG |
conditions/summary |
Flex - Base API - Base |
| Minimum wind speed in knots | Historical/Current | The minimum wind speed in knots | periods.#.windSpeed.minKTS |
conditions/summary |
Flex - Base API - Base |
| Minimum wind speed in kilometers per hour | Historical/Current | The minimum wind speed in kilometers per hour | periods.#.windSpeed.minKPH |
conditions/summary |
Flex - Base API - Base |
| Minimum wind speed in miles per hour | Historical/Current | The minimum wind speed in miles per hour | periods.#.windSpeed.minMPH |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum wind speed occurred | Historical/Current | The unix timestamp that the minimum wind speed occurred | periods.#.windSpeed.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum wind speed occurred | Historical/Current | The ISO 8601 date/time that the minimum wind speed occurred | periods.#.windSpeed.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Cardinal wind direction at the time of the minimum wind speed | Historical/Current | The cardinal wind direction at the time of the minimum wind speed. | periods.#.windSpeed.minDir |
conditions/summary |
Flex - Base API - Base |
| The wind direction, in degrees, at the time of the minimum wind speed | Historical/Current | The wind direction, in degrees, at the time of the minimum wind speed. | periods.#.windSpeed.minDirDEG |
conditions/summary |
Flex - Base API - Base |
| Average wind speed in knots | Historical/Current | The average wind speed in knots | periods.#.windSpeed.avgKTS |
conditions/summary |
Flex - Base API - Base |
| Average wind speed in kilometers per hour | Historical/Current | The average wind speed in kilometers per hour | periods.#.windSpeed.avgKPH |
conditions/summary |
Flex - Base API - Base |
| Average wind speed in miles per hour | Historical/Current | The average wind speed in miles per hour | periods.#.windSpeed.avgMPH |
conditions/summary |
Flex - Base API - Base |
| Wind gust speed summary object | Historical/Current | The wind gust speed summary object, null if unavailable | periods.#.windGust |
conditions/summary |
Flex - Base API - Base |
| Maximum wind gust in knots | Historical/Current | The maximum wind gust in knots | periods.#.windGust.maxKTS |
conditions/summary |
Flex - Base API - Base |
| Maximum wind gust in kilometers per hour | Historical/Current | The maximum wind gust in kilometers per hour | periods.#.windGust.maxKPH |
conditions/summary |
Flex - Base API - Base |
| Maximum wind gust in miles per hour | Historical/Current | The maximum wind gust in miles per hour | periods.#.windGust.maxMPH |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum wind gust occurred | Historical/Current | The unix timestamp that the maximum wind gust occurred | periods.#.windGust.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum wind gust occurred | Historical/Current | The ISO 8601 date/time that the maximum wind gust occurred | periods.#.windGust.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum wind gust in knots | Historical/Current | The minimum wind gust in knots | periods.#.windGust.minKTS |
conditions/summary |
Flex - Base API - Base |
| Minimum wind gust in kilometers per hour | Historical/Current | The minimum wind gust in kilometers per hour | periods.#.windGust.minKPH |
conditions/summary |
Flex - Base API - Base |
| Minimum wind gust in miles per hour | Historical/Current | The minimum wind gust in miles per hour | periods.#.windGust.minMPH |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum wind gust occurred | Historical/Current | The unix timestamp that the minimum wind gust occurred | periods.#.windGust.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum wind gust occurred | Historical/Current | The ISO 8601 date/time that the minimum wind gust occurred | periods.#.windGust.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Average wind gust in knots | Historical/Current | The average wind gust in knots | periods.#.windGust.avgKTS |
conditions/summary |
Flex - Base API - Base |
| Average wind gust in kilometers per hour | Historical/Current | The average wind gust in kilometers per hour | periods.#.windGust.avgKPH |
conditions/summary |
Flex - Base API - Base |
| Average wind gust in miles per hour | Historical/Current | The average wind gust in miles per hour | periods.#.windGust.avg.MPH |
conditions/summary |
Flex - Base API - Base |
| Precipitation rate summary object | Historical/Current | The precipitation rate summary object. Null if unavailable | periods.#.precip |
conditions/summary |
Flex - Base API - Base |
| Maximum precipitation rate in millimeters / hour | Historical/Current | The maximum precipitation rate in millimeters / hour | periods.#.precip.maxMM |
conditions/summary |
Flex - Base API - Base |
| Maximum precipitation rate in inches / hour | Historical/Current | The maximum precipitation rate in inches / hour | periods.#.precip.maxIN |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum precipitation rate occurred | Historical/Current | The unix timestamp that the maximum precipitation rate occurred | periods.#.precip.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum precipitation rate occurred | Historical/Current | The ISO 8601 date/time that the maximum precipitation rate occurred | periods.#.precip.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum precipitation rate in millimeters / hour | Historical/Current | The minimum precipitation rate in millimeters / hour | periods.#.precip.minMM |
conditions/summary |
Flex - Base API - Base |
| Minimum precipitation rate in inches / hour | Historical/Current | The minimum precipitation rate in inches / hour | periods.#.precip.minIN |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum precipitation rate occurred | Historical/Current | The unix timestamp that the minimum precipitation rate occurred | periods.#.precip.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum precipitation rate occurred | Historical/Current | The ISO 8601 date/time that the minimum precipitation rate occurred | periods.#.precip.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Total estimated precipitation in millimeters | Historical/Current | The total estimated precipitation for the requested period (daily by default), in millimeters | periods.#.precip.totalMM |
conditions/summary |
Flex - Base API - Base |
| Total estimated precipitation rate in inches | Historical/Current | The total estimated precipitation for the requested period (daily by default), in inches | periods.#.precip.totalIN |
conditions/summary |
Flex - Base API - Base |
| Snowfall rate summary object | Historical/Current | The snowfall rate summary object. Null if unavailable | periods.#.snow |
conditions/summary |
Flex - Base API - Base |
| Maximum snowfall rate in centimeters / hour | Historical/Current | The maximum snowfall rate in centimeters / hour | periods.#.snow.maxCM |
conditions/summary |
Flex - Base API - Base |
| Maximum snowfall rate in inches / hour | Historical/Current | The maximum snowfall rate in inches / hour | periods.#.snow.maxIN |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum snowfall rate occurred | Historical/Current | The unix timestamp that the maximum snowfall rate occurred | periods.#.snow.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum snowfall rate occurred | Historical/Current | The ISO 8601 date/time that the maximum precipitation rate occurred | periods.#.snow.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum snowfall rate in centimeters / hour | Historical/Current | The minimum snowfall rate in centimeters/ hour | periods.#.snow.minCM |
conditions/summary |
Flex - Base API - Base |
| Minimum snowfall rate in inches / hour | Historical/Current | The minimum snowfall rate in inches / hour | periods.#.snow.minIN |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum snowfall rate occurred | Historical/Current | The unix timestamp that the minimum snowfall rate occurred | periods.#.snow.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum snowfall rate occurred | Historical/Current | The ISO 8601 date/time that the minimum precipitation rate occurred | periods.#.snow.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Total estimated snowfall in centimeters / hour | Historical/Current | The total estimated snowfall in centimeters / hour | periods.#.snow.totalCM |
conditions/summary |
Flex - Base API - Base |
| Total estimated snowfall rate in inches / hour | Historical/Current | The total estimated snowfall in inches / hour | periods.#.snow.totalIN |
conditions/summary |
Flex - Base API - Base |
| Snow depth summary object | Historical/Current | The snow depth summary object. Null if unavailable. Historical data for snow depth is available after September, 7th 2023. | periods.#.snowDepth |
conditions/summary |
Flex - Base API - Base |
| Snow depth summary object | Historical/Current | The snow depth summary object. Null if unavailable. Historical data for snow depth is available after September, 7th 2023. | periods.#.snowDepth |
conditions/summary |
Flex - Base API - Base |
| Maximum snow depth in centimeters | Historical/Current | The maximum snow depth in centimeters | periods.#.snowDepth.maxCM |
conditions/summary |
Flex - Base API - Base |
| Maximum snow depth in centimeters | Historical/Current | The maximum snow depth in centimeters | periods.#.snowDepth.maxCM |
conditions/summary |
Flex - Base API - Base |
| Maximum snow depth in centimeters | Historical/Current | The maximum snow depth in centimeters | periods.#.snowDepth.maxIN |
conditions/summary |
Flex - Base API - Base |
| Maximum snow depth in centimeters | Historical/Current | The maximum snow depth in centimeters | periods.#.snowDepth.maxIN |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum snow depth occurred | Historical/Current | The unix timestamp that the maximum snow depth occurred | periods.#.snowDepth.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum snow depth occurred | Historical/Current | The unix timestamp that the maximum snow depth occurred | periods.#.snowDepth.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum snow depth occurred | Historical/Current | The ISO 8601 date/time that the maximum snow depth occurred | periods.#.snowDepth.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum snow depth occurred | Historical/Current | The ISO 8601 date/time that the maximum snow depth occurred | periods.#.snowDepth.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum snow depth in centimeters | Historical/Current | The minimum snow depth in centimeters | periods.#.snowDepth.minCM |
conditions/summary |
Flex - Base API - Base |
| Minimum snow depth in centimeters | Historical/Current | The minimum snow depth in centimeters | periods.#.snowDepth.minCM |
conditions/summary |
Flex - Base API - Base |
| Minimum snow depth in centimeters | Historical/Current | The minimum snow depth in centimeters | periods.#.snowDepth.minIN |
conditions/summary |
Flex - Base API - Base |
| Minimum snow depth in centimeters | Historical/Current | The minimum snow depth in centimeters | periods.#.snowDepth.minIN |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum snow depth occurred | Historical/Current | The unix timestamp that the minimum snow depth occurred | periods.#.snowDepth.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum snow depth occurred | Historical/Current | The unix timestamp that the minimum snow depth occurred | periods.#.snowDepth.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum snow depth occurred | Historical/Current | The ISO 8601 date/time that the minimum snow depth occurred | periods.#.snowDepth.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum snow depth occurred | Historical/Current | The ISO 8601 date/time that the minimum snow depth occurred | periods.#.snowDepth.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Average snow depth in centimeters | Historical/Current | The average snow depth in centimeters | periods.#.snowDepth.avgCM |
conditions/summary |
Flex - Base API - Base |
| Average snow depth in centimeters | Historical/Current | The average snow depth in centimeters | periods.#.snowDepth.avgCM |
conditions/summary |
Flex - Base API - Base |
| Average snow depth in centimeters | Historical/Current | The average snow depth in centimeters | periods.#.snowDepth.avgIN |
conditions/summary |
Flex - Base API - Base |
| Average snow depth in centimeters | Historical/Current | The average snow depth in centimeters | periods.#.snowDepth.avgIN |
conditions/summary |
Flex - Base API - Base |
| Pressure summary | Historical/Current | The pressure summary object. Null if unavailable | periods.#.pressure |
conditions/summary |
Flex - Base API - Base |
| Maximum mean sea level pressure in millibars | Historical/Current | The maximum mean sea level pressure in millibars | periods.#.pressure.maxMB |
conditions/summary |
Flex - Base API - Base |
| Maximum mean sea level pressure in inches mercury | Historical/Current | The maximum mean sea level pressure in inches mercury | periods.#.pressure.maxIN |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum mean sea level pressure occurred | Historical/Current | The unix timestamp that the maximum mean sea level pressure occurred | periods.#.pressure.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum mean sea level pressure occurred | Historical/Current | The ISO 8601 date/time that the maximum mean sea level pressure occurred | periods.#.pressure.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum mean sea level pressure in millibars | Historical/Current | The minimum mean sea level pressure in millibars | periods.#.pressure.minMB |
conditions/summary |
Flex - Base API - Base |
| Minimum mean sea level pressure in inches mercury | Historical/Current | The minimum mean sea level pressure in inches mercury | periods.#.pressure.minIN |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum mean sea level pressure occurred | Historical/Current | The unix timestamp that the minimum mean sea level pressure occurred | periods.#.pressure.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum mean sea level pressure occurred | Historical/Current | The ISO 8601 date/time that the minimum mean sea level pressure occurred | periods.#.pressure.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Average mean sea level pressure in millibars | Historical/Current | The average mean sea level pressure in millibars | periods.#.pressure.avgMB |
conditions/summary |
Flex - Base API - Base |
| Average mean sea level pressure in inches mercury | Historical/Current | The average mean sea level pressure in inches mercury | periods.#.pressure.avgIN |
conditions/summary |
Flex - Base API - Base |
| Visibility summary object | Historical/Current | The visibility summary object. Null if unavailable | periods.#.visibility |
conditions/summary |
Flex - Base API - Base |
| Maximum visibility in kilometers | Historical/Current | The maximum visibility in kilometers | periods.#.visibility.maxKM |
conditions/summary |
Flex - Base API - Base |
| Maximum visibility in miles | Historical/Current | The maximum visibility in miles | periods.#.visibility.maxMI |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum visibility occurred | Historical/Current | The unix timestamp that the maximum visibility occurred | periods.#.visibility.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum visibility occurred | Historical/Current | The ISO 8601 date/time that the maximum visibility occurred | periods.#.visibility.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum visibility in kilometers | Historical/Current | The minimum visibility in kilometers | periods.#.visibility.minKM |
conditions/summary |
Flex - Base API - Base |
| Minimum visibility in miles | Historical/Current | The minimum visibility in miles | periods.#.visibility.minMI |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum visibility occurred | Historical/Current | The unix timestamp that the minimum visibility occurred | periods.#.visibility.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum visibility occurred | Historical/Current | The ISO 8601 date/time that the minimum visibility occurred | periods.#.visibility.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Average visibility in kilometers | Historical/Current | The average visibility in kilometers | periods.#.visibility.avgKM |
conditions/summary |
Flex - Base API - Base |
| Average visibility in miles | Historical/Current | The average visibility in miles | periods.#.visibility.avgMI |
conditions/summary |
Flex - Base API - Base |
| Sky / clouds summary object. Null if unavailable | Historical/Current | The sky / clouds summary object. Null if unavailable | periods.#.sky |
conditions/summary |
Flex - Base API - Base |
| Maximum cloud coverage | Historical/Current | The maximum cloud coverage, from 0 - 100%. | periods.#.sky.max |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the maximum cloud coverage occurred | Historical/Current | The unix timestamp that the maximum cloud coverage occurred | periods.#.sky.maxTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the maximum cloud coverage occurred | Historical/Current | The ISO 8601 date/time that the maximum cloud coverage occurred | periods.#.sky.maxDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Minimum cloud coverage | Historical/Current | The minimum cloud coverage, from 0 - 100%. | periods.#.sky.min |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the minimum cloud coverage occurred | Historical/Current | The unix timestamp that the minimum cloud coverage occurred | periods.#.sky.minTimestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the minimum cloud coverage occurred | Historical/Current | The ISO 8601 date/time that the minimum cloud coverage occurred | periods.#.sky.minDateTimeISO |
conditions/summary |
Flex - Base API - Base |
| The average cloud coverage | Historical/Current | The average cloud coverage, from 0 - 100%. | periods.#.sky.avg |
conditions/summary |
Flex - Base API - Base |
| Array of cloud codes | Historical/Current | Array of cloud codes. An entry for each time in the summary the cloud code changed. | periods.#.sky.coded |
conditions/summary |
Flex - Base API - Base |
| Two letter cloud code | Historical/Current | Two letter cloud code. See Cloud codes | periods.#.sky.coded.#.code |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the cloud coverage change occurred | Historical/Current | The unix timestamp that the cloud coverage change occurred | periods.#.sky.coded.#.timestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the cloud coverage change occurred | Historical/Current | The ISO 8601 date/time that the cloud coverage change occurred | periods.#.sky.coded.#.dateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Weather summary object | Historical/Current | The weather summary object. Null if unavailable | periods.#.weather |
conditions/summary |
Flex - Base API - Base |
| Weather phrase for the summary period | Historical/Current | The weather phrase for the summary period. | periods.#.weather.phrase |
conditions/summary |
Flex - Base API - Base |
| Primary weather that occurred during the summary period | Historical/Current | The primary weather that occurred during the summary period. | periods.#.weather.primary |
conditions/summary |
Flex - Base API - Base |
| Coded version of the primary weather that occurred during the summary period | Historical/Current | The coded version of the primary weather that occurred during the summary period. See Weather Codes. | periods.#.weather.primaryCoded |
conditions/summary |
Flex - Base API - Base |
| Icon representing the primary weather | Historical/Current | The icon representing the primary weather | periods.#.weather.icon |
conditions/summary |
Flex - Base API - Base |
| An array of weather code | Historical/Current | An array of weather code. An entry for each time the weather changed during the summary period. | periods.#.weather.coded |
conditions/summary |
Flex - Base API - Base |
| Weather code | Historical/Current | The weather code. See Weather Codes. | periods.#.weather.coded.#.code |
conditions/summary |
Flex - Base API - Base |
| Timestamp that the weather change occurred | Historical/Current | The unix timestamp that the weather change occurred | periods.#.weather.coded.#.timestamp |
conditions/summary |
Flex - Base API - Base |
| Date/time that the weather change occurred | Historical/Current | The ISO 8601 date/time that the weather change occurred | periods.#.weather.coded.#.dateTimeISO |
conditions/summary |
Flex - Base API - Base |
| Outlook ID | Current/Forecast | The outlook ID | id |
convective/outlook |
API - Base Flex - Base |
| Object details | Current/Forecast | Object of the outlook details | details |
convective/outlook |
API - Base Flex - Base |
| Product type | Current/Forecast | The product type. Should normally be "convective" | details.product |
convective/outlook |
API - Base Flex - Base |
| Outlook category type | Current/Forecast | The outlook category type. | details.category |
convective/outlook |
API - Base Flex - Base |
| Day of coverage | Current/Forecast | Valid coverage day. Value from 1-8 | details.day |
convective/outlook |
API - Base Flex - Base |
| Object of the valid coverage period information | Current/Forecast | Object of the valid coverage period information | details.range |
convective/outlook |
API - Base Flex - Base |
| Timestamp of the start of the coverage period for the outlook | Current/Forecast | Unix timestamp of the start of the coverage period for the outlook | details.range.minTimestamp |
convective/outlook |
API - Base Flex - Base |
| Date of the start of the coverage period for the outlook | Current/Forecast | ISO 8601 date of the start of the coverage period for the outlook | details.range.minDateTimeISO |
convective/outlook |
API - Base Flex - Base |
| Timestamp of the end of the coverage period for the outlook | Current/Forecast | Unix timestamp of the end of the coverage period for the outlook | details.range.maxTimestamp |
convective/outlook |
API - Base Flex - Base |
| Date of the end of the coverage period for the outlook | Current/Forecast | ISO 8601 date of the end of the coverage period for the outlook | details.range.maxDateTimeISO |
convective/outlook |
API - Base Flex - Base |
| Timestamp of the issue date/time for the outlook | Current/Forecast | Unix timestamp of the issue date/time for the outlook | details.issuedTimestamp |
convective/outlook |
API - Base Flex - Base |
| Date of the issue date/time for the outlook | Current/Forecast | ISO 8601 date of the issue date/time for the outlook | details.issuedDateTimeISO |
convective/outlook |
API - Base Flex - Base |
| Object of the risk associated with the outlook | Current/Forecast | Object of the risk associated with the outlook. NULL if no associated risk | details.risk |
convective/outlook |
API - Base Flex - Base |
| Abbreviated risk type | Current/Forecast | The abbreviated risk type | details.risk.type |
convective/outlook |
API - Base Flex - Base |
| Risk name | Current/Forecast | The full risk name as provided by SPC | details.risk.name |
convective/outlook |
API - Base Flex - Base |
| Coded version of the risk | Current/Forecast | The coded version of the risk | details.risk.code |
convective/outlook |
API - Base Flex - Base |
| GeoJSON object, normally a Polygon or MultiPolygon, for the coverage area | Current/Forecast | GeoJSON object, normally a Polygon or MultiPolygon, for the coverage area. NULL if the geo filter is not provided AND / OR there is no associated risk with the outlook. |
geoPoly |
convective/outlook |
API - Base Flex - Base |
| Name of the country | Current | The name of the country. | place.name |
countries |
API - Base Flex - Base |
| Country's 2-letter abbreviation | Current | The country's 2-letter ISO abbreviation. | place.iso |
countries |
API - Base Flex - Base |
| Country's 3-letter abbreviation | Current | The country's 3-letter ISO abbreviation. | place.iso3 |
countries |
API - Base Flex - Base |
| Country's 3-digit ID | Current | The country's 3-digit ISO numeric ID, kept as a string to preserve leading zeros. | place.isoNum |
countries |
API - Base Flex - Base |
| Country's FIPS abbreviation | Current | The country's FIPS abbreviation. | place.fips |
countries |
API - Base Flex - Base |
| Continent abbreviation that the country resides | Current | The continent abbreviation that the country primarily resides. | place.continent |
countries |
API - Base Flex - Base |
| Name of the capital city of the country | Current | The name of the capital city of the country. | profile.capital |
countries |
API - Base Flex - Base |
| Area in square kilometers | Current | The approximate area in square kilometers. NOTE: Area values are not guaranteed to be accurate and are for general use in limiting results | profile.areaKM |
countries |
API - Base Flex - Base |
| Area in square miles | Current | The approximate area in square miles. NOTE: Area values are not guaranteed to be accurate and are for general use in limiting results | profile.areaMI |
countries |
API - Base Flex - Base |
| Population of the country | Current | The approximate population of the country. NOTE: Population values are not guaranteed to be accurate and are for general use in limiting results | profile.pop |
countries |
API - Base Flex - Base |
| Abbreviations for the neighboring countries | Current | An array of 2-letter ISO abbreviations for the neighboring countries. | profile.neighbors |
countries |
API - Base Flex - Base |
| ID of the drought category | id |
droughts/monitor |
API - Base Flex - Base |
||
| Object of the drought category details | details |
droughts/monitor |
API - Base Flex - Base |
||
| Product ID. Currently always usdm | details.product |
droughts/monitor |
API - Base Flex - Base |
||
| The Drought category: D0 D1 D2 D3 D4 |
details.category |
droughts/monitor |
API - Base Flex - Base |
||
| Object containing the min/max time ranges for the drought category | details.range |
droughts/monitor |
API - Base Flex - Base |
||
| The minimum time range as a unix timestamp in seconds | details.range.minTimestamp |
droughts/monitor |
API - Base Flex - Base |
||
| The ISO8601 minimum time range | details.range.minDateTimeISO |
droughts/monitor |
API - Base Flex - Base |
||
| The maximum time range as a unix timestamp in seconds | details.range.maxTimestamp |
droughts/monitor |
API - Base Flex - Base |
||
| The ISO8601 maximum time range | details.range.maxDateTimeISO |
droughts/monitor |
API - Base Flex - Base |
||
| The issued time as a Unix timestamp in seconds | details.issuedTimestamp |
droughts/monitor |
API - Base Flex - Base |
||
| The ISO8601 date for the issued date/time | details.issuedDateTimeISO |
droughts/monitor |
API - Base Flex - Base |
||
| An Object with the risk information | details.risk |
droughts/monitor |
API - Base Flex - Base |
||
| The drought category: D0 D1 D2 D3 D4 |
details.risk.type |
droughts/monitor |
API - Base Flex - Base |
||
| Phrase representing the risk | details.risk.name |
droughts/monitor |
API - Base Flex - Base |
||
| The risk code from 0 - 4 (matches the # within the category and risk.type) | details.risk.code |
droughts/monitor |
API - Base Flex - Base |
||
| GeoJSON object if the drought area. Will be either a Polygon or a MultiPolygon. Null if not requested (i.e. if filter=geo not provided) | geoPoly |
droughts/monitor |
API - Base Flex - Base |
||
| Earthquake ID | Current | The USGS earthquake ID. | report.id |
earthquakes |
API - Base Flex - Base |
| Timestamp when the event took place | Current | UNIX timestamp when the event took place. | report.timestamp |
earthquakes |
API - Base Flex - Base |
| Date of the date/time of the event | Current | ISO 8601 date of the date/time of the event. | report.dateTimeISO |
earthquakes |
API - Base Flex - Base |
| Magnitude of the earthquake | Current | The magnitude of the earthquake. Null if unavailable. | report.mag |
earthquakes |
API - Base Flex - Base |
| Earthquake category | Current | The earthquake category: - mini: 0 - 2.9 - minor: 3 - 3.9 - light: 4 - 4.9 - moderate: 5 - 5.9 - strong: 6 - 6.9 - major: 7 - 7.9 - great: 8.0+ |
report.type |
earthquakes |
API - Base Flex - Base |
| Earthquake depth in kilometers | Current | The depth of the earthquake in kilometers. | report.depthKM |
earthquakes |
API - Base Flex - Base |
| Earthquake depth in miles | Current | The depth of the earthquake in miles. | report.depthMI |
earthquakes |
API - Base Flex - Base |
| Region that the event occurred | Current | The USGS region that the event occurred. | report.region |
earthquakes |
API - Base Flex - Base |
| Location description | Current | The brief description of the location, usually contains the location or relative distance from a city. | report.location |
earthquakes |
API - Base Flex - Base |
| Current/Forecast | ID of the site which following the [region]_[site-name] format. | id |
energy/farm | API Developer | |
| Current/Forecast | Upstream service that provides the raw data. | dataSource |
energy/farm | API Developer | |
| Current/Forecast | Renewable energy name. | place.name |
energy/farm | API Developer | |
| Current/Forecast | 2 digit state code where the site is located. | place.state |
energy/farm | API Developer | |
| Current/Forecast | County where site is located. | place.county |
energy/farm | API Developer | |
| Current/Forecast | 2 digit country code where the site is located. | place.country |
energy/farm | API Developer | |
| Current/Forecast | The period ending unix timestamp associated with the powerKW value. | periods.#.timestamp |
energy/farm | API Developer | |
| Current/Forecast | The period ending ISO 8601 date/time associated with the powerKW value. | periods.#.dateTimeISO |
energy/farm | API Developer | |
| Current/Forecast | Output in power for the time period in killowatts. | periods.#.powerKW |
energy/farm | API Developer | |
| Current/Forecast | Flag indicating whether this period is a forecast or estimated observation. | periods.#.isForecast |
energy/farm | API Developer | |
| Current/Forecast | The timezone name associated with the site's location. | profile.tz |
energy/farm | API Developer | |
| Current/Forecast | The time zone name abbreviation, if one. Such as EST, EDT etc. | profile.tzname |
energy/farm | API Developer | |
| Current/Forecast | The time zone offset in seconds from UTC time. | profile.tzoffset |
energy/farm | API Developer | |
| Current/Forecast | True is the location is in Daylight Savings Time for that time frame. | profile.isDST |
energy/farm | API Developer | |
| Current/Forecast | List of plant codes related to the site. | profile.site.eiaPlantCodes |
energy/farm | API Developer | |
| Current/Forecast | Maximum capacity for the power output at a given time for this site. | profile.site.maxCapacityKW |
energy/farm | API Developer | |
| Current/Forecast | Hardware model for the sites renewable energy components. | profile.hardwareModel |
energy/farm | API Developer | |
| Current/Forecast | Date when the site went live. | profile.onlineDate |
energy/farm | API Developer | |
| Current/Forecast | Region associated with this site. | profile.region.name |
energy/farm | API Developer | |
| Current/Forecast | If any, regional subgroup for the site. | profile.region.subgroup |
energy/farm | API Developer | |
| Current/Forecast | The elevation of the location in feet. | profile.elevFT |
energy/farm | API Developer | |
| Current/Forecast | The elevation of the location in meters. | profile.elevM |
energy/farm | API Developer | |
| ID of the fire | Current | The ID of the fire. | report.id |
fires |
API - Base Flex - Base |
| Type of fire observation | Current | (Deprecated) The type of fire observation: - L = Confirmed Large fire as determined by the USFS |
report.type |
fires |
API - Base Flex - Base |
| Timestamp of the fire observation | Current | UNIX timestamp of the fire observation. | report.timestamp |
fires |
API - Base Flex - Base |
| Date of the observation | Current | ISO 8601 date of the observation, localized to the observation location. | report.dateTimeISO |
fires |
API - Base Flex - Base |
| For critical/large fires a name may be given | Current | For critical/large fires a name may be given. NULL if no name. | report.name |
fires |
API - Base Flex - Base |
| Description of location of the fire | Current | Description of location of the fire. | report.location |
fires |
API - Base Flex - Base |
| Timestamp of the start of the fire | Current | UNIX timestamp of the start of the fire. Usually only given for Critical/Large fires, but not always. NULL if not available. | report.startTimestamp |
fires |
API - Base Flex - Base |
| Date of the start date of the fire | Current | ISO 8601 date of the start date of the fire, localized to the observation location. Usually only given for Critical/Large fires, but not always. NULL if not available. | report.startDateISO |
fires |
API - Base Flex - Base |
| Confidence of the fire as a percentage | Current | The confidence of the fire as a percentage. | report.conf |
fires |
API - Base Flex - Base |
| Estimated coverage area of the fire in square kilometers | Current | The estimated coverage area of the fire in square kilometers. NULL if unknown. NOTE: Satellite based observations are rough estimates only, limited by resolution of detection method. | report.areaKM |
fires |
API - Base Flex - Base |
| Estimated coverage area of the fire in square miles | Current | The estimated coverage area of the fire in square miles. NULL if unknown. NOTE: Satellite based observations are rough estimates only, limited by resolution of detection method. | report.areaMI |
fires |
API - Base Flex - Base |
| Estimated coverage area of the fire in acres | Current | The estimated coverage area of the fire in acres. NOTE: Satellite based observations are rough estimates only, limited by resolution of detection method. | report.areaAC |
fires |
API - Base Flex - Base |
| Percentage of the fire that is contained | Current | The percentage of the fire that is contained. Usually only given for Critical/Large fires, but not always. NULL if not available. | report.perContained |
fires |
API - Base Flex - Base |
| (Deprecated) Object available for Satellite detected observation | Current | (Deprecated) Object available for Satellite detected observations. Will be NULL | report.sat |
fires |
API - Base Flex - Base |
| Timestamp of the expected date of containment | Current | UNIX timestamp of the expected date of containment. NULL if unknown. | report.expContainedTimestamp |
fires |
API - Base Flex - Base |
| Date of the expected date of containment | Current | ISO 8601 date of the expected date of containment. NULL if unknown. | report.expContainedISO |
fires |
API - Base Flex - Base |
| Cause of the fire | Current | Cause of the fire. NULL if unknown. | report.cause |
fires |
API - Base Flex - Base |
| Incident team type | Current | Incident team type: 0, 1, 2, other, or nimo. NULL if unknown. Utilized with large fires, data provided by USFS. | report.imtType |
fires |
API - Base Flex - Base |
| Fuels for the fire | Current | Fuels for the fire. NULL if unknown. | report.fuels |
fires |
API - Base Flex - Base |
| Information on the terrain | Current | Information on the terrain. NULL if unknown. | report.terrain |
fires |
API - Base Flex - Base |
| Fire perimeter information | Current | Fire perimeter information. Currently available for larger US fires. NULL if not available | perimeter |
fires |
API - Base Flex - Base |
| Fire perimeter start timestamp | Current | The UNIX timestamp of the start of the fire perimeter. Often matches to the fire report.startTimestamp, though some fires may represent the data the perimeter was created. | perimeter.startTimestamp |
fires |
API - Base Flex - Base |
| Fire perimeter start date | Current | The ISO 8601 timestamp of the start of the fire perimeter. Often matches to the fire report.startDateISO, though some fires may represent the data the perimeter was created. | perimeter.startDateISO |
fires |
API - Base Flex - Base |
| Fire perimeter update timestamp | Current | The UNIX timestamp of the date and time the fire perimeter information was last updated. | perimeter.modifiedTimestamp |
fires |
API - Base Flex - Base |
| Fire perimeter update date/time | Current | The ISO 8601 timestamp of the date and time the fire perimeter information was last updated. | perimeter.modifiedDateTimeISO |
fires |
API - Base Flex - Base |
| The area of the fire perimeter in square KM | Current | The area of the fire perimeter in square kilometers. | perimeter.areaKM |
fires |
API - Base Flex - Base |
| The area of the fire perimeter in square miles | Current | The area of the fire perimeter in square miles. | perimeter.areaMI |
fires |
API - Base Flex - Base |
| The area of the fire perimeter in acres | Current | The area of the fire perimeter in acres. | perimeter.areaAC |
fires |
API - Base Flex - Base |
| The fire perimeter polygon object | Current | The perimeter polygon as a GeoJSON object. Null if filter=geo is not provided. | perimeter.polygon |
fires |
API - Base Flex - Base |
| The fire perimeter polygon type | Current | The type of fire perimeter GeoJSON object. Will be either Polygon or MultiPolygon | perimeter.polygon.type |
fires |
API - Base Flex - Base |
| An array of the GeoJSON fire perimeter | Current | An array of the GeoJSON fire perimeter. | perimeter.polygon.coordinates |
fires |
API - Base Flex - Base |
| The outlook ID | Forecast | The outlook ID. | id |
fires/outlook |
API - Base Flex - Base |
| Interval between periods | Forecast | The interval between periods. | interval |
forecasts |
API - Base Flex - Base |
| Timestamp (UNIX) | Forecast | UNIX timestamp of the forecast valid time. | periods[#].timestamp |
forecasts |
API - Base Flex - Base |
| Localized time of the forecast | Forecast | Localized valid time of the forecast. (Deprecated. Use dateTimeISO) | periods[#].validTime |
forecasts |
API - Base Flex - Base |
| Time of Forecast (ISO 8601) | Forecast | ISO 8601 of the valid time of the forecast. | periods[#].dateTimeISO |
forecasts |
API - Base Flex - Base |
| Forecast Max Temperature (C) | Forecast | The maximum expected temperature in Celsius for the forecast period. Provided with filter=day (Default), mdnt2mdnt, and for the day time periods with filter=daynight, otherwise null. |
periods[#].maxTempC |
forecasts |
API - Base Flex - Base |
| Forecast Max Temperature (F) | Forecast | The maximum expected temperature in Fahrenheit for the forecast period. Provided with filter=day (Default), mdnt2mdnt, and for the day time periods with filter=daynight, otherwise null. |
periods[#].maxTempF |
forecasts |
API - Base Flex - Base |
| Forecast Min Temperature (C) | Forecast | The minimum expected temperature in Celsius for the forecast period. Provided with filter=day (Default) and for the night time periods with filter=daynight, otherwise null. |
periods[#].minTempC |
forecasts |
API - Base Flex - Base |
| Forecast Min Temperature (F) | Forecast | The minimum expected temperature in Fahrenheit for the forecast period. Provided with filter=day (Default) and for the night time periods with filter=daynight, otherwise null. |
periods[#].minTempF |
forecasts |
API - Base Flex - Base |
| Forecast Average Temperature (C) | Forecast | Average temperature in Celsius for the forecast period. | periods[#].avgTempC |
forecasts |
API - Base Flex - Base |
| Forecast Average Temperature (F) | Forecast | Average temperature in Fahrenheit for the forecast period. | periods[#].avgTempF |
forecasts |
API - Base Flex - Base |
| Forecast Temperature (C) | Forecast | The temperature in Celsius at the start of the forecast period. The value will be null when using filter=day, filter=mdnt2mdnt, or filter=daynight. | periods[#].tempC |
forecasts |
API - Base Flex - Base |
| Forecast Temperature. (F) | Forecast | The temperature in Fahrenheit at the start of the forecast period. The value will be null when using filter=day, filter=mdnt2mdnt, or filter=daynight. | periods[#].tempF |
forecasts |
API - Base Flex - Base |
| Forecast Probability of Precipitation (%) | Forecast | Probability of precipitation. A percentage from 0 - 100%. Null if unavailable. | periods[#].pop |
forecasts |
API - Base Flex - Base |
| Forecast Precipitation (mm) | Forecast | Precipitation expected in millimeters. The total liquid equivalent of all precipitation. | periods[#].precipMM |
forecasts |
API - Base Flex - Base |
| Forecast Precipitation (in) | Forecast | Precipitation expected in inches. The total liquid equivalent of all precipitation. | periods[#].precipIN |
forecasts |
API - Base Flex - Base |
| Forecast Snowfall (cm) | Forecast | Snowfall amount in centimeters. | periods[#].snowCM |
forecasts |
API - Base Flex - Base |
| Forecast Snowfall (in) | Forecast | Snowfall amount in inches. | periods[#].snowIN |
forecasts |
API - Base Flex - Base |
| Forecast Accumulated Ice | Forecast | The amount of ice accretion/accumulation in mm. Available for the US only out 48 hours | periods[#].iceaccumMM |
forecasts |
API - Base Flex - Base |
| Forecast Accumulated Ice | Forecast | The amount of ice accretion/accumulation in inches. Available for the US only out 48 hours | periods[#].iceaccumIN |
forecasts |
API - Base Flex - Base |
| Forecast Max Humidity | Forecast | Maximum humidity percentage. | periods[#].maxHumidity |
forecasts |
API - Base Flex - Base |
| Forecast Min Humidity | Forecast | Minimum humidity percentage. | periods[#].minHumidity |
forecasts |
API - Base Flex - Base |
| Forecast Humidity Percentage | Forecast | Humidity percentage. | periods[#].humidity |
forecasts |
API - Base Flex - Base |
| Forecast UV Index (#) | Forecast | The ultraviolet index. Integer from 0 - 12, null if unavailable. Available for the first five days of the forecasts |
periods[#].uvi |
forecasts |
API - Base Flex - Base |
| Forecast Barometric Pressure (mb) | Forecast | Barometric pressure in millibars. | periods[#].pressureMB |
forecasts |
API - Base Flex - Base |
| Forecast Barometric Pressure (in. of mercury) | Forecast | Barometric pressure in inches mercury. | periods[#].pressureIN |
forecasts |
API - Base Flex - Base |
| Forecast Sky Cover (%) | Forecast | Sky cover percentage, 0 = clear, 100 = cloudy. | periods[#].sky |
forecasts |
API - Base Flex - Base |
| Forecast Feels Like Temperature (C) | Forecast | The apparent temperature in Celsius. - Not used/valid when using filter=day or filter=daynight | periods[#].feelslikeC |
forecasts |
API - Base Flex - Base |
| Forecast Feels Like Temperature (F) | Forecast | The apparent temperature in Fahrenheit. - Not used/valid when using filter=day or filter=daynight | periods[#].feelslikeF |
forecasts |
API - Base Flex - Base |
| Forecast Min. Feels Like Temperature (C) | Forecast | The minimum apparent temperature in Celsius. | periods[#].minFeelslikeC |
forecasts |
API - Base Flex - Base |
| Forecast Min. Feels Like Temperature (F) | Forecast | The minimum apparent temperature in Fahrenheit. | periods[#].minFeelslikeF |
forecasts |
API - Base Flex - Base |
| Forecast Max. Feels Like Temperature (C) | Forecast | The maximum apparent temperature in Celsius. | periods[#].maxFeelslikeC |
forecasts |
API - Base Flex - Base |
| Forecast Max. Feels Like Temperature (F) | Forecast | The maximum apparent temperature in Fahrenheit. | periods[#].maxFeelslikeF |
forecasts |
API - Base Flex - Base |
| Forecast Avg. Feels Like Temperature (C) | Forecast | The average apparent temperature in Celsius. | periods[#].avgFeelslikeC |
forecasts |
API - Base Flex - Base |
| Forecast Avg. Feels Like Temperature (F) | Forecast | The average apparent temperature in Fahrenheit. | periods[#].avgFeelslikeF |
forecasts |
API - Base Flex - Base |
| Forecast Dew Point (C) | Forecast | The dew point temperature in Celsius. - Not used/valid when using filter=day or filter=daynight | periods[#].dewpointC |
forecasts |
API - Base Flex - Base |
| Forecast Dew Point (F) | Forecast | The dew point temperature in Fahrenheit. - Not used/valid when using filter=day or filter=daynight | periods[#].dewpointF |
forecasts |
API - Base Flex - Base |
| Forecast Max. Dew Point (C) | Forecast | The maximum dew point temperature in Celsius. | periods[#].maxDewpointC |
forecasts |
API - Base Flex - Base |
| Forecast Max. Dew Point (F) | Forecast | The maximum dew point temperature in Fahrenheit. | periods[#].maxDewpointF |
forecasts |
API - Base Flex - Base |
| Forecast Min. Dew Point (C) | Forecast | The minimum dew point temperature in Celsius. | periods[#].minDewpointC |
forecasts |
API - Base Flex - Base |
| Forecast Min. Dew Point (F) | Forecast | The minimum dew point temperature in Fahrenheit. | periods[#].minDewpointF |
forecasts |
API - Base Flex - Base |
| Forecast Avg. Dew Point (C) | Forecast | The average dew point temperature in Celsius. | periods[#].avgDewpointC |
forecasts |
API - Base Flex - Base |
| Forecast Avg. Dew Point (F) | Forecast | The average dew point temperature in Fahrenheit. | periods[#].avgDewpointF |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction (deg.) | Forecast | The wind direction in degrees. - Not used/valid when using filter=day or filter=daynight | periods[#].windDirDEG |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction (cardinal coordinates) | Forecast | Wind direction in cardinal coordinates. - Not used/valid when using filter=day or filter=daynight | periods[#].windDir |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction (deg.) During Max. Speed | Forecast | The wind direction in degrees (0=North) at the time of maximum wind speed (windSpeedMaxMPH). | periods[#].windDirMaxDEG |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction (cardinal coordinates) During Max. Speed | Forecast | Wind direction in cardinal coordinates at the time of maximum wind speed (windSpeedMaxMPH). | periods[#].windDirMax |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction (deg.) During Min. Speed | Forecast | The wind direction in degrees (0=North) at the time of minimum wind speed (windSpeedMinMPH). | periods[#].windDirMinDEG |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction (cardinal coordinates) During Min. Speed | Forecast | Wind direction in cardinal coordinates at the time of minimum wind speed (windSpeedMinMPH). | periods[#].windDirMin |
forecasts |
API - Base Flex - Base |
| Forecast Wind Gust (kts.) | Forecast | Wind gust in knots. | periods[#].windGustKTS |
forecasts |
API - Base Flex - Base |
| Forecast Wind Gust (kph) | Forecast | Wind gust in kilometers per hour. | periods[#].windGustKPH |
forecasts |
API - Base Flex - Base |
| Forecast Wind Gust (mph) | Forecast | Wind gust in miles per hour. | periods[#].windGustMPH |
forecasts |
API - Base Flex - Base |
| Forecast Wind Speed (kts.) | Forecast | Wind speed in knots. | periods[#].windSpeedKTS |
forecasts |
API - Base Flex - Base |
| Forecast Wind Speed (kph) | Forecast | Wind speed in kilometers per hour. | periods[#].windSpeedKPH |
forecasts |
API - Base Flex - Base |
| Forecast Wind Speed (mph) | Forecast | Wind speed in miles per hour. | periods[#].windSpeedMPH |
forecasts |
API - Base Flex - Base |
| Forecast Max. Wind Speed (kts.) | Forecast | The max wind speed in knots. | periods[#].windSpeedMaxKTS |
forecasts |
API - Base Flex - Base |
| Forecast Max. Wind Speed (kph) | Forecast | The max wind speed in kilometers per hour. | periods[#].windSpeedMaxKPH |
forecasts |
API - Base Flex - Base |
| Forecast Max. Wind Speed (mph) | Forecast | The max wind speed in miles per hour. | periods[#].windSpeedMaxMPH |
forecasts |
API - Base Flex - Base |
| Forecast Min. Wind Speed (kts.) | Forecast | The minimum wind speed in knots. | periods[#].windSpeedMinKTS |
forecasts |
API - Base Flex - Base |
| Forecast Min. Wind Speed (kph) | Forecast | The minimum wind speed in kilometers per hour. | periods[#].windSpeedMinKPH |
forecasts |
API - Base Flex - Base |
| Forecast Min. Wind Speed (mph) | Forecast | The minimum wind speed in miles per hour. | periods[#].windSpeedMinMPH |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction at 80m (deg.) | Forecast | The wind direction in degrees at a height of 80 meters. | periods[#].windDir80mDEG |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction at 80m (cardinal coordinates) | Forecast | Wind direction in cardinal coordinates at a height of 80 meters. | periods[#].windDir80m |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction at 80m (deg.) During Max. Speed | Forecast | The wind direction in degrees (0=North) at the time of maximum wind speed at a height of 80 meters. | periods[#].windDirMax80mDEG |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction at 80m (cardinal coordinates) During Max. Speed | Forecast | Wind direction in cardinal coordinates at the time of maximum wind speed at a height of 80 meters. | periods[#].windDirMax80m |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction at 80m (deg.) During Min. Speed | Forecast | The wind direction in degrees (0=North) at the time of minimum wind speed at a height of 80 meters. | periods[#].windDirMin80mDEG |
forecasts |
API - Base Flex - Base |
| Forecast Wind Direction at 80m (cardinal coordinates) During Min. Speed | Forecast | Wind direction in cardinal coordinates at the time of minimum wind speed at a height of 80 meters. | periods[#].windDirMin80m |
forecasts |
API - Base Flex - Base |
| Forecast Wind Gust (kts.) at 80m | Forecast | Wind gust in knots at a height of 80 meters. | periods[#].windGust80mKTS |
forecasts |
API - Base Flex - Base |
| Forecast Wind Gust (kph) at 80m | Forecast | Wind gust in kilometers per hour at a height of 80 meters. | periods[#].windGust80mKPH |
forecasts |
API - Base Flex - Base |
| Forecast Wind Gust (mph) at 80m | Forecast | Wind gust in miles per hour at a height of 80 meters. | periods[#].windGust80mMPH |
forecasts |
API - Base Flex - Base |
| Forecast Wind Speed (kts.) at 80m | Forecast | The wind speed in knots at a height of 80 meters. | periods[#].windSpeed80mKTS |
forecasts |
API - Base Flex - Base |
| Forecast Wind Speed (kph) at 80m | Forecast | The wind speed in kilometers per hour at a height of 80 meters. | periods[#].windSpeed80mKPH |
forecasts |
API - Base Flex - Base |
| Forecast Wind Speed (mph) at 80m | Forecast | The wind speed in miles per hour at a height of 80 meters. | periods[#].windSpeed80mMPH |
forecasts |
API - Base Flex - Base |
| Forecast Max. Wind Speed (kts.) at 80m | Forecast | The maximum wind speed in knots at a height of 80 meters. | periods[#].windSpeedMax80mKTS |
forecasts |
API - Base Flex - Base |
| Forecast Max. Wind Speed (kph) at 80m | Forecast | The maximum wind speed in kilometers per hour at a height of 80 meters. | periods[#].windSpeedMax80mKPH |
forecasts |
API - Base Flex - Base |
| Forecast Max. Wind Speed (mph) at 80m | Forecast | The maximum wind speed in miles per hour at a height of 80 meters. | periods[#].windSpeedMax80mMPH |
forecasts |
API - Base Flex - Base |
| Forecast Min. Wind Speed (kts.) at 80m | Forecast | The minimum wind speed in knots at a height of 80 meters. | periods[#].windSpeedMin80mKTS |
forecasts |
API - Base Flex - Base |
| Forecast Min. Wind Speed (kph) at 80m | Forecast | The minimum wind speed in kilometers per hour at a height of 80 meters. | periods[#].windSpeedMin80mKPH |
forecasts |
API - Base Flex - Base |
| Forecast Min. Wind Speed (mph) at 80m | Forecast | The minimum wind speed in miles per hour at a height of 80 meters. | periods[#].windSpeedMin80mMPH |
forecasts |
API - Base Flex - Base |
| Weather Phrase | Forecast | Full weather phrase that combines the weather from all periods as needed. | periods[#].weather |
forecasts |
API - Base Flex - Base |
| Weather Codes | Forecast | Array of periods containing different weather types; can be used to determine when a particular type of weather is expected to begin/end. Refer to the Coded Weather documentation for additional information on the types of weather codes. | periods[#].weatherCoded |
forecasts |
API - Base Flex - Base |
| Timestamp for beginning period (UNIX) | Forecast | UNIX timestamp for the beginning of this period. | periods[#].weatherCoded.timestamp |
forecasts |
API - Base Flex - Base |
| Coded form of the weather expected for this period | Forecast | Coded form of the weather expected for this period. Refer to the Coded Weather documentation for additional information on the types of weather codes. | periods[#].weatherCoded.wx |
forecasts |
API - Base Flex - Base |
| Primary Weather | Forecast | Primary weather across all periods. | periods[#].weatherPrimary |
forecasts |
API - Base Flex - Base |
| Primary Weather (Coded) | Forecast | Primary weather coded. Refer to the Coded Weather documentation for additional information on the types of weather codes. | periods[#].weatherPrimaryCoded |
forecasts |
API - Base Flex - Base |
| Clouds Coded | Forecast | Code for the cloud type. Refer to the Coded Weather documentation for additional information on the types of cloud codes. | periods[#].cloudsCoded |
forecasts |
API - Base Flex - Base |
| Weather Icon | Forecast | Weather icon representing the expected weather from the default Aeris icon set. For more custom implementations, icons can be determined by the weatherCoded and weatherCodedPrimary properties. | periods[#].icon |
forecasts |
API - Base Flex - Base |
| Forecast visibility in kilometers at the start of the forecast period | Forecast | The forecast visibility in kilometers at the start of the forecast period. Null if unavailable. | periods[#].visibilityKM |
forecasts |
API - Base Flex - Base |
| Forecast visibility in miles at the start of the forecast period | Forecast | The forecast visibility in miles at the start of the forecast period. Null if unavailable. | periods[#].visibilityMI |
forecasts |
API - Base Flex - Base |
| Forecast Solar Radiation | Forecast | The estimated forecast solar radiation. Normally used with filter=1hr. If interval > 1 hour will be the accumulated hourly solar radiation values over the interval. | periods[#].solradWM2 |
forecasts |
API - Base Flex - Base |
| Forecast Min. Solar Radiation | Forecast | The minimum estimated forecast solar radiation over a forecast interval. | periods[#].solradMinWM2 |
forecasts |
API - Base Flex - Base |
| Forecast Max. Solar Radiation | Forecast | The maximum estimated forecast solar radiation over a forecast interval. | periods[#].solradMaxWM2 |
forecasts |
API - Base Flex - Base |
| if Day (True) | Forecast | True if the period is during the day, otherwise false. | periods[#].isDay |
forecasts |
API - Base Flex - Base |
| Sunrise Time (UNIX) | Forecast | Sunrise time as a UNIX timestamp. Provided when using filter=day (default) or filter=daynight. Not currently available for hourly forecasts. NOTE: If no sunrise (Midnight sun / polar night) a boolean false will be returned | periods[#].sunrise |
forecasts |
API - Base Flex - Base |
| Sunrise Time (ISO 8601) | Forecast | ISO 8601 date of the sunrise for the observation location. Provided when using filter=day (default) or filter=daynight. Not currently available for hourly forecasts. NOTE: If no sunrise (Midnight sun / polar night) a boolean false will be returned | periods[#].sunriseISO |
forecasts |
API - Base Flex - Base |
| Sunset Time (UNIX) | Forecast | Sunset time as a UNIX timestamp. Provided when using filter=day (default) or filter=daynight. Not currently available for hourly forecasts. NOTE: If no sunset (Midnight sun / polar night) a boolean false will be returned | periods[#].sunset |
forecasts |
API - Base Flex - Base |
| Sunset Time (ISO 8601) | Forecast | ISO 8601 date of the sunsetbfor the observation location. Provided when using filter=day (default) or filter=daynight. Not currently available for hourly forecasts. NOTE: If no sunset(Midnight sun / polar night) a boolean false will be returned | periods[#].sunsetISO |
forecasts |
API - Base Flex - Base |
| Elevation (meters) | Forecast | Location estimated elevation in meters. Null if unavailable | profile.elevM |
forecasts |
API - Base Flex - Base |
| Elevation (ft.) | Forecast | Location estimated elevation in feet. Null if unavailable | profile.elevFT |
forecasts |
API - Base Flex - Base |
| Indice Type | Current/Forecast | Type of indice | indice.type |
indices |
API - Base Flex - Base |
| Indice Range | Current/Forecast | Object containing the indice range information. | indice.range |
indices |
API - Base Flex - Base |
| Minimum Range Value | Current/Forecast | The minimum indice value. | indice.range.min |
indices |
API - Base Flex - Base |
| Maximum Range Value | Current/Forecast | The maximum indice value | indice.range.max |
indices |
API - Base Flex - Base |
| Reverse Range - Indice | Current/Forecast | Flag determining order of the indice. | indice.range.reverse |
indices |
API - Base Flex - Base |
| Current - Indice | Current/Forecast | Object containing the indice based on the latest observation. Null if unavailable. | indice.current |
indices |
API - Base Flex - Base |
| Current Time, Seconds - Indice | Current/Forecast | The unix timestamp, in seconds, for the time of the observation used. | indice.current.timestamp |
indices |
API - Base Flex - Base |
| Current Time & Date - Indice | Current/Forecast | ISO 8601 date of the observation used. | indice.current.dateTimeISO |
indices |
API - Base Flex - Base |
| Current Index - Indice | Current/Forecast | The numeric index value. The value, is normally from 0-5. 0 = Unavailable If indice.range.reverse = false: 1 = bad 2 = poor 3 = good 4 = very good 5 = excellent If indice.range.reverse = true: 1 = excellent 2 = very good 3 = good 4 = poor 5 = bad |
indice.current.index |
indices |
API - Base Flex - Base |
| Current English Index - Indice | Current/Forecast | The English phrase for the index value. Possible values include: - unavailable - bad - poor - good - very good - excellent |
indice.current.indexENG |
indices |
API - Base Flex - Base |
| Forecast - Indice | Current/Forecast | The object containing the forecast indice values. Null if the forecast was not requested. | indice.forecast |
indices |
API - Base Flex - Base |
| Forecast Periods - Indice | Current/Forecast | Array of forecast periods | indice.forecast.periods |
indices |
API - Base Flex - Base |
| Forecast Period Timestamp - Indice | Current/Forecast | The unix timestamp, in seconds, for the forecast period. For daily forecasts this will normally be approx 7am local time of the day the forecast period represents. | indice.forecast.periods.#.timestamp |
indices |
API - Base Flex - Base |
| Forecast Date/Time - Indice | Current/Forecast | The ISO 8601 date of the forecast period. For daily forecasts this will normally be approx 7am local time of the day the forecast period represents. | indice.forecast.periods.#.dateTimeISO |
indices |
API - Base Flex - Base |
| Numeric Forecast Period - Indice | Current/Forecast | The numeric index value for the forecast period. The numeric index value. The value, is normally from 0-5. 0 = Unavailable If indice.range.reverse = false: 1 = bad / minimal 2 = poor / minimal 3 = good / moderate 4 = very good / high 5 = excellent / extreme If indice.range.reverse = true: 1 = excellent / extreme 2 = very good / high 3 = good / moderate 4 = poor / low 5 = bad / minimal |
indice.forecast.periods.#.index |
indices |
API - Base Flex - Base |
| English Forecast Period - Indice | Current/Forecast | The English phrase for the index value Possible values include, based on index: Outdoors, golf, biking, swimming, campfires, bees: - unavailable - bad - poor - good - very good - excellent Arthritis, coldflu, migraine, sinus - unavailable - extreme - high - moderate - low - minimal |
indice.forecast.periods.#.indexEng |
indices |
API - Base Flex - Base |
| ID of the lightning strike | Current | The ID of the lightning strike. | id |
lightning | Lightning Add-On |
| Object containing information about the lightning strike | Current | Object containing information about the lightning strike. | ob |
lightning | Lightning Add-On |
| Timestamp of the lightning strike | Current | Unix timestamp of the lightning strike. | ob.timestamp |
lightning | Lightning Add-On |
| Date of the lightning strike | Current | ISO 8601 date of the lightning strike. | ob.dateTimeISO |
lightning | Lightning Add-On |
| Seconds elapsed since the lightning strike | Current | Seconds elapsed since the lightning strike. | ob.age |
lightning | Lightning Add-On |
| Object containing the type and peak amp of the lightning strike | Current | The object containing the type and peak amp of the lightning strike. | ob.pulse |
lightning | Lightning Add-On |
| One of the two types of lightning strikes | Current | One of the two types of lightning strikes. - IC: Intracloud - CG: Cloud-to-ground |
ob.pulse.type |
lightning | Lightning Add-On |
| The peak electric current in amperes | Current | The peak electric current in amperes. Polarity is determined by a negative or positive value here. | ob.pulse.peakamp |
lightning | Lightning Add-On |
| Number of sensors that detected the lightning pulse | Current | The number of sensors that detected the lightning pulse | ob.pulse.numsensors |
lightning | Lightning Add-On |
| (DEPRECATED) Height in feet of the intracloud lightning pulse | Current | (DEPRECATED) The estimated height in feet of the intracloud lightning pulse | ob.pulse.icHeightFT |
lightning | Lightning Add-On |
| (DEPRECATED) Height in meters of the intracloud lightning pulse | Current | (DEPRECATED) The estimated height in meters of the intracloud lightning pulse | ob.pulse.icHeightM |
lightning | Lightning Add-On |
| Timestamp of the time the lightning strike information was received | Current | Unix timestamp of the time the lightning strike information was received | recTimestamp |
lightning | Lightning Add-On |
| Date of the time the lightning strike information was received | Current | ISO 8601 date of the time the lightning strike information was received. | recISO |
lightning | Lightning Add-On |
| The ID of the lightning strike. | Historical/Current | The ID of the lightning strike. | id |
lightning/archive | Lightning Archive Add-On |
| Object containing information about the lightning strike | Historical/Current | Object containing information about the lightning strike. | ob |
lightning/archive | Lightning Archive Add-On |
| Timestamp of the lightning strike | Historical/Current | Unix timestamp of the lightning strike. | ob.timestamp |
lightning/archive | Lightning Archive Add-On |
| Date of the lightning strike | Historical/Current | ISO 8601 date of the lightning strike. | ob.dateTimeISO |
lightning/archive | Lightning Archive Add-On |
| Seconds elapsed since the lightning strike | Historical/Current | Seconds elapsed since the lightning strike. | ob.age |
lightning/archive | Lightning Archive Add-On |
| Object containing the type and peak amp of the lightning strike | Historical/Current | Object containing the type and peak amp of the lightning strike. | ob.pulse |
lightning/archive | Lightning Archive Add-On |
| One of the two types of lightning strikes | Historical/Current | One of the two types of lightning strikes. - IC: Intracloud - CG: Cloud-to-ground |
ob.pulse.type |
lightning/archive | Lightning Archive Add-On |
| The peak electric current in amperes | Historical/Current | The peak electric current in amperes. Polarity is determined by a negative or positive value here. | ob.pulse.peakamp |
lightning/archive | Lightning Archive Add-On |
| Number of sensors that detected the lightning pulse | Historical/Current | The number of sensors that detected the lightning pulse | ob.pulse.numsensors |
lightning/archive | Lightning Archive Add-On |
| Timestamp of the time the lightning strike information was received | Historical/Current | Unix timestamp of the time the lightning strike information was received | recTimestamp |
lightning/archive | Lightning Archive Add-On |
| Date of the time the lightning strike information was received | Historical/Current | ISO 8601 date of the time the lightning strike information was received. | recISO |
lightning/archive | Lightning Archive Add-On |
| lightning flash id | Current | ID of the flash | id |
lightning/flash | Flex - Base |
| lightning flash observation | Current | The observation object | ob |
lightning/flash | Flex - Base |
| Current | The unix timestamp of the flash event | ob.timestamp |
lightning/flash | Flex - Base | |
| Current | The ISO8601 date/time of the flash event | ob.dateTimeISO |
lightning/flash | Flex - Base | |
| Current | The age in second of the flash event at the time of the API request. | ob.age |
lightning/flash | Flex - Base | |
| Object of the time range the summary covers | Current | Object of the time range the summary covers | range |
lightning/summary | Lightning Add-On |
| Total lightning pulses within the summary time range | Current | The total lightning pulses within the summary time range | range.count |
lightning/summary | Lightning Add-On |
| Timestamp of the from parameter | Current | Unix timestamp of the from parameter. | range.fromTimestamp |
lightning/summary | Lightning Add-On |
| Date of the from parameter | Current | ISO 8601 date of the from parameter | range.fromDateTimeISO |
lightning/summary | Lightning Add-On |
| Timestamp of the to parameter | Current | Unix timestamp of the to parameter. | range.toTimestamp |
lightning/summary | Lightning Add-On |
| Date of the to parameter | Current | ISO 8601 date of the to parameter | range.toDateTimeISO |
lightning/summary | Lightning Add-On |
| Timestamp of the first lightning pulse within the summary time range | Current | Unix timestamp of the first lightning pulse within the summary time range | range.minTimestamp |
lightning/summary | Lightning Add-On |
| Date of the first lightning pulse within the summary time range | Current | ISO 8601 date of the first lightning pulse within the summary time range | range.minDateTimeISO |
lightning/summary | Lightning Add-On |
| Timestamp of the last lightning pulse within the summary time range | Current | Unix timestamp of the last lightning pulse within the summary time range | range.maxTimestamp |
lightning/summary | Lightning Add-On |
| Date of the last lightning pulse within the summary time range | Current | ISO 8601 date of the last lightning pulse within the summary time range | range.maxDateTimeISO |
lightning/summary | Lightning Add-On |
| Object of pulse information | Current | Object of pulse information | pulse |
lightning/summary | Lightning Add-On |
| Total number of lightning pulses within the summary time range | Current | The total number of lightning pulses within the summary time range | pulse.count |
lightning/summary | Lightning Add-On |
| Total number of strikes | Current | The total number of cloud-to-ground strikes | pulse.cg |
lightning/summary | Lightning Add-On |
| Total number of intracloud strikes | Current | The total number of intracloud strikes | pulse.ic |
lightning/summary | Lightning Add-On |
| Object of peak amperage information | Current | Object of peak amperage information | peakamp |
lightning/summary | Lightning Add-On |
| Total number of lightning pulses that included peak amp information | Current | The total number of lightning pulses that included peak amp information | peakamp.count |
lightning/summary | Lightning Add-On |
| Minimum peak amp value from all the lightning pulses within the summary | Current | The minimum peak amp value from all the lightning pulses within the summary | peakamp.min |
lightning/summary | Lightning Add-On |
| Maximum peak amp value from all the lightning pulses within the summary | Current | The maximum peak amp value from all the lightning pulses within the summary | peakamp.max |
lightning/summary | Lightning Add-On |
| average peak amp value from all the lightning pulses within the Summary | Current | The average peak amp value from all the lightning pulses within the summary | peakamp.avg |
lightning/summary | Lightning Add-On |
| (DEPRECATED) Object of intracloud height information | Current | (DEPRECATED) Object of intracloud height information | icHeight |
lightning/summary | Lightning Add-On |
| (DEPRECATED) Total number of lightning pulses within the summary time range | Current | (DEPRECATED) The total number of lightning pulses within the summary time range | icHeight.count |
lightning/summary | Lightning Add-On |
| (DEPRECATED) Lowest height in meters that was detected for an intracloud strike | Current | (DEPRECATED) Lowest height in meters that was detected for an intracloud strike | icHeight.min |
lightning/summary | Lightning Add-On |
| (DEPRECATED) Highest height in meters that was detected for an intracloud strike | Current | (DEPRECATED) Highest height in meters that was detected for an intracloud strike | icHeight.max |
lightning/summary | Lightning Add-On |
| (DEPRECATED) Average height in meters that was detected for an intracloud strike | Current | (DEPRECATED) Average height in meters that was detected for an intracloud strike | icHeight.avg |
lightning/summary | Lightning Add-On |
| Object related to the number of sensors that detected lightning strikes | Current | Object related to the number of sensors that detected lightning strikes | numSensors |
lightning/summary | Lightning Add-On |
| Total number of pulses detected within the summary time range | Current | Total number of pulses detected within the summary time range | numSensors.count |
lightning/summary | Lightning Add-On |
| Minimum number of sensors that detected a single lightning strike | Current | Minimum number of sensors that detected a single lightning strike | numSensors.min |
lightning/summary | Lightning Add-On |
| Maximum number of sensors that detected a single lightning strike | Current | Maximum number of sensors that detected a single lightning strike | numSensors.max |
lightning/summary | Lightning Add-On |
| Average number of sensors that detected a single lightning strike | Current | Average number of sensors that detected a single lightning strike | numSensors.avg |
lightning/summary | Lightning Add-On |
| Forecast | The Lightning Storm Threat ID | id |
lightning/threats | Lightning Add-On | |
| Forecast | The lightning threats data source. Supported sources: - vaisala-lightning |
dataSource |
lightning/threats | Lightning Add-On | |
| Forecast | Lightning storm threat details object | details |
lightning/threats | Lightning Add-On | |
| Forecast | The Lightning Storm Threat ID | details.stormId |
lightning/threats | Lightning Add-On | |
| Forecast | The unix timestamp of date/time the lightning storm threat was issued | details.issuedTimestamp |
lightning/threats | Lightning Add-On | |
| Forecast | The ISO8601 date/time the lightning storm threat was issued | details.issuedDateTimeISO |
lightning/threats | Lightning Add-On | |
| Forecast | The time range object for the storm threat | details.range |
lightning/threats | Lightning Add-On | |
| Forecast | The unix timestamp representing the start date/time of the lightning threat | details.range.minTimestamp |
lightning/threats | Lightning Add-On | |
| Forecast | The ISO8601 date representing the start date/time of the lightning threat | details.range.minDateTimeISO |
lightning/threats | Lightning Add-On | |
| Forecast | The unix timestamp representing the ending date/time of the lightning threat | details.range.maxTimestamp |
lightning/threats | Lightning Add-On | |
| Forecast | The ISO8601 date representing the ending date/time of the lightning threat | details.range.maxDateTimeISO |
lightning/threats | Lightning Add-On | |
| Forecast | Flag indicating if this is a severe lightning threat | details.severe |
lightning/threats | Lightning Add-On | |
| Forecast | The movement object. Null if direction or speed are unavailable. | details.movement |
lightning/threats | Lightning Add-On | |
| Forecast | The estimated direction of the lightning storm threat in degrees. 0 - 359, with 0 = North, | details.movement.dirDeg |
lightning/threats | Lightning Add-On | |
| Forecast | The estimated direction of the lightning storm threat is in degrees. Possible values: - N - North - NNE - North northeast - NE - Northeast - ENE - East northeast - E - East - ESE - East southeast - SE - Southeast - SSE - South southeast - S - South - SSW - South southwest - SW - Southwest - WSW - West southwest - W - West - WNW - West northwest - NW - Northwest - NNW - North northwest |
details.movement.dir |
lightning/threats | Lightning Add-On | |
| Forecast | The estimated speed of the threat in knots. | details.movement.speedKTS |
lightning/threats | Lightning Add-On | |
| Forecast | The estimated speed of the threat in kilometers per hour. | details.movement.speedKPH |
lightning/threats | Lightning Add-On | |
| Forecast | The estimated speed of the threat in miles per hour. | details.movement.speedMPH |
lightning/threats | Lightning Add-On | |
| Forecast | The reliability of the estimated threat movement information: - NOT_AVAILABLE: Not enough history available to estimate motion - UNPHYSICAL: Estimated storm motion exceeds 120 km/h - LOW: The default assumption once any given storm has enough history of initializing its motion estimate. - MEDIUM: LOW reliability can be promoted to MEDIUM or HIGH once there is enough consistency between recent storm motion estimates. - HIGH: LOW reliability can be promoted to MEDIUM or HIGH once there is enough consistency between recent storm motion estimates. |
details.movement.reliability |
lightning/threats | Lightning Add-On | |
| Forecast | The total number of 10 minute threat periods associated with the storm | totalPeriods |
lightning/threats | Lightning Add-On | |
| Forecast | The ID string for the 10 minute threat forecast period | periods.#.id |
lightning/threats | Lightning Add-On | |
| Forecast | The time range object for the storm threat period | periods.#.range |
lightning/threats | Lightning Add-On | |
| Forecast | The unix timestamp representing the start date/time of the threat period | periods.#.range.minTimestamp |
lightning/threats | Lightning Add-On | |
| Forecast | The ISO8601 date representing the start date/time of the threat period | periods.#.range.minDateTimeISO |
lightning/threats | Lightning Add-On | |
| Forecast | The unix timestamp representing the ending date/time of the threat period | periods.#.range.maxTimestamp |
lightning/threats | Lightning Add-On | |
| Forecast | The ISO8601 date representing the ending date/time of the threat period | periods.#.range.maxDateTimeISO |
lightning/threats | Lightning Add-On | |
| Forecast | A GeoJSON polygon object representing the threat coverage area for the period | periods.#.polygon |
lightning/threats | Lightning Add-On | |
| Forecast | A GeoJSON point object representing the centroid of the coverage area polygon for the period | periods.#.centroid |
lightning/threats | Lightning Add-On | |
| Forecast | A GeoJSON line string representing the estimated direction of the storm. Null if not available. | forecastPath |
lightning/threats | Lightning Add-On | |
| The unix timestamp of the time of the forecast period | Current/Forecast | The UNIX timestamp of the valid time of the forecast period | periods.#.timestamp |
maritime |
Flex - Base API - Base |
| The ISO 8601 date/time of the forecast period | Current/Forecast | The ISO 8601 date/time of the forecast period valid time | periods.#.dateTimeISO |
maritime |
Flex - Base API - Base |
| The sea surface temperature in Celsius | Current/Forecast | The sea surface temperature in Celsius. Available out 7 days. Null if unavailable. | periods.#.seaSurfaceTemperatureC |
maritime |
Flex - Base API - Base |
| The sea surface temperature in Fahrenheit | Current/Forecast | The sea surface temperature in Fahrenheit. Available out 7 days. Null if unavailable. | periods.#.seaSurfaceTemperatureF |
maritime |
Flex - Base API - Base |
| The sea currents speed in knots. | Current/Forecast | The sea currents speed in knots. Null if no current or unavailable. | periods.#.seaCurrentSpeedKTS |
maritime |
Flex - Base API - Base |
| The sea currents speed in kilometers/hour. | Current/Forecast | The sea currents speed in kilometers/hour. Null if no current or unavailable. | periods.#.seaCurrentSpeedKPH |
maritime |
Flex - Base API - Base |
| The sea currents speed in meters per second. | Current/Forecast | The sea currents speed in meters per second. Null if no current or unavailable. | periods.#.seaCurrentSpeedMPS |
maritime |
Flex - Base API - Base |
| The sea currents speed in miles per hour. | Current/Forecast | The sea currents speed in miles per hour. Null if no current or unavailable. | periods.#.seaCurrentSpeedMPH |
maritime |
Flex - Base API - Base |
| The sea current direction as a cardinal direction. | Current/Forecast | The sea current direction as a cardinal direction. Null if no current or unavailable. Possible values: - N - North - NNE - North northeast - NE - Northeast - ENE - East northeast - E - East - ESE - East southeast - SE - Southeast - SSE - South southeast - S - South - SSW - South southwest - SW - Southwest - WSW - West southwest - W - West - WNW - West northwest - NW - Northwest - NNW - North northwest |
periods.#.seaCurrentDir |
maritime |
Flex - Base API - Base |
| The sea current direction in degrees. | Current/Forecast | The sea current direction in degrees. 0 - 359, with 0 = North, Null if no current or unavailable. |
periods.#.seaCurrentDirDEG |
maritime |
Flex - Base API - Base |
| The significant wave height in meters. | Current/Forecast | The significant wave height in meters. Null if unavailable. | periods.#.significantWaveHeightM |
maritime |
Flex - Base API - Base |
| The significant wave height in feet. | Current/Forecast | The significant wave height in feet. Null if unavailable. | periods.#.significantWaveHeightFT |
maritime |
Flex - Base API - Base |
| The primary wave direction as a cardinal direction. | Current/Forecast | The primary wave direction as a cardinal direction. Null if no current or unavailable. | periods.#.primaryWaveDir |
maritime |
Flex - Base API - Base |
| The primary wave direction in degrees. | Current/Forecast | The primary wave direction in degrees. 0 - 359, with 0 = North, Null if no current or unavailable. |
periods.#.primaryWaveDirDEG |
maritime |
Flex - Base API - Base |
| The primary wave period in seconds. | Current/Forecast | The primary wave period in seconds. Null if no swell or unavailable. | periods.#.primaryWavePeriod |
maritime |
Flex - Base API - Base |
| The wind wave direction as a cardinal direction. | Current/Forecast | The wind wave direction as a cardinal direction. Null if no swell or unavailable. | periods.#.windWaveDir |
maritime |
Flex - Base API - Base |
| The wind wave direction in degrees. | Current/Forecast | The wind wave direction in degrees. 0 - 359, with 0 = North, Null if no swell or unavailable. |
periods.#.windWaveDirDEG |
maritime |
Flex - Base API - Base |
| The wind wave period in seconds. | Current/Forecast | The wind wave period in seconds. | periods.#.windWavePeriod |
maritime |
Flex - Base API - Base |
| The primary swell height in meters. | Current/Forecast | The primary swell height in meters. Null if no swell or unavailable. | periods.#.primarySwellHeightM |
maritime |
Flex - Base API - Base |
| The primary swell height in feet. | Current/Forecast | The primary swell height in feet. Null if no swell or unavailable. | periods.#.primarySwellHeightFT |
maritime |
Flex - Base API - Base |
| The primary swell direction as a cardinal direction | Current/Forecast | The primary swell direction as a cardinal direction. Null if no swell or unavailable. | periods.#.primarySwellDir |
maritime |
Flex - Base API - Base |
| The primary swell direction in degrees. | Current/Forecast | The primary swell direction in degrees. 0 - 359, with 0 = North, Null if no swell or unavailable. |
periods.#.primarySwellDirDEG |
maritime |
Flex - Base API - Base |
| The primary swell period in seconds. | Current/Forecast | The primary swell period in seconds. Null if no swell or unavailable. | periods.#.primarySwellPeriod |
maritime |
Flex - Base API - Base |
| The secondary swell height in meters. | Current/Forecast | The secondary swell height in meters. Null if no swell or unavailable. | periods.#.secondarySwellHeightM |
maritime |
Flex - Base API - Base |
| The secondary swell height in feet. | Current/Forecast | The secondary swell height in feet. Null if no swell or unavailable. | periods.#.secondarySwellHeightFT |
maritime |
Flex - Base API - Base |
| The secondary swell direction as a cardinal direction. | Current/Forecast | The secondary swell direction as a cardinal direction. Null if no swell or unavailable. | periods.#.secondarySwellDir |
maritime |
Flex - Base API - Base |
| The secondary swell direction in degrees. | Current/Forecast | The secondary swell direction in degrees. 0 - 359, with 0 = North, Null if no swell or unavailable. |
periods.#.secondarySwellDirDEG |
maritime |
Flex - Base API - Base |
| The secondary swell period in seconds. | Current/Forecast | The secondary swell period in seconds. Null if no swell or unavailable. | periods.#.secondarySwellPeriod |
maritime |
Flex - Base API - Base |
| The tertiary swell height in meters. | Current/Forecast | The tertiary swell height in meters. Null if no swell or unavailable. | periods.#.tertiarySwellHeightM |
maritime |
Flex - Base API - Base |
| The tertiary swell height in feet. | Current/Forecast | The tertiary swell height in feet. Null if no swell or unavailable. | periods.#.tertiarySwellHeightFT |
maritime |
Flex - Base API - Base |
| The tertiary swell direction as a cardinal direction. | Current/Forecast | The tertiary swell direction as a cardinal direction. Null if no swell or unavailable. | periods.#.tertiarySwellDir |
maritime |
Flex - Base API - Base |
| The tertiary swell direction in degrees. | Current/Forecast | The tertiary swell direction in degrees. 0 - 359, with 0 = North, Null if no swell or unavailable. |
periods.#.tertiarySwellDirDEG |
maritime |
Flex - Base API - Base |
| The tertiary swell period in seconds. | Current/Forecast | The tertiary swell period in seconds. Null if no swell or unavailable. | periods.#.tertiarySwellPeriod |
maritime |
Flex - Base API - Base |
| The tide level in meters. Can be negative for low tide. | Current/Forecast | The tide level in meters. Can be negative for low tide. Useful near shore. Null if unavailable. | periods.#.tidesM |
maritime |
Flex - Base API - Base |
| The tide level in feet. Can be negative for low tide. | Current/Forecast | The tide level in feet. It can be negative for low tide. Useful near shore. Null if unavailable. | periods.#.tidesFT |
maritime |
Flex - Base API - Base |
| The surge level in meters. | Current/Forecast | The surge level in meters. Useful near shore. Null if unavailable. | periods.#.surgeM |
maritime |
Flex - Base API - Base |
| The surge level in feet. | Current/Forecast | The surge level in feet. Useful near shore. Null if unavailable. | periods.#.surgeFT |
maritime |
Flex - Base API - Base |
| Co-op/station ID that the normal is based on | Historical | The co-op/station ID that the normal is based on. | id |
normals |
API - Base Flex - Base |
| Type of normal | Historical | Type of normal: - daily - monthly - annual |
periods[#].type |
normals |
API - Base Flex - Base |
| The number of the month the normal is for, from 1 - 12 | Historical | The number of the month the normal is for, from 1 - 12. Will be null for an annual summary (filter=annual). | periods[#].mon |
normals |
API - Base Flex - Base |
| The numeric day of the month, from 1 - 31 | Historical | The numeric day of the month, from 1 - 31. Will be null for both a monthly and annual summary (filter=monthly or filter=annual). | periods[#].day |
normals |
API - Base Flex - Base |
| Timestamp of the normals valid time | Historical | UNIX timestamp of the normals valid time. | periods[#].timestamp |
normals |
API - Base Flex - Base |
| valid date and time of the normals | Historical | ISO 8601 of the valid time of the normals. | periods[#].dateTimeISO |
normals |
API - Base Flex - Base |
| Object of temperature based normals | Historical | Object of temperature based normals. Will be null if the observation station does not normal temperatures. | periods[#].temp |
normals |
API - Base Flex - Base |
| Normal maximum temperature in Fahrenheit | Historical | The normal maximum temperature in Fahrenheit. | periods[#].temp.maxF |
normals |
API - Base Flex - Base |
| Normal maximum temperature in Celsius | Historical | The normal maximum temperature in Celsius. | periods[#].temp.maxC |
normals |
API - Base Flex - Base |
| Normal minimum temperature in Fahrenheit | Historical | The normal minimum temperature in Fahrenheit. | periods[#].temp.minF |
normals |
API - Base Flex - Base |
| Normal minimum temperature in Celsius | Historical | The normal minimum temperature in Celsius. | periods[#].temp.minC |
normals |
API - Base Flex - Base |
| Normal average temperature in Fahrenheit | Historical | The normal average temperature in Fahrenheit. | periods[#].temp.avgF |
normals |
API - Base Flex - Base |
| Normal average temperature in Celsius | Historical | The normal average temperature in Celsius. | periods[#].temp.avgC |
normals |
API - Base Flex - Base |
| Object of the precipitation based normals | Historical | Object of the precipitation based normals. Will be null if the observation station does not include precipitation normals. | periods[#].prcp |
normals |
API - Base Flex - Base |
| The normal month to date precipitation in inches | Historical | The normal month to date precipitation in inches. Will be null for annual summary (filter=annual). | periods[#].prcp.mtdIN |
normals |
API - Base Flex - Base |
| The normal month to date precipitation in millimeters | Historical | The normal month to date precipitation in millimeters. Will be null for annual summary (filter=annual). | periods[#].prcp.mtdMM |
normals |
API - Base Flex - Base |
| The normal year to date precipitation in inches | Historical | The normal year to date precipitation in inches. Will be null for monthly summary (filter=monthly). | periods[#].prcp.ytdIN |
normals |
API - Base Flex - Base |
| The normal year to date precipitation in millimeters | Historical | The normal year to date precipitation in millimeters. Will be null for monthly summary (filter=monthly). | periods[#].prcp.ytdMM |
normals |
API - Base Flex - Base |
| Object of the snowfall based normals | Historical | Object of the snowfall based normals. Will be null if the observation station does not include snowfall normals. | periods[#].snow |
normals |
API - Base Flex - Base |
| The normal month to date snowfall in inches | Historical | The normal month to date snowfall in inches. Will be null for annual summary (filter=annual). | periods[#].snow.mtdIN |
normals |
API - Base Flex - Base |
| The normal month to date snowfall in centimeters | Historical | The normal month to date snowfall in centimeters. Will be null for annual summary (filter=annual). | periods[#].snow.mtdCM |
normals |
API - Base Flex - Base |
| The normal year to date snowfall in inches | Historical | The normal year to date snowfall in inches. Will be null for monthly summary (filter=monthly). | periods[#].snow.ytdIN |
normals |
API - Base Flex - Base |
| The normal year to date snowfall in centimeters | Historical | The normal year to date snowfall in centimeters. Will be null for monthly summary (filter=monthly). | periods[#].snow.ytdCM |
normals |
API - Base Flex - Base |
| Normal heating degree days | Historical | The normal heating degree days. | hdd |
normals |
API - Base Flex - Base |
| Normal cooling degree days | Historical | The normal cooling degree days. | cdd |
normals |
API - Base Flex - Base |
| Co-op/station ID | Historical | The co-op/station ID. | id |
normals/stations |
API - Base Flex - Base |
| WMO ID of the station | Historical | The WMO ID of the station. null if unavailable. | profile.wmoid |
normals/stations |
API - Base Flex - Base |
| Indicates if the station has temperature normals | Historical | Flag indicating if the station has temperature normals. | profile.flags.temp |
normals/stations |
API - Base Flex - Base |
| Indicates if the station has precipitation normals | Historical | Flag indicating if the station has precipitation normals. | profile.flags.prcp |
normals/stations |
API - Base Flex - Base |
| Indicates if the station has snowfall normals | Historical | Flag indicating if the station has snowfall normals. | profile.flags.snow |
normals/stations |
API - Base Flex - Base |
| Historical | Source for the climate station. | dataSource |
normals/stations |
API - Base Flex - Base |
|
| The reporting station | Current | The reporting station ID. | id |
observations |
API - Base Flex - Base |
| The observation object | Current | Current Weather Data | ob |
observations |
API - Base Flex - Base |
| The type of observation | Current | The type of observation will be one of the following: station - actual station observations interpolated - (Deprecated, see the conditions endpoint) Interpolated/estimated observation. |
ob.type |
observations |
API - Base Flex - Base |
| Timestamp of the observation | Current | UNIX timestamp of the observation. | ob.timestamp |
observations |
API - Base Flex - Base |
| Date of the observation | Current | ISO 8601 date of the observation. | ob.dateTimeISO |
observations |
API - Base Flex - Base |
| Timestamp of when the observation was received | Current | Unix timestamp of when the observation was received. | ob.recTimestamp |
observations |
API - Base Flex - Base |
| Date of when the observation was received | Current | ISO 8601 date of when the observation was received. | ob.recDateTimeISO |
observations |
API - Base Flex - Base |
| Temperature in Celsius | Current | Temperature in Celsius. Null if not available. | ob.tempC |
observations |
API - Base Flex - Base |
| Temperature in Fahrenheit | Current | Temperature in Fahrenheit. Null if not available. | ob.tempF |
observations |
API - Base Flex - Base |
| Dew point temperature in Celsius | Current | Dew point temperature in Celsius. Null if not available. | ob.dewpointC |
observations |
API - Base Flex - Base |
| Dew point temperature in Fahrenheit | Current | Dew point temperature in Fahrenheit. Null if not available. | ob.dewpointF |
observations |
API - Base Flex - Base |
| Relative humidity | Current | Relative humidity. Null if not available. | ob.humidity |
observations |
API - Base Flex - Base |
| Mean Sea Level Pressure (MSLP) in millibars. Null if not available | Current | Mean Sea Level Pressure (MSLP) in millibars. Null if not available. This is the pressure reading most commonly used by meteorologists to track weather systems at the surface. | ob.pressureMB |
observations |
API - Base Flex - Base |
| Mean Sea Level Pressure (MSLP) in inches of mercury | Current | Mean Sea Level Pressure (MSLP) in inches of mercury. Null if not available. This is the pressure reading most commonly used by meteorologists to track weather systems at the surface. | ob.pressureIN |
observations |
API - Base Flex - Base |
| Station pressure in millibars | Current | Station pressure in millibars. The pressure Null if not available. This is the pressure that is observed at a specific elevation and is the true barometric pressure of a location. | ob.spressureMB |
observations |
API - Base Flex - Base |
| Station pressure in inches of mercury. Null if not available | Current | Station pressure in inches of mercury. Null if not available. This is the pressure that is observed at a specific elevation and is the true barometric pressure of a location. | ob.spressureIN |
observations |
API - Base Flex - Base |
| Altimeter in millibars | Current | Altimeter in millibars. Null if not available. | ob.altimeterMB |
observations |
API - Base Flex - Base |
| Altimeter in inches of mercury | Current | Altimeter in inches of mercury. Null if not available. | ob.altimeterIN |
observations |
API - Base Flex - Base |
| Wind speed in knots | Current | Wind speed in knots. Null if not available. | ob.windSpeedKTS |
observations |
API - Base Flex - Base |
| Wind speed in kilometers her hour | Current | Wind speed in kilometers her hour. Null if not available. | ob.windSpeedKPH |
observations |
API - Base Flex - Base |
| Wind speed in miles per hour | Current | Wind speed in miles per hour. Null if not available. | ob.windSpeedMPH |
observations |
API - Base Flex - Base |
| Wind direction in degrees | Current | Wind direction in degrees. Null if not available. | ob.windDirDEG |
observations |
API - Base Flex - Base |
| Wind direction in cardinal coordinates | Current | Wind direction in cardinal coordinates. Null if not available. | ob.windDir |
observations |
API - Base Flex - Base |
| Wind gust speed in knots | Current | Wind gust speed in knots. Null if no wind gusts or not available. | ob.windGustKTS |
observations |
API - Base Flex - Base |
| Wind gust speed in kilometers her hour | Current | Wind gust speed in kilometers her hour. Null if no wind gusts or not available. | ob.windGustKPH |
observations |
API - Base Flex - Base |
| Wind gust speed in miles per hour | Current | Wind gust speed in miles per hour. Null if no wind gusts or if not available. | ob.windGustMPH |
observations |
API - Base Flex - Base |
| Flight Rule Indicator | Current | Flight rule indicator, based on weather conditions only. Potential values are: "LIFR", "IFR", "MVFR", "VFR". Null if not available. | ob.flightRule |
observations |
API - Base Flex - Base |
| Visibility in kilometers | Current | Visibility in kilometers. Null if not available. | ob.visibilityKM |
observations |
API - Base Flex - Base |
| Visibility in miles | Current | Visibility in miles. Null if not available. | ob.visibilityMI |
observations |
API - Base Flex - Base |
| Weather string | Current | A string of the weather often including cloud coverage along with any prominent weather. Null if unavailable. | ob.weather |
observations |
API - Base Flex - Base |
| Shortened weather string | Current | A shortened weather string. Null if unavailable. | ob.weatherShort |
observations |
API - Base Flex - Base |
| Coded weather | Current | The coded weather. See the Coded Weather documentation for code options. Null if unavailable. | ob.weatherCoded |
observations |
API - Base Flex - Base |
| String of the primary weather | Current | A string of the primary weather. Null if unavailable. | ob.weatherPrimary |
observations |
API - Base Flex - Base |
| Primary coded weather | Current | The primary coded weather. See the Coded Weather documentation for code options. Null if unavailable. | ob.weatherPrimaryCoded |
observations |
API - Base Flex - Base |
| Coded cloud coverage | Current | The coded cloud coverage. See the Coded Weather documentation for code options. Null if unavailable. | ob.cloudsCoded |
observations |
API - Base Flex - Base |
| Estimated percentage of sky coverage | Current | Estimated percentage of sky coverage. 0 = clear, 100 = overcast. Null if not available. | ob.sky |
observations |
API - Base Flex - Base |
| Cloud ceiling in feet | Current | The cloud ceiling in feet, if available and reported. Null if not available or reported. | ob.ceilingFT |
observations |
API - Base Flex - Base |
| The cloud ceiling in meters | Current | The cloud ceiling in meters, if available and reported. Null if not available or reported. | ob.ceilingM |
observations |
API - Base Flex - Base |
| Weather icon representing the observed weather | Current | Weather icon representing the observed weather from the default AerisWeather icon set. For more custom implementations, icons can be determined by the weatherCoded and weatherPrimaryCoded properties. | ob.icon |
observations |
API - Base Flex - Base |
| Heat index temperature in Fahrenheit | Current | Heat index temperature in Fahrenheit. Null if not available. | ob.heatindexF |
observations |
API - Base Flex - Base |
| Heat index temperature in Celsius | Current | Heat index temperature in Celsius. Null if not available. | ob.heatindexC |
observations |
API - Base Flex - Base |
| Wind chill temperature in Fahrenheit | Current | Wind chill temperature in Fahrenheit. Null if not available. | ob.windchillF |
observations |
API - Base Flex - Base |
| Wind chill temperature in Celsius | Current | Wind chill temperature in Celsius. Null if not available. | ob.windchillC |
observations |
API - Base Flex - Base |
| Apparent temperature in Fahrenheit | Current | Apparent temperature in Fahrenheit. Null if not available. | ob.feelslikeF |
observations |
API - Base Flex - Base |
| Apparent temperature in Celsius | Current | Apparent temperature in Celsius. Null if not available. | ob.feelslikeC |
observations |
API - Base Flex - Base |
| Signifies if the observation occurred during daily hours | Current | Signifies if the observation occurred during daily hours. True if between sunrise and sunset, false otherwise. | ob.isDay |
observations |
API - Base Flex - Base |
| Timestamp of sunrise for the observation location | Current | Timestamp of sunrise for the observation location. NOTE: If no sunrise (Midnight sun / polar night) a boolean false will be returned | ob.sunrise |
observations |
API - Base Flex - Base |
| Date of the sunrise for the observation location | Current | ISO 8601 date of the sunrise for the observation location. NOTE: If no sunrise (Midnight sun / polar night) a boolean false will be returned | ob.sunriseISO |
observations |
API - Base Flex - Base |
| Timestamp of sunset for the observation location | Current | Timestamp of sunset for the observation location. NOTE: If no sunset (Midnight sun / polar night) a boolean false will be returned | ob.sunset |
observations |
API - Base Flex - Base |
| Date of the sunset for the observation location | Current | ISO 8601 date of the sunset for the observation location. NOTE: If no sunset (Midnight sun / polar night) a boolean false will be returned | ob.sunsetISO |
observations |
API - Base Flex - Base |
| Estimated snow depth in centimeters at the observation location | Current | The estimated snow depth in centimeters at the observation location. Null if not available. | ob.snowDepthCM |
observations |
API - Base Flex - Base |
| Estimated snow depth in inches at the observation location | Current | The estimated snow depth in inches at the observation location. Null if not available. | ob.snowDepthIN |
observations |
API - Base Flex - Base |
| Precipitation, in millimeters, as provided by the station | Current | The precipitation, in millimeters, as provided by the station. Null if not available. NOTE: Some stations may report this value differently. For example: -Precip since the top of the hour -Running 60-minute precip. i.e. 1.2” reported at 3:23 pm would be the value from 2:23 pm to 3:23 pm -Precip since last observation. If attempting to calculate the daily precip amount we recommend using the Observation Summary endpoint. |
ob.precipMM |
observations |
API - Base Flex - Base |
| Precipitation, in inches, as provided by the station | Current | The precipitation, in inches, as provided by the station. Null if not available. NOTE: Some stations may report this value differently. For example: -Precip since the top of the hour -Running 60-minute precip. i.e. 1.2” reported at 3:23 pm would be the value from 2:23 pm to 3:23 pm -Precip since last observation. If attempting to calculate the daily precip amount we recommend using the Observation Summary endpoint. |
ob.precipIN |
observations |
API - Base Flex - Base |
| Solar radiation as observed from station | Current | The solar radiation as observed from station or estimated if not available from station | ob.solradWM2 |
observations |
API - Base Flex - Base |
| Solar Radiation Method | Current | observed = reported by station estimated = calculated since not reported by station |
ob.solradMethod |
observations |
API - Base Flex - Base |
| Estimated light rate | Current | The estimated light rate as a percentage based on solradWM2 when available, otherwise calculated. Null if not available. | ob.light |
observations |
API - Base Flex - Base |
| Quality Control Code is the numerical version of QC | Current | Quality Control Code is the numerical version of QC (quality control): 0 = failed QC 1 = caution (some observation attributes may be invalid) 3 = probation (a station will be on probation if it's new, changed location, or having significant data issues) 7 = Questioned. While the observation passes QC, some elements may be out of characteristic for the station 10 = OK, passed QC |
ob.QCcode |
observations |
API - Base Flex - Base |
| Trust factor of the observation | Current | The trust factor of the observation. This value combines both the individual observation QC value and the overall confidence in the station. Will be a value from 0 -100 and is equivalent to the QCcode * Station Confidence. Note: New stations will start with a lower confidence. Additionally, stations that have observations that fail QC may have their station confidence lowered. By default the API requires a trustFactor of 80 or above. |
ob.trustFactor |
observations |
API - Base Flex - Base |
| Raw Data | Current | Raw observation data if available. (i.e. raw metar or synops). Null if not available. | raw |
observations |
API - Base Flex - Base |
| Elevation of the location in meters | Current | The elevation of the location in meters. | profile.elevM |
observations |
API - Base Flex - Base |
| Elevation of the location in feet | Current | The elevation of the location in feet. | profile.elevFT |
observations |
API - Base Flex - Base |
| Time zone name abbreviation | Current | The time zone name abbreviation, if one. Such as EST, EDT etc. | profile.tzname |
observations |
API - Base Flex - Base |
| Time zone offset in seconds from UTC time | Current | The time zone offset in seconds from UTC time. | profile.tzoffset |
observations |
API - Base Flex - Base |
| True if in Daylight Savings | Current | True is the location is in Daylight Savings Time, at the time of the observation. | profile.isDST |
observations |
API - Base Flex - Base |
| Reporting station ID | Historical/Current | The reporting station ID. | id |
observations/archive |
Flex - Base API - Base |
| Maximum temperature in Celsius in a 6 hour period | Historical/Current | The maximum temperature in Celsius in a 6 hour period. | periods[#].ob.tempMax6hrC |
observations/archive |
Flex - Base API - Base |
| Maximum temperature in Fahrenheit in a 6 hour period | Historical/Current | The maximum temperature in Fahrenheit in a 6 hour period. | periods[#].ob.tempMax6hrF |
observations/archive |
Flex - Base API - Base |
| Minimum temperature in Celsius in a 6 hour period | Historical/Current | The minimum temperature in Celsius in a 6 hour period. | periods[#].ob.tempMin6hrC |
observations/archive |
Flex - Base API - Base |
| Minimum temperature in Fahrenheit in a 6 hour period | Historical/Current | The minimum temperature in Fahrenheit in a 6 hour period. | periods[#].ob.tempMin6hrF |
observations/archive |
Flex - Base API - Base |
| Will be the precipitation (liquid equivalent) since the last observation | Historical/Current | Will be the precipitation (liquid equivalent) since the last observation, if the station provides precipitation per observation. | periods[#].ob.precipSinceLastOb |
observations/archive |
Flex - Base API - Base |
| Will be the precipitation (liquid equivalent) since the midnight local time of the station | Historical/Current | Will be the precipitation (liquid equivalent) since the midnight local time of the station, if the station provides precipitation information with the individual observations. | periods[#].ob.precipSinceMidnight |
observations/archive |
Flex - Base API - Base |
| Station ID | Historical/Current | The observation station ID. | id |
observations/summary |
API - Base Flex - Base |
| Times of the summary. Midnight local time | Historical/Current | UNIX timestamp of the summary. Midnight local time. | periods[#].summary.timestamp |
observations/summary |
API - Base Flex - Base |
| Date of the summary | Historical/Current | ISO 8601 date of the summary. | periods[#].summary.dateTimeISO |
observations/summary |
API - Base Flex - Base |
| The year, month and date | Historical/Current | The year, month and date in YYYYMMDD format. Example: Jan 7, 2014: 20140107 | periods[#].summary.ymd |
observations/summary |
API - Base Flex - Base |
| Timestamp of the maximum (latest) observation time in the summary | Historical/Current | UNIX timestamp of the maximum (latest) observation time in the summary. | periods[#].summary.range.maxTimestamp |
observations/summary |
API - Base Flex - Base |
| Date of the maximum (latest) observation time in the summary | Historical/Current | ISO 8601 of the maximum (latest) observation time in the summary. | periods[#].summary.range.maxDateTimeISO |
observations/summary |
API - Base Flex - Base |
| Timestamp of the minimum (earliest) observation time in the summary | Historical/Current | UNIX timestamp of the minimum (earliest) observation time in the summary. | periods[#].summary.range.minTimestamp |
observations/summary |
API - Base Flex - Base |
| Date of the minimum (earliest) observation time in the summary | Historical/Current | ISO 8601 of the minimum (earliest) observation time in the summary. | periods[#].summary.range.minDateTimeISO |
observations/summary |
API - Base Flex - Base |
| Total number of observations used to make the summary | Historical/Current | The total number of observations used to make the summary. | periods[#].summary.range.count |
observations/summary |
API - Base Flex - Base |
| Maximum temperature in Celsius | Historical/Current | The maximum temperature in Celsius. Null if unavailable. | periods[#].summary.temp.maxC |
observations/summary |
API - Base Flex - Base |
| Maximum temperature in Fahrenheit | Historical/Current | The maximum temperature in Fahrenheit. Null if unavailable. | periods[#].summary.temp.maxF |
observations/summary |
API - Base Flex - Base |
| Minimum temperature in Celsius | Historical/Current | The minimum temperature in Celsius. Null if unavailable. | periods[#].summary.temp.minC |
observations/summary |
API - Base Flex - Base |
| Minimum temperature in Fahrenheit | Historical/Current | The minimum temperature in Fahrenheit. Null if unavailable. | periods[#].summary.temp.minF |
observations/summary |
API - Base Flex - Base |
| Average temperature in Celsius | Historical/Current | The average temperature in Celsius. Null if unavailable. | periods[#].summary.temp.avgC |
observations/summary |
API - Base Flex - Base |
| Average temperature in Fahrenheit | Historical/Current | The average temperature in Fahrenheit. Null if unavailable. | periods[#].summary.temp.avgF |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included temperature information | Historical/Current | The total number of observations that included temperature information. | periods[#].summary.temp.count |
observations/summary |
API - Base Flex - Base |
| Maximum dew point in Celsius | Historical/Current | The maximum dew point in Celsius. Null if unavailable. | periods[#].summary.dewpt.maxC |
observations/summary |
API - Base Flex - Base |
| Maximum dew point in Fahrenheit | Historical/Current | The maximum dew point in Fahrenheit. Null if unavailable. | periods[#].summary.dewpt.maxF |
observations/summary |
API - Base Flex - Base |
| Minimum dew point in Celsius | Historical/Current | The minimum dew point in Celsius. Null if unavailable. | periods[#].summary.dewpt.minC |
observations/summary |
API - Base Flex - Base |
| Minimum dew point in Fahrenheit | Historical/Current | The minimum dew point in Fahrenheit. Null if unavailable. | periods[#].summary.dewpt.minF |
observations/summary |
API - Base Flex - Base |
| Average dew point in Celsius | Historical/Current | The average dew point in Celsius. Null if unavailable. | periods[#].summary.dewpt.avgC |
observations/summary |
API - Base Flex - Base |
| Average dew point in Fahrenheit | Historical/Current | The average dew point in Fahrenheit. Null if unavailable. | periods[#].summary.dewpt.avgF |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included dew point information | Historical/Current | The total number of observations that included dew point information. | periods[#].summary.dewpt.count |
observations/summary |
API - Base Flex - Base |
| Maximum relative humidity | Historical/Current | The maximum relative humidity (0-100%). Null if not available. | periods[#].summary.rh.max |
observations/summary |
API - Base Flex - Base |
| Minimum relative humidity | Historical/Current | The minimum relative humidity (0-100%). Null if not available. | periods[#].summary.rh.min |
observations/summary |
API - Base Flex - Base |
| Average relative humidity | Historical/Current | The average relative humidity (0-100%). Null if not available. | periods[#].summary.rh.avg |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included relative humidity information | Historical/Current | The total number of observations that included relative humidity information. | periods[#].summary.rh.count |
observations/summary |
API - Base Flex - Base |
| Maximum altimeter in millibars | Historical/Current | The maximum altimeter value in millibars. Null if not available | periods[#].summary.altimeter.maxMB |
observations/summary |
API - Base Flex - Base |
| Maximum altimeter in inches mercury | Historical/Current | The maximum altimeter value in inches mercury. Null if not available | periods[#].summary.altimeter.maxIN |
observations/summary |
API - Base Flex - Base |
| Minimum altimeter in millibars | Historical/Current | The minimum altimeter value in millibars. Null if not available | periods[#].summary.altimeter.minMB |
observations/summary |
API - Base Flex - Base |
| Minimum altimeter in inches mercury | Historical/Current | The minimum altimeter value in inches mercury. Null if not available | periods[#].summary.altimeter.minIN |
observations/summary |
API - Base Flex - Base |
| Average altimeter in millibars | Historical/Current | The average altimeter value in millibars. Null if not available | periods[#].summary.altimeter.avgMB |
observations/summary |
API - Base Flex - Base |
| Average altimeter in inches mercury | Historical/Current | The average altimeter value in inches mercury. Null if not available | periods[#].summary.altimeter.avgIN |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included altimeter information | Historical/Current | The total number of observations that included altimeter information. | periods[#].summary.altimeter.count |
observations/summary |
API - Base Flex - Base |
| Maximum MSLP in millibars | Historical/Current | The maximum MSLP in millibars. Null if not available. | periods[#].summary.pressure.maxMB |
observations/summary |
API - Base Flex - Base |
| Maximum MSLP in inches mercury | Historical/Current | The maximum MSLP in inches mercury. Null if not available. | periods[#].summary.pressure.maxIN |
observations/summary |
API - Base Flex - Base |
| Minimum MSLP in millibars | Historical/Current | The minimum MSLP in millibars. Null if not available. | periods[#].summary.pressure.minMB |
observations/summary |
API - Base Flex - Base |
| Minimum MSLP in inches mercury | Historical/Current | The minimum MSLP in inches mercury. Null if not available. | periods[#].summary.pressure.minIN |
observations/summary |
API - Base Flex - Base |
| Average MSLP in millibars | Historical/Current | The average MSLP in millibars. Null if not available. | periods[#].summary.pressure.avgMB |
observations/summary |
API - Base Flex - Base |
| Average MSLP in inches mercury | Historical/Current | The average MSLP in inches mercury. Null if not available. | periods[#].summary.pressure.avgIN |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included pressure information | Historical/Current | The total number of observations that included pressure information. | periods[#].summary.pressure.count |
observations/summary |
API - Base Flex - Base |
| Maximum station pressure in millibars | Historical/Current | The maximum station pressure in millibars. Null if not available. | periods[#].summary.spressure.maxMB |
observations/summary |
API - Base Flex - Base |
| Maximum station pressure in inches mercury | Historical/Current | The maximum station pressure in inches mercury. Null if not available. | periods[#].summary.spressure.maxIN |
observations/summary |
API - Base Flex - Base |
| Minimum station pressure in millibars | Historical/Current | The minimum station pressure in millibars. Null if not available. | periods[#].summary.spressure.minMB |
observations/summary |
API - Base Flex - Base |
| Minimum station pressure in inches mercury | Historical/Current | The minimum station pressure in inches mercury. Null if not available. | periods[#].summary.spressure.minIN |
observations/summary |
API - Base Flex - Base |
| Average station pressure in millibars | Historical/Current | The average station pressure in millibars. Null if not available. | periods[#].summary.spressure.avgMB |
observations/summary |
API - Base Flex - Base |
| Average station pressure in inches mercury | Historical/Current | The average station pressure in inches mercury. Null if not available. | periods[#].summary.spressure.avgIN |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included pressure information | Historical/Current | The total number of observations that included pressure information. | periods[#].summary.spressure.count |
observations/summary |
API - Base Flex - Base |
| Maximum visibility in kilometers | Historical/Current | The maximum visibility in kilometers. Null if not available. | periods[#].summary.visibility.maxKM |
observations/summary |
API - Base Flex - Base |
| Maximum visibility in miles | Historical/Current | The maximum visibility in miles. Null if not available. | periods[#].summary.visibility.maxMI |
observations/summary |
API - Base Flex - Base |
| Minimum visibility in kilometers | Historical/Current | The minimum visibility in kilometers. Null if not available. | periods[#].summary.visibility.minKM |
observations/summary |
API - Base Flex - Base |
| Minimum visibility in miles | Historical/Current | The minimum visibility in miles. Null if not available. | periods[#].summary.visibility.minMI |
observations/summary |
API - Base Flex - Base |
| Average visibility in kilometers | Historical/Current | The average visibility in kilometers. Null if not available. | periods[#].summary.visibility.avgKM |
observations/summary |
API - Base Flex - Base |
| Average visibility in miles | Historical/Current | The average visibility in miles. Null if not available. | periods[#].summary.visibility.avgMI |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included visibility information | Historical/Current | The total number of observations that included visibility information. | periods[#].summary.visibility.count |
observations/summary |
API - Base Flex - Base |
| Maximum wind speed in knots. Null if not available | Historical/Current | The maximum wind speed in knots. Null if not available. | periods[#].summary.wind.maxKTS |
observations/summary |
API - Base Flex - Base |
| Maximum wind speed in kilometers per hour | Historical/Current | The maximum wind speed in kilometers per hour. Null if not available. | periods[#].summary.wind.maxKPH |
observations/summary |
API - Base Flex - Base |
| Maximum wind speed in miles per hour | Historical/Current | The maximum wind speed in miles per hour. Null if not available. | periods[#].summary.wind.maxMPH |
observations/summary |
API - Base Flex - Base |
| Minimum wind speed in knots | Historical/Current | The minimum wind speed in knots. Null if not available. | periods[#].summary.wind.minKTS |
observations/summary |
API - Base Flex - Base |
| Minimum wind speed in kilometers per hour | Historical/Current | The minimum wind speed in kilometers per hour. Null if not available. | periods[#].summary.wind.minKPH |
observations/summary |
API - Base Flex - Base |
| Minimum wind speed in miles per hour | Historical/Current | The minimum wind speed in miles per hour. Null if not available. | periods[#].summary.wind.minMPH |
observations/summary |
API - Base Flex - Base |
| Average wind speed in knots | Historical/Current | The average wind speed in knots. Null if not available. | periods[#].summary.wind.avgKTS |
observations/summary |
API - Base Flex - Base |
| Average wind speed in kilometers per hour | Historical/Current | The average wind speed in kilometers per hour. Null if not available. | periods[#].summary.wind.avgKPH |
observations/summary |
API - Base Flex - Base |
| Average wind speed in miles per hour | Historical/Current | The average wind speed in miles per hour. Null if not available. | periods[#].summary.wind.avgMPH |
observations/summary |
API - Base Flex - Base |
| Maximum wind gust in knots | Historical/Current | The maximum wind gust in knots. Null if not available. | periods[#].summary.wind.gustKTS |
observations/summary |
API - Base Flex - Base |
| Maximum wind gust in kilometers per hour | Historical/Current | The maximum wind gust in kilometers per hour. Null if not available. | periods[#].summary.wind.gustKPH |
observations/summary |
API - Base Flex - Base |
| Maximum wind gust in miles per hour | Historical/Current | The maximum wind gust in miles per hour. Null if not available. | periods[#].summary.wind.gustMPH |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included wind information | Historical/Current | The total number of observations that included wind information. | periods[#].summary.wind.count |
observations/summary |
API - Base Flex - Base |
| Total liquid equivalent precipitation in millimeters | Historical/Current | The total liquid equivalent precipitation in millimeters. Null if not available. | periods[#].summary.precip.totalMM |
observations/summary |
API - Base Flex - Base |
| Total liquid equivalent precipitation in inches | Historical/Current | The total liquid equivalent precipitation in inches. Null if not available. | periods[#].summary.precip.totalIN |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included precip information | Historical/Current | The total number of observations that included precip information. | periods[#].summary.precip.count |
observations/summary |
API - Base Flex - Base |
| True if at least one observation reported a trace of precipitation | Historical/Current | True if at least one observation reported a trace of precipitation. | periods[#].summary.precip.trace |
observations/summary |
API - Base Flex - Base |
| Total number of observations that reported a trace of precipitation | Historical/Current | The total number of observations that reported a trace of precipitation. | periods[#].summary.precip.traceCount |
observations/summary |
API - Base Flex - Base |
| Array of observed weather observations | Historical/Current | Array of observed weather observations. Null if not available. Refer to the coded weather documentation for possible values. |
periods[#].summary.weather.coded |
observations/summary |
API - Base Flex - Base |
| Total number of observations that reported observed weather | Historical/Current | Total number of observations that reported observed weather. | periods[#].summary.weather.count |
observations/summary |
API - Base Flex - Base |
| General weather phrase for the summary period | Historical/Current | The general weather phrase for the summary period. Null if not available. | periods[#].summary.weather.phrase |
observations/summary |
API - Base Flex - Base |
| Primary weather string that occurred during the summary period | Historical/Current | The primary weather string that occurred during the summary period. Null if not available. | periods[#].summary.weather.primary |
observations/summary |
API - Base Flex - Base |
| Primary weather coded string | Historical/Current | The primary weather coded string. Null if not available. Refer to the coded weather documentation for possible values. |
periods[#].summary.weather.primaryCoded |
observations/summary |
API - Base Flex - Base |
| Standard AerisWeather icon string | Historical/Current | The standard AerisWeather icon string. Null if not available. | periods[#].summary.weather.icon |
observations/summary |
API - Base Flex - Base |
| Maximum sky coverage | Historical/Current | The maximum sky coverage (0-100, 0 = clear, 100 = overcast). Null if not available. | periods[#].summary.sky.max |
observations/summary |
API - Base Flex - Base |
| Minimum sky coverage | Historical/Current | The minimum sky coverage (0-100, 0 = clear, 100 = overcast). Null if not available. | periods[#].summary.sky.min |
observations/summary |
API - Base Flex - Base |
| Average sky coverage | Historical/Current | The average sky coverage (0-100, 0 = clear, 100 = overcast). Null if not available. | periods[#].summary.sky.avg |
observations/summary |
API - Base Flex - Base |
| Total number of observations that reported cloud coverage | Historical/Current | Total number of observations that reported cloud coverage. | periods[#].summary.sky.count |
observations/summary |
API - Base Flex - Base |
| Coded reported sky coverages | Historical/Current | The coded reported sky coverages. Refer to the coded weather documentation for possible values. |
periods[#].summary.sky.coded |
observations/summary |
API - Base Flex - Base |
| Maximum reported solar radiation | Historical/Current | The maximum reported solar radiation. Null if not available. | periods[#].summary.solrad.maxWM2 |
observations/summary |
API - Base Flex - Base |
| Minimum reported solar radiation | Historical/Current | The minimum reported solar radiation. Null if not available. | periods[#].summary.solrad.minWM2 |
observations/summary |
API - Base Flex - Base |
| Average reported solar radiation | Historical/Current | The average reported solar radiation. Null if not available. | periods[#].summary.solrad.avgWM2 |
observations/summary |
API - Base Flex - Base |
| Total number of observations that reported solar radiation | Historical/Current | Total number of observations that reported solar radiation. | periods[#].summary.solrad.count |
observations/summary |
API - Base Flex - Base |
| Maximum trust factor based on the observations used within the summary | Historical/Current | The maximum trust factor based on the observations used within the summary | periods[#].summary.trustfactor.max |
observations/summary |
API - Base Flex - Base |
| Minimum trust factor based on the observations used within the summary | Historical/Current | The minimum trust factor based on the observations used within the summary. Note the API normally requires a summary to have a minimum trustFactor of 70 or higher, before utilizing the summary. | periods[#].summary.trustfactor.min |
observations/summary |
API - Base Flex - Base |
| Total number of observations that included the trustFactor information | Historical/Current | The total number of observations that included the trustFactor information. | periods[#].summary.trustfactor.count |
observations/summary |
API - Base Flex - Base |
| Boolean stating if the observation summary has precipitation | Historical/Current | A boolean stating if the observation summary has precipitation. | profile.hasPrecip |
observations/summary |
API - Base Flex - Base |
| Object containing the phrases | Current/Forecast | Object containing the phrases | phrases |
phrases/summary |
API - Base Flex - Base |
| Short version of phrasing using imperial units | Current/Forecast | Short version of phrasing using imperial units | phrases.short |
phrases/summary |
API - Base Flex - Base |
| Short version of phrasing using metric units | Current/Forecast | Short version of phrasing using metric units | phrases.shortMET |
phrases/summary |
API - Base Flex - Base |
| Long version of phrasing using imperial units | Current/Forecast | Long version of phrasing using imperial units | phrases.long |
phrases/summary |
API - Base Flex - Base |
| Long version of phrasing using metric units | Current/Forecast | Long version of phrasing using metric units | phrases.longMET |
phrases/summary |
API - Base Flex - Base |
| Population of the location | Current | The . | profile.pop |
places |
API - Base Flex - Base |
| Array of public weather zones (US) or Canadian Location Codes (CLCs for Canada) that the location is within | Current | Array of public weather zones (US) or Canadian Location Codes (CLCs for Canada) that the location is within. Null if not available | profile.wxzone |
places |
API - Base Flex - Base |
| Array of public fire zones (US only) that the location is within | Current | Array of public fire zones (US only) that the location is within. Null if not available | profile.firezone |
places |
API - Base Flex - Base |
| Array of county FIPs codes (US only) that the location is within | Current | Array of county FIPs codes (US only) that the location is within. Null if not available | profile.fips |
places |
API - Base Flex - Base |
| Array of county codes (US only) that the location is within | Current | Array of county codes (US only) that the location is within. NULL if not available | profile.countyid |
places |
API - Base Flex - Base |
| Globally recognized airport ID | Current | The globally recognized airport ID. | id |
places/airports |
API - Base Flex - Base |
| Name of the airport's city | Current | The name of the airport's city. | place.city |
places/airports |
API - Base Flex - Base |
| Globally recognized airport ID | Current | The globally recognized airport ID. | profile.id |
places/airports |
API - Base Flex - Base |
| The 3 character IATA code for the location | Current | The 3 character IATA code for the location. (Empty string if not available) | profile.iata |
places/airports |
API - Base Flex - Base |
| Local ID/code for the location | Current | The local ID/code for the location. (Empty string if not available) | profile.local |
places/airports |
API - Base Flex - Base |
| Facility type code | Current | The facility type code: - sa = small airport - ma = medium airport - la = large ariport - h = heliport - b = balloonport - sea = sea base - c = closed |
profile.type |
places/airports |
API - Base Flex - Base |
| English name of the facility type | Current | The English name of the facility type. | profile.typeENG |
places/airports |
API - Base Flex - Base |
| Array of public weather zones (US) or Canadian Location Codes (CLCs for Canada) that the location is within | Current | (deprecated) Array of public weather zones (US) or Canadian Location Codes (CLCs for Canada) that the location is within. Null if not available | profile.wxzone |
places/airports |
API - Base Flex - Base |
| Array of public fire zones (US only) that the location is within | Current | (deprecated) Array of public fire zones (US only) that the location is within. Null if not available | profile.firezone |
places/airports |
API - Base Flex - Base |
| Array of county FIPs codes (US only) that the location is within | Current | (deprecated) Array of county FIPs codes (US only) that the location is within. Null if not available | profile.fips |
places/airports |
API - Base Flex - Base |
| Array of county codes (US only) that the location is within | Current | (deprecated) Array of county codes (US only) that the location is within. NULL if not available | profile.countyid |
places/airports |
API - Base Flex - Base |
| The postal/zip code | Current | The postal/zip code. | id |
places/postalcodes |
API - Base Flex - Base |
| Array of public weather zones (US) or Canadian Location Codes (CLCs for Canada) that the location is within | Current | Array of public weather zones (US) or Canadian Location Codes (CLCs for Canada) that the location is within. Null if not available | profile.wxzone |
places/postalcodes |
API - Base Flex - Base |
| Array of public fire zones (US only) that the location is within | Current | Array of public fire zones (US only) that the location is within. Null if not available | profile.firezone |
places/postalcodes |
API - Base Flex - Base |
| Array of county FIPs codes (US only) that the location is within | Current | Array of county FIPs codes (US only) that the location is within. Null if not available | profile.fips |
places/postalcodes |
API - Base Flex - Base |
| Array of county codes (US only) that the location is within | Current | Array of county codes (US only) that the location is within. NULL if not available | profile.countyid |
places/postalcodes |
API - Base Flex - Base |
| True if the postal/zip code is still active and allowed by the postal service. False if the postal/zip code is no longer in use | Current | True if the postal/zip code is still active and allowed by the postal service. False if the postal/zip code is no longer in use, though the AerisWeather API will continue to support it. | profile.active |
places/postalcodes |
API - Base Flex - Base |
| ID of the record observation | Current | The ID of the record observation. | id |
records |
API - Base Flex - Base |
| Timestamp when the event took place | Current | UNIX timestamp when the event took place. | report.timestamp |
records |
API - Base Flex - Base |
| Date of the date/time of the event | Current | ISO 8601 date of the date/time of the event. | report.dateTimeISO |
records |
API - Base Flex - Base |
| The record type | Current | The record type: - prcp = precipitation / rain - snow = snow - hsnd = snow depth - maxt = maximum temperature - mint = minimum temperature - himn = high minimum temperature - lomx = low minimum temperature |
report.type |
records |
API - Base Flex - Base |
| Numeric representation of the record type | Current | Numeric representation of the record type. | report.code |
records |
API - Base Flex - Base |
| ID of the station where the record occurred | Current | The ID of the station where the record occurred. | report.station.id |
records |
API - Base Flex - Base |
| Type of station | Current | The type of station. | report.station.type |
records |
API - Base Flex - Base |
| Name of the station | Current | The name of the station. | report.station.name |
records |
API - Base Flex - Base |
| Brief description of the location, usually contains the location or relative distance from a city | Current | The brief description of the location, usually contains the location or relative distance from a city. | report.location |
records |
API - Base Flex - Base |
| Actual value from the record | Current | The actual value from the record. | report.details.text |
records |
API - Base Flex - Base |
| If a snow record, the amount of snow in inches | Current | If a snow record, the amount of snow in inches. | report.details.snowIN |
records |
API - Base Flex - Base |
| If a snow record, the amount of snow in centimeters | Current | If a snow record, the amount of snow in centimeters. | report.details.snowCM |
records |
API - Base Flex - Base |
| If a rain record, the amount of rain in inches | Current | If a rain record, the amount of rain in inches. | report.details.rainIN |
records |
API - Base Flex - Base |
| If a rain record, the amount of rain in millimeters | Current | If a rain record, the amount of rain in millimeters. | report.details.rainMM |
records |
API - Base Flex - Base |
| If a temperature record, the value in Fahrenheit | Current | If a temperature record, the value in Fahrenheit. | report.details.tempF |
records |
API - Base Flex - Base |
| If a temperature record, the value in Celsius | Current | If a temperature record, the value in Celsius. | report.details.tempC |
records |
API - Base Flex - Base |
| If tied a previous record = true, otherwise false | Current | If tied a previous record = true, otherwise false. | report.tied |
records |
API - Base Flex - Base |
| Timestamp of the previous record. Null if unavailable | Current | UNIX timestamp of the previous record. Null if unavailable. | report.prev.timestamp |
records |
API - Base Flex - Base |
| Date of the date/time of the previous record | Current | ISO 8601 date of the date/time of the previous record. Null if unavailable. | report.prev.dateTimeISO |
records |
API - Base Flex - Base |
| Actual value from the previous record | Current | The actual value from the previous record. | report.prev.details.text |
records |
API - Base Flex - Base |
| If a snow record, the previous amount of snow in inches | Current | If a snow record, the previous amount of snow in inches. | report.prev.details.snowIN |
records |
API - Base Flex - Base |
| If a snow record, the previous amount of snow in centimeters | Current | If a snow record, the previous amount of snow in centimeters. | report.prev.details.snowCM |
records |
API - Base Flex - Base |
| If a rain record, the previous amount of rain in inches | Current | If a rain record, the previous amount of rain in inches. | report.prev.details.rainIN |
records |
API - Base Flex - Base |
| If a rain record, the previous amount of rain in millimeters | Current | If a rain record, the previous amount of rain in millimeters. | report.prev.details.rainMM |
records |
API - Base Flex - Base |
| If a temperature record, the previous value in Fahrenheit | Current | If a temperature record, the previous value in Fahrenheit. | report.prev.details.tempF |
records |
API - Base Flex - Base |
| If a temperature record, the previous value in Celsius | Current | If a temperature record, the previous value in Celsius. | report.prev.details.tempC |
records |
API - Base Flex - Base |
| River gauge ID | Current | The river gauge ID | id |
rivers |
API - Base Flex - Base |
| Observation object | Current | The observation object | ob |
rivers |
API - Base Flex - Base |
| Timestamp of the observation time | Current | Unix timestamp of the observation time | ob.timestamp |
rivers |
API - Base Flex - Base |
| Date of the time the observation was taken | Current | ISO 8601 date of the time the observation was taken | ob.dateTimeISO |
rivers |
API - Base Flex - Base |
| Water height in feet | Current | The water height in feet. Null if unavailable | ob.heightFT |
rivers |
API - Base Flex - Base |
| Water height in meters | Current | The water height in meters. Null if unavailable | ob.heightM |
rivers |
API - Base Flex - Base |
| Water flow in cubic feet per second | Current | The water flow in cubic feet per second. Null if unavailable | ob.flowCFS |
rivers |
API - Base Flex - Base |
| Water flow in cubic meters per second | Current | The water flow in cubic meters per second. Null if unavailable | ob.flowCMS |
rivers |
API - Base Flex - Base |
| Secondary sensor for gauges that include backup | Current | Secondary sensor for gauges that include backup. Normally null, since most do not include backups | ob.secondary |
rivers |
API - Base Flex - Base |
| Water height in fee | Current | The water height in feet. Null if unavailable | ob.secondary.heightFT |
rivers |
API - Base Flex - Base |
| Water height in meters | Current | The water height in meters. Null if unavailable | ob.secondary.heightFT |
rivers |
API - Base Flex - Base |
| Water flow in cubic feet per second | Current | The water flow in cubic feet per second. Null if unavailable | ob.secondary.flowCFS |
rivers |
API - Base Flex - Base |
| Water flow in cubic meters per second | Current | The water flow in cubic meters per second. Null if unavailable | ob.secondary.flowCMS |
rivers |
API - Base Flex - Base |
| Current river/lake status | Current | The current river/lake status: out_of_service - Gauge is known to be out of service obs_not_current - Gauge has not reported updated observations recently not_defined - Gauge is reporting observations but has no action/flooding levels defined, thus cannot determine if flooding low_threshold - Gauge is reporting levels below the defined low water threshold no_flooding - Gauge is reporting observations and below flood and action levels action - Gauge is reporting observations at or above action levels. Normally means near flood stage minor - Gauge is reporting levels at or above the minor flood level moderate - Gauge is reporting levels at or above the defined moderate flood level major - Gauge is reporting levels at or above the defined major flood level |
ob.status |
rivers |
API - Base Flex - Base |
| Numeric code of the river/lake status | Current | The numeric code of the river/lake status: out_of_service: -1 obs_not_current: 0 not_defined: 1 low_threshold: 3 no_flooding: 5 action: 7 minor: 9 moderate: 11 major: 13 |
ob.statusCode |
rivers |
API - Base Flex - Base |
| Local impacts, if available and river is flooding | Current | Local impacts, if available and river is flooding. Null if unavailable or river is not flooding | ob.impact |
rivers |
API - Base Flex - Base |
| Gauge profile object | Current | Gauge profile object | profile |
rivers |
API - Base Flex - Base |
| Local timezone name for the location of the gauge | Current | The local timezone name for the location of the gauge | profile.tz |
rivers |
API - Base Flex - Base |
| Water body where the gauge is located | Current | The water body where the gauge is located | profile.waterbody |
rivers |
API - Base Flex - Base |
| When available, the define categories for various flood levels at the gauge location | Current | When available, the define categories for various flood levels at the gauge location. Null if not defined | profile.cats |
rivers |
API - Base Flex - Base |
| Height, in feet, when the waterbody nears flood stage | Current | The height, in feet, when the waterbody nears flood stage | profile.cats.actionFT |
rivers |
API - Base Flex - Base |
| Height, in meters, when the waterbody nears flood stage | Current | The height, in meters, when the waterbody nears flood stage | profile.cats.actionM |
rivers |
API - Base Flex - Base |
| Height, in feet, that flooding begins | Current | The height, in feet, that flooding begins | profile.cats.floodFT |
rivers |
API - Base Flex - Base |
| Height, in meters, that flooding begins | Current | The height, in meters, that flooding begins | profile.cats.floodM |
rivers |
API - Base Flex - Base |
| Height, in feet, that moderate flooding begins | Current | The height, in feet, that moderate flooding begins | profile.cats.moderateFT |
rivers |
API - Base Flex - Base |
| Height, in meters, that moderate flooding begins | Current | The height, in meters, that moderate flooding begins | profile.cats.moderateM |
rivers |
API - Base Flex - Base |
| Height, in feet, that major flooding begins | Current | The height, in feet, that major flooding begins | profile.cats.majorFT |
rivers |
API - Base Flex - Base |
| Height, in meters, that major flooding begins | Current | The height, in meters, that major flooding begins | profile.cats.majorM |
rivers |
API - Base Flex - Base |
| Height, in feet, that the water body is considered to be low | Current | The height, in feet, that the water body is considered to be low | profile.cats.lowthreshFT |
rivers |
API - Base Flex - Base |
| Height, in meters, that the water body is considered to be low | Current | The height, in meters, that the water body is considered to be low | profile.cats.lowthreshM |
rivers |
API - Base Flex - Base |
| True if the gauge include flooding impacts, false if unavailable | Current | True if the gauge include flooding impacts, false if unavailable | profile.hasImpacts |
rivers |
API - Base Flex - Base |
| Gauge ID | Historical/Current | Gauge ID | id |
rivers/gauges |
API - Base Flex - Base |
| Object of profile information | Historical/Current | Object of profile information | profile |
rivers/gauges |
API - Base Flex - Base |
| Timezone name association with the gauge's location | Historical/Current | The timezone name association with the gauge's location. | profile.tz |
rivers/gauges |
API - Base Flex - Base |
| Waterbody that the gauge is on | Historical/Current | The waterbody that the gauge is on. | profile.waterbody |
rivers/gauges |
API - Base Flex - Base |
| Object of the gauge flood categories | Historical/Current | Object of the gauge flood categories | profile.cats |
rivers/gauges |
API - Base Flex - Base |
| Height in feet near flood stage | Historical/Current | The height in feet near flood stage. Null if not available | profile.cats.actionFT |
rivers/gauges |
API - Base Flex - Base |
| Height in meters near flood stage | Historical/Current | The height in meters near flood stage. Null if not available | profile.cats.actionM |
rivers/gauges |
API - Base Flex - Base |
| Water height in feet that flooding begins to occur | Historical/Current | The water height in feet that flooding begins to occur. Null if not available. | profile.cats.floodFT |
rivers/gauges |
API - Base Flex - Base |
| Water height in meters that flooding begins to occur | Historical/Current | The water height in meters that flooding begins to occur. Null if not available. | profile.cats.floodM |
rivers/gauges |
API - Base Flex - Base |
| Water height in feet that moderate flooding begins to occur | Historical/Current | The water height in feet that moderate flooding begins to occur. Null if not available. | profile.cats.moderateFT |
rivers/gauges |
API - Base Flex - Base |
| Water height in meters that moderate flooding begins to occur | Historical/Current | The water height in meters that moderate flooding begins to occur. Null if not available. | profile.cats.moderateM |
rivers/gauges |
API - Base Flex - Base |
| Water height in feet that major flooding begins to occur | Historical/Current | The water height in feet that major flooding begins to occur. Null if not available. | profile.cats.majorFT |
rivers/gauges |
API - Base Flex - Base |
| Water height in meters that major flooding begins to occur | Historical/Current | The water height in meters that major flooding begins to occur. Null if not available. | profile.cats.majorFM |
rivers/gauges |
API - Base Flex - Base |
| Array of flood impacts | Historical/Current | Array of flood impacts. Null if not available | profile.impacts |
rivers/gauges |
API - Base Flex - Base |
| Height in feet that the impact begins to occur | Historical/Current | The height in feet that the impact begins to occur. | profile.impacts.#.heightFT |
rivers/gauges |
API - Base Flex - Base |
| height in meters that the impact begins to occur | Historical/Current | The height in meters that the impact begins to occur. | profile.impacts.#.heightM |
rivers/gauges |
API - Base Flex - Base |
| The impact description | Historical/Current | The impact description. | profile.impacts.#.text |
rivers/gauges |
API - Base Flex - Base |
| Array of low water records | Historical/Current | Array of low water records | profile.lowWaterRecords |
rivers/gauges |
API - Base Flex - Base |
| Timestamp of the date the low water record occurred | Historical/Current | The unix timestamp of the date the low water record occurred | profile.lowWaterRecords.#.timestamp |
rivers/gauges |
API - Base Flex - Base |
| Date of when the low water record occurred | Historical/Current | ISO 8601 date of when the low water record occurred | profile.lowWaterRecords.#.dateTimeISO |
rivers/gauges |
API - Base Flex - Base |
| Water height in feet of the low water record | Historical/Current | The water height in feet of the low water record. | profile.lowWaterRecords.#.heightFT |
rivers/gauges |
API - Base Flex - Base |
| Water height in meters of the low water record | Historical/Current | The water height in meters of the low water record. | profile.lowWaterRecords.#.heightM |
rivers/gauges |
API - Base Flex - Base |
| Object of crest information | Historical/Current | Object of crest information | profile.crests |
rivers/gauges |
API - Base Flex - Base |
| Array of recent crests | Historical/Current | Array of recent crests. Null if unavailable | profile.crests.recent |
rivers/gauges |
API - Base Flex - Base |
| Timestamp of the date of the crest | Historical/Current | The unix timestamp of the date of the crest | profile.crests.recent.#.timestamp |
rivers/gauges |
API - Base Flex - Base |
| Date of the crest | Historical/Current | The ISO 8601 date of the crest | profile.crests.recent.#.dateTimeISO |
rivers/gauges |
API - Base Flex - Base |
| Height in feet of the crest | Historical/Current | The height in feet of the crest | profile.crests.recent.#.heightFT |
rivers/gauges |
API - Base Flex - Base |
| Height in meters of the crest | Historical/Current | The height in meters of the crest | profile.crests.recent.#.heightM |
rivers/gauges |
API - Base Flex - Base |
| Array of historic crests | Historical/Current | Array of historic crests. Null if unavailable | profile.crests.historic |
rivers/gauges |
API - Base Flex - Base |
| Timestamp of the date of the crest | Historical/Current | The unix timestamp of the date of the crest | profile.crests.historic.#.timestamp |
rivers/gauges |
API - Base Flex - Base |
| Date of the crest | Historical/Current | The ISO 8601 date of the crest | profile.crests.historic.#.dateTimeISO |
rivers/gauges |
API - Base Flex - Base |
| Height in feet of the crest | Historical/Current | The height in feet of the crest | profile.crests.historic.#.heightFT |
rivers/gauges |
API - Base Flex - Base |
| Height in meters of the crest | Historical/Current | The height in meters of the crest | profile.crests.historic.#.heightM |
rivers/gauges |
API - Base Flex - Base |
| The ID of the requested location | Current/Forecast | The ID of the requested location. | id |
roadweather |
Flex - Base API - Base API Developer |
| The data source provider | Current/Forecast | An ID string of the data source provider utilized for the data set | dataSource |
roadweather |
Flex - Base API - Base API Developer |
| Object of road information | Current/Forecast | An object containing the nearby road information. Null if unavailable. | road |
roadweather |
Flex - Base API - Base API Developer |
| The type of road | Current/Forecast | The type of road. Can be: - primary - secondary - tertiary - bridge |
road.type |
roadweather |
Flex - Base API - Base API Developer |
| The road name. | Current/Forecast | The road name. Null if unavailable. | road.name |
roadweather |
Flex - Base API - Base API Developer |
| The valid timestamp in seconds. | Current/Forecast | The unix timestamp in seconds of the valid date/time of the forecast | periods.#.timestamp |
roadweather |
Flex - Base API - Base API Developer |
| The ISO8601 valid date/time | Current/Forecast | The ISO8601 valid date/time of the forecast period | periods.#.dateTimeISO |
roadweather |
Flex - Base API - Base API Developer |
| A Summary of the road conditions, GREEN, YELLOW, or RED | Current/Forecast | A summary of road conditions broken down as: - GREEN = dry roads with no issues - YELLOW = Potential for wet roads, extend caution - RED = Potential adverse road conditions. Available to all Flex Subscribers. |
periods.#.summary |
roadweather |
Flex - Base API - Base API Developer |
| A numerical index of the road conditions summary. | Current/Forecast | A numerical version of the road conditions summary: - 0 = GREEN - 1 = YELLOW - 2 = RED Available to all Flex Subscribers. |
periods.#.summaryIndex |
roadweather |
Flex - Base API - Base API Developer |
| The ID of the requested location | Current/Forecast | The ID of the requested location. | id |
roadweather/analytics |
Flex - Base API - Base |
| The data source provider | Current/Forecast | An ID string of the data source provider utilized for the data set | dataSource |
roadweather/analytics |
Flex - Base API - Base |
| Object of road information | Current/Forecast | An object containing the nearby road information. Null if unavailable. | road |
roadweather/analytics |
Flex - Base API - Base |
| The type of road | Current/Forecast | The type of road. Can be: - primary - secondary - tertiary - bridge |
road.type |
roadweather/analytics |
Flex - Base API - Base |
| The road name. | Current/Forecast | The road name. Null if unavailable. | road.name |
roadweather/analytics |
Flex - Base API - Base |
| The valid timestamp in seconds. | Current/Forecast | The unix timestamp in seconds of the valid date/time of the forecast | periods.#.timestamp |
roadweather/analytics |
Flex - Base API - Base |
| The ISO8601 valid date/time | Current/Forecast | The ISO8601 valid date/time of the forecast period | periods.#.dateTimeISO |
roadweather/analytics |
Flex - Base API - Base |
| Current/Forecast | A summary of road conditions broken down as: - GREEN = dry roads with no issues - YELLOW = Potential for wet roads, extend caution - RED = Potential adverse road conditions. Available to all Flex Subscribers. |
periods.#.summary |
roadweather/analytics |
Flex - Base API - Base |
|
| A numerical index of the road conditions summary. | Current/Forecast | A numerical version of the road conditions summary: - 0 = GREEN - 1 = YELLOW - 2 = RED Available to all Flex Subscribers. |
periods.#.summaryIndex |
roadweather/analytics |
Flex - Base API - Base |
| Advanced road surface information. | Current/Forecast | An object containing advanced road surface information. Requires the Road Weather Conditions or Analytics Addon. Not returned for standard Flex Subscribers. |
periods.#.roadSurface |
roadweather/analytics |
Flex - Base API - Base |
| The condition of the road surface. | Current/Forecast | The condition of the road surface. Will be one of the following: - DRY - MOIST - WET - SLUSH - SNOW - ICE Available with a Road Weather Addon. |
periods.#.roadSurface.condition |
roadweather/analytics |
Flex - Base API - Base |
| The road surface temperature in Celsius | Current/Forecast | The estimated road surface temperature in Celsius | periods.#.roadSurface.tempC |
roadweather/analytics |
Flex - Base API - Base |
| The road surface temperature in Fahrenheit | Current/Forecast | The estimated road surface temperature in Fahrenheit | periods.#.roadSurface.tempF |
roadweather/analytics |
Flex - Base API - Base |
| The water film thickness on the road surface in mm. | Current/Forecast | The estimated water film thickness on the road surface in millimeters. Available with the Road Weather Analytics Addon. |
periods.#.roadSurface.waterFilmThicknessMM |
roadweather/analytics |
Flex - Base API - Base |
| The water film thickness on the road surface in inches. | Current/Forecast | The estimated water film thickness on the road surface in inches. Available with the Road Weather Analytics Addon. |
periods.#.roadSurface.waterFilmThicknessIN |
roadweather/analytics |
Flex - Base API - Base |
| The snow thickness on the road surface in cm. | Current/Forecast | The estimated snow thickness on the road surface in centimeters. Available with the Road Weather Analytics Addon. |
periods.#.roadSurface.snowThicknessCM |
roadweather/analytics |
Flex - Base API - Base |
| The snow thickness on the road surface in inches. | Current/Forecast | The estimated snow thickness on the road surface in inches. Available with the Road Weather Analytics Addon. |
periods.#.roadSurface.snowThicknessIN |
roadweather/analytics |
Flex - Base API - Base |
| The ice thickness on the road surface in mm. | Current/Forecast | The estimated ice thickness on the road surface in millimeters. Available with the Road Weather Analytics Addon. |
periods.#.roadSurface.iceThicknessMM |
roadweather/analytics |
Flex - Base API - Base |
| The ice thickness on the road surface in inches. | Current/Forecast | The estimated ice thickness on the road surface in inches. Available with the Road Weather Analytics Addon. |
periods.#.roadSurface.iceThicknessIN |
roadweather/analytics |
Flex - Base API - Base |
| Probabilities of the road surface conditions. | Current/Forecast | Object of probabilities of the road surface conditions. Available with the Road Weather Analytics Addon. Not returned for other requests. |
periods.#.roadSurface.conditionProbability |
roadweather/analytics |
Flex - Base API - Base |
| The probability the road surface is dry, from 0 to 100. | Current/Forecast | The probability the road surface is dry, from 0 to 100. Note: All conditionProbability values (dry, wet, snow, ice) will sum up to a total value of 100%. |
periods.#.roadSurface.conditionProbability.dry |
roadweather/analytics |
Flex - Base API - Base |
| The probability the road surface is wet | Current/Forecast | The probability the road surface is wet, from 0 to 100. Note: All conditionProbability values (dry, wet, snow, ice) will sum up to a total value of 100%. |
periods.#.roadSurface.conditionProbability.wet |
roadweather/analytics |
Flex - Base API - Base |
| The probability the road surface is snow covered | Current/Forecast | The probability the road surface is snow covered, from 0 to 100. Note: All conditionProbability values (dry, wet, snow, ice) will sum up to a total value of 100%. |
periods.#.roadSurface.conditionProbability.snow |
roadweather/analytics |
Flex - Base API - Base |
| The probability the road surface has ice | Current/Forecast | The probability the road surface has ice, from 0 to 100. Note: All conditionProbability values (dry, wet, snow, ice) will sum up to a total value of 100%. |
periods.#.roadSurface.conditionProbability.ice |
roadweather/analytics |
Flex - Base API - Base |
| Risk Probabilities | Current/Forecast | Object of risk probabilities. Available with the Road Weather Analytics Addon. Not returned for other requests. |
periods.#.riskProbability |
roadweather/analytics |
Flex - Base API - Base |
| The risk probability of a rollover | Current/Forecast | The risk probability of a truck rollover, from 0 to 100. | periods.#.riskProbability.truckRollover |
roadweather/analytics |
Flex - Base API - Base |
| The risk probability of hydroplaning | Current/Forecast | The risk probability of hydroplaning, from 0 to 100. | periods.#.riskProbability.hydroplane |
roadweather/analytics |
Flex - Base API - Base |
| The risk probability of low visibility from fog | Current/Forecast | The risk probability of low visibility from fog, from 0 to 100. | periods.#.riskProbability.lowVisFog |
roadweather/analytics |
Flex - Base API - Base |
| The risk probability of low visibility from blowing snow | Current/Forecast | The risk probability of low visibility from blowing snow, from 0 to 100. | periods.#.riskProbability.lowVisBlowingSnow |
roadweather/analytics |
Flex - Base API - Base |
| The atmospheric weather conditions | Current/Forecast | Object of the atmospheric weather conditions Available with the Road Weather Analytics Addon. Will be an object when using `filter=addweather`, null otherwise. |
periods.#.weatherConditions |
roadweather/analytics |
Flex - Base API - Base |
| The ID of the requested location | Current/Forecast | The ID of the requested location. | id |
roadweather/conditions | |
| The data source provider | Current/Forecast | An ID string of the data source provider utilized for the data set | dataSource |
roadweather/conditions | |
| Object of road information | Current/Forecast | An object containing the nearby road information. Null if unavailable. | road |
roadweather/conditions | |
| The type of road | Current/Forecast | The type of road. Can be: - primary - secondary - tertiary - bridge |
road.type |
roadweather/conditions | |
| The road name. | Current/Forecast | The road name. Null if unavailable. | road.name |
roadweather/conditions | |
| The valid timestamp in seconds. | Current/Forecast | The unix timestamp in seconds of the valid date/time of the forecast | periods.#.timestamp |
roadweather/conditions | |
| The ISO8601 valid date/time | Current/Forecast | The ISO8601 valid date/time of the forecast period | periods.#.dateTimeISO |
roadweather/conditions | |
| A Summary of the road conditions, GREEN, YELLOW, or RED | Current/Forecast | A summary of road conditions broken down as: - GREEN = dry roads with no issues - YELLOW = Potential for wet roads, extend caution - RED = Potential adverse road conditions. Available to all Flex Subscribers. |
periods.#.summary |
roadweather/conditions | |
| A numerical index of the road conditions summary. | Current/Forecast | A numerical version of the road conditions summary: - 0 = GREEN - 1 = YELLOW - 2 = RED Available to all Flex Subscribers. |
periods.#.summaryIndex |
roadweather/conditions | |
| Advanced road surface information. | Current/Forecast | An object containing advanced road surface information. Requires the Road Weather Conditions or Analytics Addon. Not returned for standard Flex Subscribers. |
periods.#.roadSurface |
roadweather/conditions | |
| The condition of the road surface. | Current/Forecast | The condition of the road surface. Will be one of the following: - DRY - MOIST - WET - SLUSH - SNOW - ICE Available with a Road Weather Addon. |
periods.#.roadSurface.condition |
roadweather/conditions | |
| The road surface temperature in Celsius | Current/Forecast | The estimated road surface temperature in Celsius | periods.#.roadSurface.tempC |
roadweather/conditions | |
| The road surface temperature in Fahrenheit | Current/Forecast | The estimated road surface temperature in Fahrenheit | periods.#.roadSurface.tempF |
roadweather/conditions | |
| Cell ID | Current/Forecast | Cell ID. | id |
stormcells |
API - Base Flex - Base |
| Timestamp of the cell observation | Current/Forecast | UNIX timestamp of the cell observation. | ob.timestamp |
stormcells |
API - Base Flex - Base |
| Date of the observation | Current/Forecast | ISO 8601 date of the observation. | ob.dateTimeISO |
stormcells |
API - Base Flex - Base |
| Radar site ID reporting the cell | Current/Forecast | The radar site ID reporting the cell. | ob.radarID |
stormcells |
API - Base Flex - Base |
| Unique cell identifier | Current/Forecast | The unique cell identifier. | ob.cellID |
stormcells |
API - Base Flex - Base |
| Current latitude position of the storm | Current/Forecast | Current latitude position of the storm. | ob.cpos.lat |
stormcells |
API - Base Flex - Base |
| Current longitude position of the storm | Current/Forecast | Current longitude position of the storm. | ob.cpos.long |
stormcells |
API - Base Flex - Base |
| Bearing in degrees of the cell relative to the radar site | Current/Forecast | Bearing in degrees of the cell relative to the radar site. | ob.cpos.deg |
stormcells |
API - Base Flex - Base |
| Distance in nautical miles of the cell relative to the radar site | Current/Forecast | Distance in nautical miles of the cell relative to the radar site. | ob.cpos.NM |
stormcells |
API - Base Flex - Base |
| An object containing movement information | Current/Forecast | An object containing movement information. If no movement information is available this can be set to NULL. No movement can occur if the storm cell is newly detected, stationary or ending. |
ob.movement |
stormcells |
API - Base Flex - Base |
| Direction the storm is moving in degrees | Current/Forecast | The direction the storm is moving in degrees. | ob.movement.dirDEG |
stormcells |
API - Base Flex - Base |
| Cardinal direction the storm is moving | Current/Forecast | The cardinal direction the storm is moving. | ob.movement.dir |
stormcells |
API - Base Flex - Base |
| Direction the storm is moving relative to the reported radar site in degreeS | Current/Forecast | The direction the storm is moving relative to the reported radar site in degrees. | ob.movement.dirToDEG |
stormcells |
API - Base Flex - Base |
| cardinal direction the storm is moving relative to the reported radar site | Current/Forecast | The cardinal direction the storm is moving relative to the reported radar site. | ob.movement.dirTo |
stormcells |
API - Base Flex - Base |
| Speed the storm is moving, in knots | Current/Forecast | Speed the storm is moving, in knots. | ob.movement.speedKTS |
stormcells |
API - Base Flex - Base |
| Speed the storm is moving, in kilometers per hour | Current/Forecast | Speed the storm is moving, in kilometers per hour. | ob.movement.speedKPH |
stormcells |
API - Base Flex - Base |
| Speed the storm is moving, in miles per hour | Current/Forecast | Speed the storm is moving, in miles per hour | ob.movement.speedMPH |
stormcells |
API - Base Flex - Base |
| Speed the storm is moving, in kilometers per hour | Current/Forecast | Speed the storm is moving, in kilometers per hour | ob.movement.speedKMH |
stormcells |
API - Base Flex - Base |
| Tornado vortex signature | Current/Forecast | Tornado vortex signature. (TVS) 0 = NO TVS 1 = TVS indicated |
ob.tvs |
stormcells |
API - Base Flex - Base |
| Mesocyclone rotation | Current/Forecast | Mesocyclone rotation. (MESO) A value from 0 - 25, higher values indicate higher mesoscale rotation |
ob.mda |
stormcells |
API - Base Flex - Base |
| Vertically integrated liquid | Current/Forecast | Vertically integrated liquid. | ob.vil |
stormcells |
API - Base Flex - Base |
| The highest reflectivity found within the storm | Current/Forecast | The highest reflectivity found within the storm. | ob.dbzm |
stormcells |
API - Base Flex - Base |
| The height of the storm structure as received | Current/Forecast | The height of the storm structure as received. | ob.ht |
stormcells |
API - Base Flex - Base |
| height of the storm structure in feet | Current/Forecast | The height of the storm structure in feet | ob.htFT |
stormcells |
API - Base Flex - Base |
| height of the storm structure in meters | Current/Forecast | The height of the storm structure in meters | ob.htM |
stormcells |
API - Base Flex - Base |
| Top of the storm in thousands of feet | Current/Forecast | Top of the storm in thousands of feet. | ob.top |
stormcells |
API - Base Flex - Base |
| Top of the storm in feet | Current/Forecast | Top of the storm in feet. | ob.topFT |
stormcells |
API - Base Flex - Base |
| Top of the storm in meters | Current/Forecast | Top of the storm in meters | ob.topM |
stormcells |
API - Base Flex - Base |
| An object containing hail probability and size information | Current/Forecast | An object containing hail probability and size information. Will be NULL if hail information unavailable for the storm cell. | ob.hail |
stormcells |
API - Base Flex - Base |
| Probability that the storm contains severe hail | Current/Forecast | Probability that the storm contains severe hail. | ob.hail.probSevere |
stormcells |
API - Base Flex - Base |
| Probability that the storm contains hail of any size | Current/Forecast | Probability that the storm contains hail of any size. | ob.hail.prob |
stormcells |
API - Base Flex - Base |
| Maximum diameter of hail stones in hundredths of an inch | Current/Forecast | Maximum diameter of hail stones in hundredths of an inch. | ob.hail.maxSize |
stormcells |
API - Base Flex - Base |
| Maximum diameter of hail stones in inches | Current/Forecast | Maximum diameter of hail stones in inches. | ob.hail.maxSizeIN |
stormcells |
API - Base Flex - Base |
| Maximum diameter of hail stones in millimeters | Current/Forecast | Maximum diameter of hail stones in millimeters. | ob.hail.maxSizeMM |
stormcells |
API - Base Flex - Base |
| The distance and bearing to the closest city | Current/Forecast | The distance and bearing to the closest city. | ob.location |
stormcells |
API - Base Flex - Base |
| An object containing forecast information for the storm cell | Current/Forecast | An object containing forecast information for the storm cell. Will be NULL if forecast information is unavailable, such as with a newly detected storm cell. | forecast |
stormcells |
API - Base Flex - Base |
| Array of forecasted positions for the cell | Current/Forecast | Array of forecasted positions for the cell. | forecast.locs |
stormcells |
API - Base Flex - Base |
| Forecasted latitude position | Current/Forecast | Forecasted latitude position. | forecast.locs[#].lat |
stormcells |
API - Base Flex - Base |
| Forecasted longitude position | Current/Forecast | Forecasted longitude position. | forecast.locs[#].long |
stormcells |
API - Base Flex - Base |
| Forecasted bearing of the cell relative to the radar site in degrees | Current/Forecast | Forecasted bearing of the cell relative to the radar site in degrees. | forecast.locs[#].deg |
stormcells |
API - Base Flex - Base |
| Forecasted distance of the cell relative to the radar site in nautical miles | Current/Forecast | Forecasted distance of the cell relative to the radar site in nautical miles. | forecast.locs[#].NM |
stormcells |
API - Base Flex - Base |
| Timestamp of the forecasted time at the position | Current/Forecast | UNIX timestamp of the forecasted time at the position. | forecast.locs[#].timestamp |
stormcells |
API - Base Flex - Base |
| Date of forecasted time at the position | Current/Forecast | ISO 8601 date of forecasted time at the position. | forecast.locs[#].dateTimeISO |
stormcells |
API - Base Flex - Base |
| Error percentage of the forecast from 0 to 1 | Current/Forecast | Error percentage of the forecast from 0 to 1. | errFcst |
stormcells |
API - Base Flex - Base |
| Mean error from 0 to 1 | Current/Forecast | Mean error from 0 to 1. | errMean |
stormcells |
API - Base Flex - Base |
| An objecting containing the forecast error cone | Current/Forecast | An objecting containing the forecast error cone. Will be NULL if forecast information is unavailable, such as with a newly detected storm cell. | cone |
stormcells |
API - Base Flex - Base |
| Array of lat/long coordinates defining a 5-degree cone of error along the forecast path, which can be used to better determine locations along the path of the storm | Current/Forecast | Array of lat/long coordinates defining a 5-degree cone of error along the forecast path, which can be used to better determine locations along the path of the storm. | cone.narrow |
stormcells |
API - Base Flex - Base |
| Array of lat/long coordinates defining a 20-degree cone of error along the forecast path | Current/Forecast | Array of lat/long coordinates defining a 20-degree cone of error along the forecast path. | cone.wide |
stormcells |
API - Base Flex - Base |
| Object of storm cell traits | Current/Forecast | Object of storm cell traits | traits |
stormcells |
API - Base Flex - Base |
| Storm cell most significant trait / category | Current/Forecast | Storm cell most significant trait / category: - general - hail - rotating - tornado |
traits.type |
stormcells |
API - Base Flex - Base |
| StormCells | Current/Forecast | 1 = general storm, 0 = more threatening | traits.general |
stormcells |
API - Base Flex - Base |
| Hail | Current/Forecast | 1 = at least a 70% probability of hail, 0 = no significant hail threat | traits.hail |
stormcells |
API - Base Flex - Base |
| Rotation | Current/Forecast | 1 = significant rotation, 0 = no significant rotation | traits.rotating |
stormcells |
API - Base Flex - Base |
| Tornado | Current/Forecast | 1 = potential tornadic characteristics, 0 = no significant tornadic characteristics | traits.tornado |
stormcells |
API - Base Flex - Base |
| StormCells | Current/Forecast | 1 = potential threatening storm cell, 0 = no significant potential threat | traits.threat |
stormcells |
API - Base Flex - Base |
| The storm cell summary object | Current | The storm cell summary object. | summary |
stormcells/summary |
API - Base Flex - Base |
| Object containing the time range of storm cell observations and total used for the summary | Current | Object containing the time range of storm cell observations and total used for the summary | summary.range |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells used to generate the summary | Current | The total number of storm cells used to generate the summary | summary.range.count |
stormcells/summary |
API - Base Flex - Base |
| Timestamp of the from parameter | Current | The unix timestamp of the from parameter. | summary.range.fromTimestamp |
stormcells/summary |
API - Base Flex - Base |
| Date of the from parameter | Current | The ISO8601 date of the from parameter. | summary.range.fromDateTimeISO |
stormcells/summary |
API - Base Flex - Base |
| Timestamp of the to parameter | Current | The unix timestamp of the to parameter. | summary.range.toTimestamp |
stormcells/summary |
API - Base Flex - Base |
| Date of the to parameter | Current | The ISO8601 date of the to parameter. | summary.range.toDateTimeISO |
stormcells/summary |
API - Base Flex - Base |
| Timestamp for the latest storm cell observation used to generate the summary | Current | The unix timestamp for the latest storm cell observation used to generate the summary | summary.range.maxTimestamp |
stormcells/summary |
API - Base Flex - Base |
| Date of the latest storm cell observation used to generate the summary | Current | The ISO8601 date of the latest storm cell observation used to generate the summary | summary.range.maxDateTimeISO |
stormcells/summary |
API - Base Flex - Base |
| Timestamp for the earliest storm cell observation used to generate the summary | Current | The unix timestamp for the earliest storm cell observation used to generate the summary | summary.range.minTimestamp |
stormcells/summary |
API - Base Flex - Base |
| Date of the earliest storm cell observation used to generate the summary | Current | The ISO8601 date of the earliest storm cell observation used to generate the summary | summary.range.minDateTimeISO |
stormcells/summary |
API - Base Flex - Base |
| Object containing information on the storm cells with a TVS | Current | Object containing information on the storm cells with a TVS | summary.tvs |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells that had a TVS indicator | Current | The total number of storm cells that had a TVS indicator | summary.tvs.count |
stormcells/summary |
API - Base Flex - Base |
| Minimum TVS value. Should be zero (0) | Current | The minimum TVS value. Should be zero (0) | summary.tvs.min |
stormcells/summary |
API - Base Flex - Base |
| Maximum TVS value. Should be zero (0) or one (1) | Current | The maximum TVS value. Should be zero (0) or one (1) | summary.tvs.max |
stormcells/summary |
API - Base Flex - Base |
| Object containing information on the storm cells with MDA | Current | Object containing information on the storm cells with MDA | summary.mda |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells that had an MDA of greater than zero (0) | Current | The total number of storm cells that had an MDA of greater than zero (0) | summary.mda.count |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells that had a high MDA value, which could be potentially threatening | Current | The total number of storm cells that had a high MDA value, which could be potentially threatening | summary.mda.threatCount |
stormcells/summary |
API - Base Flex - Base |
| Minimum MDA value for a storm cell within the summary | Current | The minimum MDA value for a storm cell within the summary | summary.mda.min |
stormcells/summary |
API - Base Flex - Base |
| Maximum MDA value for a storm cell within the summary | Current | The maximum MDA value for a storm cell within the summary | summary.mda.max |
stormcells/summary |
API - Base Flex - Base |
| Object containing a summary of hail information | Current | Object containing a summary of hail information | summary.hail |
stormcells/summary |
API - Base Flex - Base |
| Object containing a summary of hail probability information | Current | Object containing a summary of hail probability information. | summary.hail.prob |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with a probability of hail > 0 | Current | Total number of storm cells with a probability of hail > 0 | summary.hail.prob.count |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with a high probability ( > 70%) of hail | Current | Total number of storm cells with a high probability ( > 70%) of hail | summary.hail.prob.threatCount |
stormcells/summary |
API - Base Flex - Base |
| The minimum hail probability for the storm cells used in the summary | Current | The minimum hail probability for the storm cells used in the summary | summary.hail.prob.min |
stormcells/summary |
API - Base Flex - Base |
| Maximum hail probability for the storm cells used in the summary | Current | The maximum hail probability for the storm cells used in the summary | summary.hail.prob.max |
stormcells/summary |
API - Base Flex - Base |
| Average hail probability for the storm cells used in the summary | Current | The average hail probability for the storm cells used in the summary | summary.hail.prob.avg |
stormcells/summary |
API - Base Flex - Base |
| Object containing a summary of severe hail probability information | Current | Object containing a summary of severe hail probability information. | summary.hail.probSevere |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with a probability of severe hail > 0 | Current | Total number of storm cells with a probability of severe hail > 0 | summary.hail.probSevere.count |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with a high probability ( > 70%) of severe hail | Current | Total number of storm cells with a high probability ( > 70%) of severe hail | summary.hail.probSevere.threatCount |
stormcells/summary |
API - Base Flex - Base |
| The minimum hail probability for the storm cells used in the summary | Current | The minimum hail probability for the storm cells used in the summary | summary.hail.probSevere.min |
stormcells/summary |
API - Base Flex - Base |
| Maximum hail probability for the storm cells used in the summary | Current | The maximum hail probability for the storm cells used in the summary | summary.hail.probSevere.max |
stormcells/summary |
API - Base Flex - Base |
| Average hail probability for the storm cells used in the summary | Current | The average hail probability for the storm cells used in the summary | summary.hail.probSevere.avg |
stormcells/summary |
API - Base Flex - Base |
| Object containing a summary of the estimated maximum hail size within the storm cells | Current | Object containing a summary of the estimated maximum hail size within the storm cells | summary.hail.maxSize |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with an estimated hail size greater than 0 | Current | Total number of storm cells with an estimated hail size greater than 0 | summary.hail.maxSize.count |
stormcells/summary |
API - Base Flex - Base |
| Minimum estimated max hail size in inches | Current | The minimum estimated max hail size in inches | summary.hail.maxSize.minIN |
stormcells/summary |
API - Base Flex - Base |
| Minimum estimated max hail size in centimeters | Current | The minimum estimated max hail size in centimeters | summary.hail.maxSize.minCM |
stormcells/summary |
API - Base Flex - Base |
| Maximum estimated max hail size in inches | Current | The maximum estimated max hail size in inches | summary.hail.maxSize.maxIN |
stormcells/summary |
API - Base Flex - Base |
| Maximum estimated max hail size in centimeters | Current | The maximum estimated max hail size in centimeters | summary.hail.maxSize.maxCM |
stormcells/summary |
API - Base Flex - Base |
| Average estimated max hail size in inches | Current | The average estimated max hail size in inches | summary.hail.maxSize.avgIN |
stormcells/summary |
API - Base Flex - Base |
| Average estimated max hail size in centimeters | Current | The average estimated max hail size in centimeters | summary.hail.maxSize.avgCM |
stormcells/summary |
API - Base Flex - Base |
| Object containing a summary of the dbzm | Current | Object containing a summary of the dbzm | summary.dbzm |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with an estimated dbzm > 0 | Current | Total number of storm cells with an estimated dbzm > 0 | summary.dbzm.count |
stormcells/summary |
API - Base Flex - Base |
| Minimum estimated dbzm | Current | The minimum estimated dbzm. | summary.dbzm.min |
stormcells/summary |
API - Base Flex - Base |
| Maximum estimated dbzm | Current | The maximum estimated dbzm. | summary.dbzm.max |
stormcells/summary |
API - Base Flex - Base |
| Average estimated dbzm | Current | The average estimated dbzm. | summary.dbzm.avg |
stormcells/summary |
API - Base Flex - Base |
| Object containing a summary of the estimated VIL (Vertically integrated liquid) | Current | Object containing a summary of the estimated VIL (Vertically integrated liquid) | summary.vil |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with a VIL greater than zero (0) | Current | Total number of storm cells with a VIL greater than zero (0) | summary.vil.count |
stormcells/summary |
API - Base Flex - Base |
| Minimum estimated VIL | Current | The minimum estimated VIL. | summary.vil.min |
stormcells/summary |
API - Base Flex - Base |
| Maximum estimated VIL | Current | The maximum estimated VIL. | summary.vil.max |
stormcells/summary |
API - Base Flex - Base |
| Average estimated VIL | Current | The average estimated VIL. | summary.vil.avg |
stormcells/summary |
API - Base Flex - Base |
| Object containing a summary of cloud top heights | Current | Object containing a summary of cloud top heights | summary.top |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with a cloud height greater than zero (0) | Current | Total number of storm cells with a cloud height greater than zero (0) | summary.top.count |
stormcells/summary |
API - Base Flex - Base |
| Minimum cloud top height in meters | Current | The minimum cloud top height in meters | summary.top.minM |
stormcells/summary |
API - Base Flex - Base |
| Minimum cloud top height in feet | Current | The minimum cloud top height in feet | summary.top.minFT |
stormcells/summary |
API - Base Flex - Base |
| Maximum cloud top height in meters | Current | The maximum cloud top height in meters | summary.top.maxM |
stormcells/summary |
API - Base Flex - Base |
| Maximum cloud top height in feet | Current | The maximum cloud top height in feet | summary.top.maxFT |
stormcells/summary |
API - Base Flex - Base |
| Average cloud top height in meters | Current | The average cloud top height in meters | summary.top.avgM |
stormcells/summary |
API - Base Flex - Base |
| Average cloud top height in feet | Current | The average cloud top height in feet | summary.top.avgFT |
stormcells/summary |
API - Base Flex - Base |
| Object containing summary of storm cells speeds | Current | Object containing summary of storm cells speeds. | summary.speed |
stormcells/summary |
API - Base Flex - Base |
| Total number of storm cells with a speed greater than zero (0) | Current | The total number of storm cells with a speed greater than zero (0) | summary.speed.count |
stormcells/summary |
API - Base Flex - Base |
| Minimum storm cell speed in knots | Current | The minimum storm cell speed in knots | summary.speed.minKTS |
stormcells/summary |
API - Base Flex - Base |
| minimum storm cell speed in kilometers per hour | Current | The minimum storm cell speed in kilometers per hour | summary.speed.minKPH |
stormcells/summary |
API - Base Flex - Base |
| Minimum storm cell speed in miles per hour | Current | The minimum storm cell speed in miles per hour | summary.speed.minMPH |
stormcells/summary |
API - Base Flex - Base |
| Maximum storm cell speed in knots | Current | The maximum storm cell speed in knots | summary.speed.maxKTS |
stormcells/summary |
API - Base Flex - Base |
| Maximum storm cell speed in kilometers per hour | Current | The maximum storm cell speed in kilometers per hour | summary.speed.maxKPH |
stormcells/summary |
API - Base Flex - Base |
| Maximum storm cell speed in miles per hour | Current | The maximum storm cell speed in miles per hour | summary.speed.maxMPH |
stormcells/summary |
API - Base Flex - Base |
| Average storm cell speed in knots | Current | The average storm cell speed in knots | summary.speed.avgKTS |
stormcells/summary |
API - Base Flex - Base |
| Average storm cell speed in kilometers per hour | Current | The average storm cell speed in kilometers per hour | summary.speed.avgKPH |
stormcells/summary |
API - Base Flex - Base |
| Average storm cell speed in miles per hour | Current | The average storm cell speed in miles per hour | summary.speed.avgMPH |
stormcells/summary |
API - Base Flex - Base |
| Array of two letter state abbreviations that storm cells included in the summary are located in | Current | Array of two letter state abbreviations that storm cells included in the summary are located in. | summary.states |
stormcells/summary |
API - Base Flex - Base |
| GeoJSON object, normally a Polygon or MultiPolygon of the groups of storm cells used within the summary | Current | GeoJSON object, normally a Polygon or MultiPolygon of the groups of storm cells used within the summary. Will be 'null' unless the geo filter is provided. |
geoPoly |
stormcells/summary |
API - Base Flex - Base |
| ID of the storm report | Current | Unique ID of the storm report. | id |
stormreports |
API - Base Flex - Base |
| Report code as assigned by the NWS | Current | The report code as assigned by the NWS. | report.code |
stormreports |
API - Base Flex - Base |
| Type of report | Current | The type of report. | report.type |
stormreports |
API - Base Flex - Base |
| Brief description of the report, usually contains the location or relative distance from a city | Current | The brief description of the report, usually contains the location or relative distance from a city. | report.name |
stormreports |
API - Base Flex - Base |
| Object containing specific information about the report, such as totals, measurements, etc | Current | An object containing specific information about the report, such as totals, measurements, etc. | report.detail |
stormreports |
API - Base Flex - Base |
| Category of the storm report | Current | The category of the storm report: - avalanche - blizzard - dust - fire - flood - fog - hail - ice - lightning - marine - rain - snow - tides - tornado - tropical - wind - other |
report.cat |
stormreports |
API - Base Flex - Base |
| Measurement provided in the report, such as precipitation total, wind speed or hail size | Current | The measurement provided in the report, such as precipitation total, wind speed or hail size. | report.detail.text |
stormreports |
API - Base Flex - Base |
| Total observed rainfall in inches | Current | The total observed rainfall in inches. Only included for rain/flood related events. | report.detail.rainIN |
stormreports |
API - Base Flex - Base |
| Total observed rainfall in millimeters | Current | The total observed rainfall in millimeters Only included for rain/flood related events. | report.detail.rainMM |
stormreports |
API - Base Flex - Base |
| Total observed snowfall in inches | Current | The total observed snowfall in inches. Only included for snow related events. | report.detail.snowIN |
stormreports |
API - Base Flex - Base |
| Total observed snowfall in centimeters | Current | The total observed snowfall in centimeters. Only included for snow related events. | report.detail.snowCM |
stormreports |
API - Base Flex - Base |
| Total observed sleet accumulation in inches | Current | The total observed sleet accumulation in inches. Only included for sleet/ice related events. | report.detail.sleetIN |
stormreports |
API - Base Flex - Base |
| Total observed sleet accumulation in centimeters | Current | The total observed sleet accumulation in centimeters. Only included for sleet/ice related events. | report.detail.sleetCM |
stormreports |
API - Base Flex - Base |
| Observed wind speed in knots | Current | The observed wind speed in knots. Only included for wind related events. | report.detail.windSpeedKTS |
stormreports |
API - Base Flex - Base |
| Observed wind speed in kilometers per hour | Current | The observed wind speed in kilometers per hour. Only included for wind related events. | report.detail.windSpeedKPH |
stormreports |
API - Base Flex - Base |
| Observed wind speed in miles per hour | Current | The observed wind speed in miles per hour. Only included for wind related events. | report.detail.windSpeedMPH |
stormreports |
API - Base Flex - Base |
| Total observed hail diameter in inches | Current | The total observed hail diameter in inches. Only included for hail related events. | report.detail.hailIN |
stormreports |
API - Base Flex - Base |
| Total observed hail diameter in millimeters | Current | The total observed hail diameter in millimeters. Only included for hail related events. | report.detail.hailMM |
stormreports |
API - Base Flex - Base |
| General organization who made the report | Current | The general organization who made the report. | report.reporter |
stormreports |
API - Base Flex - Base |
| Additional details and comments describing the event | Current | Additional details and comments describing the event. | report.comments |
stormreports |
API - Base Flex - Base |
| Timestamp when the event took place | Current | UNIX timestamp when the event took place. | report.timestamp |
stormreports |
API - Base Flex - Base |
| Date of the date/time of the event | Current | ISO 8601 date of the date/time of the event. | report.dateTimeISO |
stormreports |
API - Base Flex - Base |
| Deprecated : The weather forecast office reporting the event | Current | Deprecated : The weather forecast office reporting the event. Empty String if not available | report.wfo |
stormreports |
API - Base Flex - Base |
| Summary object | Current | Summary object | summary |
stormreports/summary |
API - Base Flex - Base |
| Object with count and date range of the summary | Current | Object with count and date range of the summary | summary.range |
stormreports/summary |
API - Base Flex - Base |
| The total number of storm reports within the summary | Current | The total number of storm reports within the summary | summary.range.count |
stormreports/summary |
API - Base Flex - Base |
| Timestamp of the from parameter | Current | The unix timestamp of the from parameter. | summary.range.fromTimestamp |
stormreports/summary |
API - Base Flex - Base |
| Date of the from parameter | Current | The ISO8601 date of the from parameter. | summary.range.fromDateTimeISO |
stormreports/summary |
API - Base Flex - Base |
| Timestamp of the to parameter | Current | The unix timestamp of the to parameter. | summary.range.toTimestamp |
stormreports/summary |
API - Base Flex - Base |
| Date of the from parameter | Current | The ISO8601 date of the from parameter. | summary.range.toDateTimeISO |
stormreports/summary |
API - Base Flex - Base |
| Timestamp of the date/time of the last storm report within the summary | Current | UNIX timestamp of the date/time of the last storm report within the summary. | summary.range.maxTimestamp |
stormreports/summary |
API - Base Flex - Base |
| Date/time of the last storm report within the summary | Current | ISO 8601 date/time of the last storm report within the summary | summary.range.maxDateTimeISO |
stormreports/summary |
API - Base Flex - Base |
| Timestamp of the date/time of the first storm report within the summary | Current | UNIX timestamp of the date/time of the first storm report within the summary. | summary.range.minTimestamp |
stormreports/summary |
API - Base Flex - Base |
| Date/time of the first storm report within the summary | Current | ISO 8601 date/time of the first storm report within the summary | summary.range.minDateTimeISO |
stormreports/summary |
API - Base Flex - Base |
| Array of two letter state abbreviations that had storm reports used within the summary | Current | Array of two letter state abbreviations that had storm reports used within the summary | summary.states |
stormreports/summary |
API - Base Flex - Base |
| Array of categories of the storm reports used within the summary | Current | Array of categories of the storm reports used within the summary. | summary.typeCats |
stormreports/summary |
API - Base Flex - Base |
| Array of objects providing a summary of each storm report type | Current | Array of objects providing a summary of each storm report type | summary.types |
stormreports/summary |
API - Base Flex - Base |
| The storm report type | Current | The storm report type | summary.types[#].type |
stormreports/summary |
API - Base Flex - Base |
| The storm report code | Current | The storm report code | summary.types[#].code |
stormreports/summary |
API - Base Flex - Base |
| Object with the count and date range of the summary for the specific storm report type | Current | Object with the count and date range of the summary for the specific storm report type | summary.types[#].range |
stormreports/summary |
API - Base Flex - Base |
| Total number of storm reports of this type | Current | The total number of storm reports of this type | summary.types[#].count |
stormreports/summary |
API - Base Flex - Base |
| Timestamp of the date/time of the last storm report of the type within the summary | Current | UNIX timestamp of the date/time of the last storm report of the type within the summary | summary.types[#].maxTimestamp |
stormreports/summary |
API - Base Flex - Base |
| Date of the date/time of the last storm report of the type within the summary | Current | ISO 8601 date of the date/time of the last storm report of the type within the summary | summary.types[#].maxDateTimeISO |
stormreports/summary |
API - Base Flex - Base |
| Timestamp of the date/time of the first storm report of the type within the summary | Current | UNIX timestamp of the date/time of the first storm report of the type within the summary | summary.types[#].minTimestamp |
stormreports/summary |
API - Base Flex - Base |
| Date of the date/time of the first storm report of the type within the summary | Current | ISO 8601 date of the date/time of the first storm report of the type within the summary | summary.types[#].minDateTimeISO |
stormreports/summary |
API - Base Flex - Base |
| Object of summary of storm report details | Current | Object of summary of storm report details | summary.types[#].detail |
stormreports/summary |
API - Base Flex - Base |
| Number of storm reports of the type that included detail information | Current | Number of storm reports of the type that included detail information | summary.types[#].detail.count |
stormreports/summary |
API - Base Flex - Base |
| Summary of the maximum wind speed in miles per hour | Current | Summary of the maximum wind speed in miles per hour. Included only for wind related storm report types. | summary.types[#].detail.maxMPH |
stormreports/summary |
API - Base Flex - Base |
| Summary of the maximum wind speed in kilometers per hour | Current | Summary of the maximum wind speed in kilometers per hour. Included only for wind related storm report types. | summary.types[#].detail.maxKPH |
stormreports/summary |
API - Base Flex - Base |
| Summary of the maximum wind speed in knots | Current | Summary of the maximum wind speed in knots. Included only for wind related storm report types. | summary.types[#].detail.maxKTS |
stormreports/summary |
API - Base Flex - Base |
| Summary of the minimum wind speed in miles per hour | Current | Summary of the minimum wind speed in miles per hour. Included only for wind related storm report types. | summary.types[#].detail.minMPH |
stormreports/summary |
API - Base Flex - Base |
| Summary of the minimum wind speed in kilometers per hour | Current | Summary of the minimum wind speed in kilometers per hour. Included only for wind related storm report types. | summary.types[#].detail.minKPH |
stormreports/summary |
API - Base Flex - Base |
| Summary of the minimum wind speed in knots | Current | Summary of the minimum wind speed in knots. Included only for wind related storm report types. | summary.types[#].detail.minKTS |
stormreports/summary |
API - Base Flex - Base |
| Summary of the average wind speed in miles per hour | Current | Summary of the average wind speed in miles per hour. Included only for wind related storm report types. | summary.types[#].detail.avgMPH |
stormreports/summary |
API - Base Flex - Base |
| Summary of the average wind speed in kilometers per hour | Current | Summary of the average wind speed in kilometers per hour. Included only for wind related storm report types. | summary.types[#].detail.avgKPH |
stormreports/summary |
API - Base Flex - Base |
| Summary of the average wind speed in knots | Current | Summary of the average wind speed in knots. Included only for wind related storm report types. | summary.types[#].detail.avgKTS |
stormreports/summary |
API - Base Flex - Base |
| Timestamp of the time used for calculating info | Current/Forecast | UNIX timestamp of the time used for calculating info. | timestamp |
sunmoon |
API - Base Flex - Base |
| Date of the time used for calculating info | Current/Forecast | ISO 8601 date of the time used for calculating info. | dateTimeISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the sunrise | Current/Forecast | UNIX timestamp of the sunrise. Null if no sunrise. | sun.rise |
sunmoon |
API - Base Flex - Base |
| Date of the sunrise | Current/Forecast | ISO 8601 date of the sunrise. Null if no sunrise. | sun.riseISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the sunset | Current/Forecast | UNIX timestamp of the sunset. Null if no sunset. | sun.set |
sunmoon |
API - Base Flex - Base |
| Date of the sunset | Current/Forecast | ISO 8601 date of the sunset. Null if no sunset. | sun.setISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the point the sun is "overhead" | Current/Forecast | UNIX timestamp of the point the sun is "overhead". Null if no transit. | sun.transit |
sunmoon |
API - Base Flex - Base |
| Date of the point the moon is "overhead" | Current/Forecast | ISO 8601 date of the point the moon is "overhead". Null if no transit. | sun.transitISO |
sunmoon |
API - Base Flex - Base |
| Set to true if midnight sun (sun not setting) | Current/Forecast | Set to true if midnight sun (sun not setting), false otherwise | sun.midnightSun |
sunmoon |
API - Base Flex - Base |
| Set to true if polar night (the sun is not rising) | Current/Forecast | Set to true if polar night (the sun is not rising), false otherwise | sun.polarNight |
sunmoon |
API - Base Flex - Base |
| Timestamp of the first civil twilight | Current/Forecast | UNIX timestamp of the first civil twilight. Null if no civil twilight. | sun.twilight.civilBegin |
sunmoon |
API - Base Flex - Base |
| Date of first civil twilight | Current/Forecast | ISO 8601 date of first civil twilight. Null if no civil twilight. | sun.twilight.civilBeginISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the second civil twilight | Current/Forecast | UNIX timestamp of the second civil twilight. Null if no civil twilight. | sun.twilight.civilEnd |
sunmoon |
API - Base Flex - Base |
| Date of second civil twilight | Current/Forecast | ISO 8601 date of second civil twilight. Null if no civil twilight. | sun.twilight.civilEndISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the first nautical twilight | Current/Forecast | UNIX timestamp of the first nautical twilight. Null if no nautical twilight. | sun.twilight.nauticalBegin |
sunmoon |
API - Base Flex - Base |
| Date of first nautical twilight | Current/Forecast | ISO 8601 date of first nautical twilight. Null if no nautical twilight. | sun.twilight.nauticalBeginISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the second nautical twilight | Current/Forecast | UNIX timestamp of the second nautical twilight. Null if no nautical twilight. | sun.twilight.nauticalEnd |
sunmoon |
API - Base Flex - Base |
| Date of second nautical twilight | Current/Forecast | ISO 8601 date of second nautical twilight. Null if no nautical twilight. | sun.twilight.nauticalEndISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the first astronomical twilight | Current/Forecast | UNIX timestamp of the first astronomical twilight. Null if no astronomical twilight. | sun.twilight.astronomicalBegin |
sunmoon |
API - Base Flex - Base |
| Date of first astronomical twilight | Current/Forecast | ISO 8601 date of first astronomical twilight. Null if no astronomical twilight. | sun.twilight.astronomicalBeginISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the second astronomical twilight | Current/Forecast | UNIX timestamp of the second astronomical twilight. Null if no astronomical twilight. | sun.twilight.astronomicalEnd |
sunmoon |
API - Base Flex - Base |
| Date of second astronomical twilight | Current/Forecast | ISO 8601 date of second astronomical twilight. Null if no astronomical twilight. | sun.twilight.astronomicalEndISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the moon rise | Current/Forecast | UNIX timestamp of the moon rise. Null if no moon rise, maybe occurring shortly after midnight the next morning. | moon.rise |
sunmoon |
API - Base Flex - Base |
| Date of the moon rise | Current/Forecast | ISO 8601 date of the moon rise. Null if no moon rise, possibly occurring shortly after midnight the next morning. | moon.riseISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the moon set | Current/Forecast | UNIX timestamp of the moon set. Null if no moon set, possibly occurring shortly after midnight the next morning. | moon.set |
sunmoon |
API - Base Flex - Base |
| Date of the moon set | Current/Forecast | ISO 8601 date of the moon set. Null if no moon set, possibly occurring shortly after midnight the next morning. | moon.setISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the point the moon is "overhead" | Current/Forecast | UNIX timestamp of the point the moon is "overhead". Null if no transit, possibly occurring shortly after midnight the next morning. | moon.transit |
sunmoon |
API - Base Flex - Base |
| Date of the point the moon is "overhead" | Current/Forecast | ISO 8601 date of the point the moon is "overhead". Null if no transit, possibly occurring shortly after midnight the next morning. | moon.transitISO |
sunmoon |
API - Base Flex - Base |
| Timestamp of the point the moon is "underfoot" | Current/Forecast | UNIX timestamp of the point the moon is "underfoot". Null if no underfoot, possibly occurring shortly after midnight the next morning. | moon.underfoot |
sunmoon |
API - Base Flex - Base |
| Date of the point the moon is "underfoot" | Current/Forecast | ISO 8601 date of the point the moon is "underfoot". Null if no underfoot, possibly occurring shortly after midnight the next morning. | moon.underfootISO |
sunmoon |
API - Base Flex - Base |
| Moon phase percentage | Current/Forecast | The moon phase percentage. | moon.phase.phase |
sunmoon |
API - Base Flex - Base |
| Moon phase name | Current/Forecast | The moon phase name. | moon.phase.name |
sunmoon |
API - Base Flex - Base |
| Percentage of the moon that is illuminated | Current/Forecast | The percentage of the moon that is illuminated. | moon.phase.illum |
sunmoon |
API - Base Flex - Base |
| Age of the moon phase in days | Current/Forecast | The age of the moon phase in days. | moon.phase.age |
sunmoon |
API - Base Flex - Base |
| moon phase angle | Current/Forecast | The moon phase angle. | moon.phase.angle |
sunmoon |
API - Base Flex - Base |
| Timestamp of the exact time of the moon phase | Current | UNIX timestamp of the exact time of the moon phase. | timestamp |
sunmoon/moonphases |
API - Base Flex - Base |
| Date of the exact time of the moon phase | Current | ISO 8601 date of the exact time of the moon phase. | dateTimeISO |
sunmoon/moonphases |
API - Base Flex - Base |
| Numeric representation of the moon phase | Current | Numeric representation of the moon phase: - 0 = new moon - 1 = first quarter moon - 2 = full moon - 3 = third quarter moon |
code |
sunmoon/moonphases |
API - Base Flex - Base |
| Moon phase full name | Current | The moon phase full name. Possibly phrases include: - new moon - first quarter - full moon - third quarter |
name |
sunmoon/moonphases |
API - Base Flex - Base |
| Timestamp of the time of the threats | Current | Unix timestamp of the time of the threats | periods[#].timestamp |
threats |
API - Base Flex - Base |
| Valid date and time of the threats | Current | ISO 8601 valid date and time of the threats | periods[#].dateTimeISO |
threats |
API - Base Flex - Base |
| The storms threat object | Current | The storms threat object. Null if no storm threats | periods[#].storms |
threats |
API - Base Flex - Base |
| Object of phrases for the storm threats | Current | Object of phrases for the storm threats | periods[#].storms.phrase |
threats |
API - Base Flex - Base |
| A shortened phrase of storm threats | Current | A shortened phrase of storm threats. Perfect for mobile phones where space is a limitation. | periods[#].storms.phrase.short |
threats |
API - Base Flex - Base |
| Longer phrase of storm threats | Current | Longer phrase of storm threats. Perfect for medium size displays | periods[#].storms.phrase.long |
threats |
API - Base Flex - Base |
| Complete phrase of all storm threats | Current | Complete phrase of all storm threats, no direction abbreviations etc. | periods[#].storms.phrase.full |
threats |
API - Base Flex - Base |
| Object of distance information of the threats from the specified location | Current | Object of distance information of the threats from the specified location. | periods[#].storms.distance |
threats |
API - Base Flex - Base |
| Minimum distance, in kilometers, of the group of storm threats from the specified location | Current | The minimum distance, in kilometers, of the group of storm threats from the specified location | periods[#].storms.distance.minKM |
threats |
API - Base Flex - Base |
| Minimum distance, in miles, of the group of storm threats from the specified location | Current | The minimum distance, in miles, of the group of storm threats from the specified location | periods[#].storms.distance.minMI |
threats |
API - Base Flex - Base |
| Maximum distance, in kilometers, of the group of storm threats from the specified location | Current | The maximum distance, in kilometers, of the group of storm threats from the specified location | periods[#].storms.distance.maxKM |
threats |
API - Base Flex - Base |
| Maximum distance, in miles, of the group of storm threats from the specified location | Current | The maximum distance, in miles, of the group of storm threats from the specified location | periods[#].storms.distance.maxMI |
threats |
API - Base Flex - Base |
| Average distance, in kilometers, of the group of storm threats from the specified location | Current | The average distance, in kilometers, of the group of storm threats from the specified location | periods[#].storms.distance.avgKM |
threats |
API - Base Flex - Base |
| Average distance, in miles, of the group of storm threats from the specified location | Current | The average distance, in miles, of the group of storm threats from the specified location | periods[#].storms.distance.avgMI |
threats |
API - Base Flex - Base |
| Object of the direction information of the threats | Current | Object of the direction information of the threats | periods[#].storms.direction |
threats |
API - Base Flex - Base |
| The abbreviated direction from the specified location to the storm threats | Current | The abbreviated direction from the specified location to the storm threats | periods[#].storms.direction.to |
threats |
API - Base Flex - Base |
| Decimal direction from the specified location To the storm threats | Current | The decimal direction from the specified location To the storm threats. Value from 0 - 360, with 0/360 = North | periods[#].storms.direction.toDEG |
threats |
API - Base Flex - Base |
| Abbreviated direction the threats approaching from | Current | The abbreviated direction the threats approaching from. | periods[#].storms.direction.from |
threats |
API - Base Flex - Base |
| The abbreviated direction the threats approaching from | Current | The abbreviated direction the threats approaching from. Value from 0 - 360, with 0/360 = North | periods[#].storms.direction.fromDEG |
threats |
API - Base Flex - Base |
| True if the storms are approaching, False is passing through | Current | True if the storms are approaching, False is passing through. | periods[#].storms.approaching |
threats |
API - Base Flex - Base |
| An arc span angle of the storm threats affecting a location | Current | An arc span angle of the storm threats affecting a location. If a storm threat is approaching from the WSW at 256 degrees. If Span = 75, then an arc can be drawn that is 75 degrees and is centered on the 256 degree direction (WSW) to show the area the storms are approaching from. | periods[#].storms.span |
threats |
API - Base Flex - Base |
| Object of the speed information of the storm threats | Current | Object of the speed information of the storm threats | periods[#].storms.speed |
threats |
API - Base Flex - Base |
| Minimum speed of the group of storms threats in knots | Current | The minimum speed of the group of storms threats in knots | periods[#].storms.speed.minKTS |
threats |
API - Base Flex - Base |
| Minimum speed of the group of storms threats in kilometers per hour | Current | The minimum speed of the group of storms threats in kilometers per hour | periods[#].storms.speed.minKPH |
threats |
API - Base Flex - Base |
| Minimum speed of the group of storms threats in miles per hour | Current | The minimum speed of the group of storms threats in miles per hour | periods[#].storms.speed.minMPH |
threats |
API - Base Flex - Base |
| Maximum speed of the group of storms threats in knots | Current | The maximum speed of the group of storms threats in knots | periods[#].storms.speed.maxKTS |
threats |
API - Base Flex - Base |
| Maximum speed of the group of storms threats in kilometers per hour | Current | The maximum speed of the group of storms threats in kilometers per hour | periods[#].storms.speed.maxKPH |
threats |
API - Base Flex - Base |
| Maximum speed of the group of storms threats in miles per hour | Current | The maximum speed of the group of storms threats in miles per hour | periods[#].storms.speed.maxMPH |
threats |
API - Base Flex - Base |
| Average speed of the group of storms threats in knots | Current | The average speed of the group of storms threats in knots | periods[#].storms.speed.avgKTS |
threats |
API - Base Flex - Base |
| Average speed of the group of storms threats in kilometers per hour | Current | The average speed of the group of storms threats in kilometers per hour | periods[#].storms.speed.avgKPH |
threats |
API - Base Flex - Base |
| Average speed of the group of storms threats in miles per hour | Current | The average speed of the group of storms threats in miles per hour | periods[#].storms.speed.avgMPH |
threats |
API - Base Flex - Base |
| Object of hail information for the approaching storm threats | Current | Object of hail information for the approaching storm threats. Null if no hail within the storm threats. | periods[#].storms.hail |
threats |
API - Base Flex - Base |
| Probability (0-100) that the storm threats include hail | Current | The probability (0-100) that the storm threats include hail | periods[#].storms.hail.prob |
threats |
API - Base Flex - Base |
| Probability (0-100) that the storm threats include severe / very large hail | Current | The probability (0-100) that the storm threats include severe / very large hail | periods[#].storms.hail.probSevere |
threats |
API - Base Flex - Base |
| Maximum estimated hail size within the storm threats | Current | The maximum estimated hail size within the storm threats | periods[#].storms.hail.maxSize |
threats |
API - Base Flex - Base |
| Maximum estimated hail size within the storm threats in millimeters | Current | The maximum estimated hail size within the storm threats in millimeters | periods[#].storms.hail.maxSizeMM |
threats |
API - Base Flex - Base |
| Maximum estimated hail size within the storm threats in inches | Current | The maximum estimated hail size within the storm threats in inches | periods[#].storms.hail.maxSizeIN |
threats |
API - Base Flex - Base |
| True if the approaching storm threats may be tornadic, false otherwise | Current | True if the approaching storm threats may be tornadic, false otherwise. | periods[#].storms.tornadic |
threats |
API - Base Flex - Base |
| True if the approaching storm threats include a decent amount of mesoscale rotation, false otherwise | Current | True if the approaching storm threats include a decent amount of mesoscale rotation, false otherwise. | periods[#].storms.rotation |
threats |
API - Base Flex - Base |
| An array of active severe storm related NOAA advisory VTEC codes | Current | An array of active severe storm related NOAA advisory VTEC codes. If the location is under a severe thunderstorm warnings the value of ['SV.W']. If under both a Severe thunderstorm warning and Tornado warning the value may be ['TO.W', 'SV.W']. Refer to the advisories endpoint for more information on the advisory VTEC codes. Null if no severe related storm advisories. |
periods[#].storms.advisories |
threats |
API - Base Flex - Base |
| Object of mesoscale rotation information for the storm threats | Current | Object of mesoscale rotation information for the storm threats. Null if no appreciable MDA for the approaching storms. | periods[#].storms.mda |
threats |
API - Base Flex - Base |
| Minimum value | Current | The minimum value | periods[#].storms.mda.min |
threats |
API - Base Flex - Base |
| Maximum value | Current | The maximum value | periods[#].storms.mda.max |
threats |
API - Base Flex - Base |
| Object of radar intensity of the approaching storms | Current | Object of radar intensity of the approaching storms. Often used for determining the intensity of the precipitation. Null if no dbz data available for the storm threats. |
periods[#].storms.dbz |
threats |
API - Base Flex - Base |
| Minimum reported dbz within the storm threats | Current | The minimum reported dbz within the storm threats | periods[#].storms.dbz.min |
threats |
API - Base Flex - Base |
| Maximum reported dbz within the storm threats | Current | The maximum reported dbz within the storm threats | periods[#].storms.dbz.max |
threats |
API - Base Flex - Base |
| Average reported dbz within the storm threats | Current | The average reported dbz within the storm threats | periods[#].storms.dbz.avg |
threats |
API - Base Flex - Base |
| Station ID that the tides are based on | Forecast | The station ID that the tides are based on. | id |
tides |
API - Base Flex - Base |
| Timestamp for the tidal information | Forecast | UNIX timestamp for the tidal information. | periods[#].timestamp |
tides |
API - Base Flex - Base |
| Date of the date/time of the event | Forecast | ISO 8601 date of the date/time of the event. | periods[#].dateTimeISO |
tides |
API - Base Flex - Base |
| Tide type | Forecast | The tide type: - h = high - l (lower case L) = low |
periods[#].type |
tides |
API - Base Flex - Base |
| Tide height in feet | Forecast | The tide height in feet. | periods[#].heightFT |
tides |
API - Base Flex - Base |
| Tide height in meters | Forecast | The tide height in meters. | periods[#].heightM |
tides |
API - Base Flex - Base |
| Station type | Current | The station type, "harmonic" or "subordinate". | profile.type |
tides/stations |
API - Base Flex - Base |
| Numeric representation of the station type | Current | The numeric representation of the station type: - 1 = harmonic - 2 = subordinate |
profile.typeCode |
tides/stations |
API - Base Flex - Base |
| The tropical system ID | Current | The tropical system ID. The storm ID will be similar too: 2017-AL-16 : YEAR-BASIN-EVENTNUMBER |
id |
tropicalcyclones |
API - Base Flex - Base |
| Current | profile |
tropicalcyclones |
API - Base Flex - Base |
||
| Storm name without the leading storm type | Current | The storm name without the leading storm type. For example, a value of Nate for Hurricane Nate. The name is in mixed case. If the storm has not been named yet, this may be a number, i.e. Tropical Depression 4 would have a name of Four. |
profile.name |
tropicalcyclones |
API - Base Flex - Base |
| Tropical season year that the storm initialized within | Current | The tropical season year that the storm initialized within. | profile.year |
tropicalcyclones |
API - Base Flex - Base |
| Basin abbreviation that the storm is originated within | Current | The basin abbreviation that the storm is originated within. AL = Atlantic EP = Eastern Pacific CP = Central Pacific WP = Western Pacific IO = Indian Ocean SH = Southern Hemisphere |
profile.basinOrigin |
tropicalcyclones |
API - Base Flex - Base |
| Basin the storm is currently within | Current | The basin abbreviation that the storm is currently within. Null if the storm is no longer active. | profile.basinCurrent |
tropicalcyclones |
API - Base Flex - Base |
| Basin abbreviations that the storm has been within | Current | An array of the basin abbreviations that the storm has been within. Some Pacific storms may cross multiple Pacific basins. | profile.basins |
tropicalcyclones |
API - Base Flex - Base |
| Number of the storm within the basin | Current | The event number of the storm within the basin. | profile.event |
tropicalcyclones |
API - Base Flex - Base |
| Active Storm | Current | True if the storm is active, false otherwise. | profile.isActive |
tropicalcyclones |
API - Base Flex - Base |
| Lifespan of the storm | Current | Object containing the lifespan of the storm. | profile.lifespan |
tropicalcyclones |
API - Base Flex - Base |
| When first advisory was issued for the storm | Current | Unix timestamp of when the first advisory was issued for the storm by the NHC or JTWC. | profile.lifespan.startTimestamp |
tropicalcyclones |
API - Base Flex - Base |
| Date of when the first advisory was issued for the storm | Current | ISO 8601 date of when the first advisory was issued for the storm by the NHC or JTWC. | profile.lifespan.startDateTimeISO |
tropicalcyclones |
API - Base Flex - Base |
| When last advisory was issued for the storm | Current | Unix timestamp of when the last advisory was issued for the storm by the NHC or JTWC. If a system is still active, this value will be null. | profile.lifespan.endTimestamp |
tropicalcyclones |
API - Base Flex - Base |
| Date of when the last advisory was issued for the storm by the NHC or JTWC | Current | ISO 8601 date of when the last advisory was issued for the storm by the NHC or JTWC. If a system is still active, this value will be null. | profile.lifespan.endDateTimeISO |
tropicalcyclones |
API - Base Flex - Base |
| Maximum type of storm (based on wind speed) | Current | The maximum type of storm (based on wind speed), abbreviated TD = Tropical Depression TS = Tropical Storm H = Hurricane TY = Typhoon |
profile.maxStormType |
tropicalcyclones |
API - Base Flex - Base |
| Maximum strength category the storm achieved | Current | The maximum strength category the storm achieved, based on wind speed. TD = Tropical Depression TS = Tropical Storm H1 = Category 1 Hurricane H2 = Category 2 Hurricane H3 = Category 3 Hurricane H4 = Category 4 Hurricane H5 = Category 5 Hurricane TY = Typhoon STY = Super Typhoon |
profile.maxStormCat |
tropicalcyclones |
API - Base Flex - Base |
| Maximum wind speed information | Current | Object containing the maximum wind speed information | profile.windSpeed |
tropicalcyclones |
API - Base Flex - Base |
| Maximum reported wind speed of the storm in knots | Current | Maximum reported wind speed of the storm during its lifetime in knots. | profile.windSpeed.maxKTS |
tropicalcyclones |
API - Base Flex - Base |
| Maximum reported wind speed of the storm in kilometers per hour | Current | Maximum reported wind speed of the storm during its lifetime in kilometers per hour. | profile.windSpeed.maxKPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum reported wind speed of the storm in miles per hour | Current | Maximum reported wind speed of the storm during its lifetime in miles per hour. | profile.windSpeed.maxMPH |
tropicalcyclones |
API - Base Flex - Base |
| Timestamp of the date/time of the reported maximum wind speed | Current | Unix timestamp of the date/time of the reported maximum wind speed | profile.windSpeed.maxTimestamp |
tropicalcyclones |
API - Base Flex - Base |
| Date of the date/time of the reported maximum wind speed | Current | ISO 8601 date of the date/time of the reported maximum wind speed | profile.windSpeed.maxDateTimeISO |
tropicalcyclones |
API - Base Flex - Base |
| Object containing the minimum pressure information | Current | Object containing the minimum pressure information. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
profile.pressure |
tropicalcyclones |
API - Base Flex - Base |
| Minimum reported pressure of the storm during its lifetime | Current | The minimum reported pressure of the storm during its lifetime, in millibars. Null if pressure information is not available. | profile.pressure.minMB |
tropicalcyclones |
API - Base Flex - Base |
| Minimum reported pressure of the storm during its lifetime | Current | The minimum reported pressure of the storm during its lifetime, in inches of mercury. Null if pressure information is not available. | profile.pressure.minIN |
tropicalcyclones |
API - Base Flex - Base |
| Timestamp of the date/time of the reported minimum pressure | Current | Unix timestamp of the date/time of the reported minimum pressure. Null if pressure information is not available. | profile.pressure.minTimestamp |
tropicalcyclones |
API - Base Flex - Base |
| Date of the date/time of the reported minimum pressure | Current | ISO 8601 date of the date/time of the reported minimum pressure. Null if pressure information is not available. | profile.pressureminDateTimeISO |
tropicalcyclones |
API - Base Flex - Base |
| All the system components, including the track, forecast, error cone, and breakpoint alerts | Current | Array containing a bounding box of all the system components, including the track, forecast, error cone, and breakpoint alerts. The bounding box array follows the following order: [South Latitude, West Longitude, North Latitude, East Longitude] NOTE: for systems that cross the 180th meridian, it is possible for the west longitude to have a greater value than the east longitude. |
profile.boundingBox |
tropicalcyclones |
API - Base Flex - Base |
| Timezone name for the cyclone | Current | The timezone name for the cyclone. If the storm is active, it will be the timezone of its current position, otherwise the timezone of the cyclones first location. | profile.tz |
tropicalcyclones |
API - Base Flex - Base |
| Object containing the latest storm position information | Current | Object containing the latest storm position information. NULL for inactive storms. | position |
tropicalcyclones |
API - Base Flex - Base |
| Timestamp of the date/time of the advisory for this data set, as issued by the NHC or JTWC | Current | Unix timestamp of the date/time of the advisory for this data set, as issued by the NHC or JTWC. | position.timestamp |
tropicalcyclones |
API - Base Flex - Base |
| Date of the date/time of the advisory for this data set, as issued by the NHC or JTWC | Current | ISO 8601 date of the date/time of the advisory for this data set, as issued by the NHC or JTWC. | position.dateTimeISO |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON point object of the location of the tropical system | Current | The GeoJSON point object of the location of the tropical system. | position.location |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON object type | Current | The GeoJSON object type. Should always be set to Point | position.location.type |
tropicalcyclones |
API - Base Flex - Base |
| Array of the position, containing the longitude and latitude | Current | Array of the position, containing the longitude and latitude. | position.location.coordinates |
tropicalcyclones |
API - Base Flex - Base |
| API location format of the latest reported position of the cyclone | Current | Object containing the classic API location format of the latest reported position of the cyclone. | position.loc |
tropicalcyclones |
API - Base Flex - Base |
| Longitude of the latest reported position of the cyclone | Current | The longitude of the latest reported position of the cyclone. | position.loc.long |
tropicalcyclones |
API - Base Flex - Base |
| Latitude of the latest reported position of the cyclone | Current | The latitude of the latest reported position of the cyclone. | position.loc.lat |
tropicalcyclones |
API - Base Flex - Base |
| Tropical system details | Current | Object containing the tropical system details. | position.details |
tropicalcyclones |
API - Base Flex - Base |
| Storm type | Current | The current storm type. Uses the same codes as profile.maxStormType | position.details.stormType |
tropicalcyclones |
API - Base Flex - Base |
| Current storm strength category, based on wind speed | Current | The current storm strength category, based on wind speed. Uses the same codes as profile.maxStormCat | position.details.stormCat |
tropicalcyclones |
API - Base Flex - Base |
| Full name of the storm at the time of the advisory, based on wind speed | Current | The full name of the storm at the time of the advisory, based on wind speed. Example: Tropical Storm Lee | position.details.stormName |
tropicalcyclones |
API - Base Flex - Base |
| Storm name without the leading storm type | Current | The storm name without the leading storm type. For example, a value of Nate for Hurricane Nate. The name is in mixed case. If the storm has not been named yet, this may be a number, i.e. Tropical Depression 4 would have a name of Four. |
position.details.stormShortName |
tropicalcyclones |
API - Base Flex - Base |
| Latest advisory number that the position information is based on | Current | The latest advisory number that the position information is based on. NOTE: This value is a string, as the NHC will issue intermediate advisories for storms close to landfall. These intermediate advisories may include letters, such as an Advisory Number of 4A |
position.details.advisoryNumber |
tropicalcyclones |
API - Base Flex - Base |
| Two letter abbreviation for where the storm is located within | Current | The two letter abbreviation of the basin the storm is located within. | position.details.basin |
tropicalcyclones |
API - Base Flex - Base |
| Storm movement information | Current | Object containing the movement information. NULL if movement information is not available. | position.details.movement |
tropicalcyclones |
API - Base Flex - Base |
| Direction the storm is moving in cardinal coordinates | Current | The direction the storm is moving in cardinal coordinates. | position.details.movement.direction |
tropicalcyclones |
API - Base Flex - Base |
| Direction the storm is moving in degrees | Current | The direction the storm is moving in degrees, 0 to 360, with 0 being North. | position.details.movement.directionDEG |
tropicalcyclones |
API - Base Flex - Base |
| Speed of the storm in knots | Current | The speed of the storm in knots. | position.details.movement.speedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Speed of the storm in kilometers per hour | Current | The speed of the storm in kilometers per hour. | position.details.movement.speedKPH |
tropicalcyclones |
API - Base Flex - Base |
| Speed of the storm in miles per hour | Current | The speed of the storm in miles per hour. | position.details.movement.speedMPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum sustained wind speed reported in the advisory in knots | Current | The maximum sustained wind speed reported in the advisory in knots | position.details.windSpeedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Maximum sustained wind speed reported in the advisory in kilometers per second | Current | The maximum sustained wind speed reported in the advisory in kilometers per second | position.details.windSpeedKPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum sustained wind speed reported in the advisory in miles per hour | Current | The maximum sustained wind speed reported in the advisory in miles per hour | position.details.windSpeedMPH |
tropicalcyclones |
API - Base Flex - Base |
| maximum wind gust speed as reported in the advisory in knots | Current | The maximum wind gust speed as reported in the advisory in knots. NULL is not available. | position.details.gustSpeedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Maximum wind gust speed as reported in the advisory in kilometers per hour | Current | The maximum wind gust speed as reported in the advisory in kilometers per hour. NULL is not available. | position.details.gustSpeedKPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum wind gust speed as reported in the advisory in miles per hour | Current | The maximum wind gust speed as reported in the advisory in miles per hour. NULL is not available. | position.details.gustSpeedMPH |
tropicalcyclones |
API - Base Flex - Base |
| Minimum pressure reported in the advisory in millibars | Current | The minimum pressure reported in the advisory in millibars. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
position.details.pressureMB |
tropicalcyclones |
API - Base Flex - Base |
| Minimum pressure reported in the advisory in inches of mercury | Current | The minimum pressure reported in the advisory in inches of mercury. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
position.details.pressureIN |
tropicalcyclones |
API - Base Flex - Base |
| Array of wind radii information for the cyclones current position | Current | Array of wind radii information for the cyclones current position. Null if no wind radii information. | position.details.windRadii |
tropicalcyclones |
API - Base Flex - Base |
| Wind speed in knots the wind radii information is for | Current | The wind speed in knots the wind radii information is for. Normally, 34, 50 or 64 knots | position.details.windRadii.#.windSpeedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Wind speed in kilometers per hour the wind radii information is for | Current | The wind speed in kilometers per hour the wind radii information is for. | position.details.windRadii.#.windSpeedKPH |
tropicalcyclones |
API - Base Flex - Base |
| Wind speed in miles per hour that the wind radii information is for | Current | The wind speed in miles per hour that the wind radii information is for. | position.details.windRadii.#.windSpeedMPH |
tropicalcyclones |
API - Base Flex - Base |
| Wind radii information | Current | Object of wind radii information. Separate objects for the 34, 50 and 64 knot wind radii information, as needed for the specific storm. | position.details.windRadii.#.quadrants |
tropicalcyclones |
API - Base Flex - Base |
| Wind radii for the northeast quadrant | Current | Object of the wind radii for the northeast quadrant. | position.details.windRadii.#.quadrants.ne |
tropicalcyclones |
API - Base Flex - Base |
| Distance in kilometers the winds extend from the storm center to the north east quadrant | Current | The distance in kilometers the winds extend from the storm center to the north east quadrant. | position.details.windRadii.#.quadrants.ne.distanceKM |
tropicalcyclones |
API - Base Flex - Base |
| Distance in statute miles the winds extend from the storm center to the north east quadrant | Current | The distance in statute miles the winds extend from the storm center to the north east quadrant. | position.details.windRadii.#.quadrants.ne.distanceMI |
tropicalcyclones |
API - Base Flex - Base |
| Distance in nautical miles the winds extend from the storm center to the north east quadrant | Current | The distance in nautical miles the winds extend from the storm center to the north east quadrant. | position.details.windRadii.#.quadrants.ne.distanceNM |
tropicalcyclones |
API - Base Flex - Base |
| Position object for the north east extent of the wind fields | Current | Position object for the north east extent of the wind fields. | position.details.windRadii.#.quadrants.ne.loc |
tropicalcyclones |
API - Base Flex - Base |
| Longitude of the position of the north east extent of the wind fields | Current | The longitude of the position of the north east extent of the wind fields. | position.details.windRadii.#.quadrants.ne.loc.long |
tropicalcyclones |
API - Base Flex - Base |
| Latitude of the position of the north east extent of the wind fields | Current | The latitude of the position of the north east extent of the wind fields. | position.details.windRadii.#.quadrants.ne.loc.lat |
tropicalcyclones |
API - Base Flex - Base |
| Object of the wind radii for the southeast quadrant | Current | Object of the wind radii for the southeast quadrant. | position.details.windRadii.#.quadrants.se |
tropicalcyclones |
API - Base Flex - Base |
| Distance in kilometers the winds extend from the storm center to the southeast quadrant | Current | The distance in kilometers the winds extend from the storm center to the southeast quadrant. | position.details.windRadii.#.quadrants.se.distanceKM |
tropicalcyclones |
API - Base Flex - Base |
| Distance in statute miles the winds extend from the storm center to the southeast quadrant | Current | The distance in statute miles the winds extend from the storm center to the southeast quadrant. | position.details.windRadii.#.quadrants.se.distanceMI |
tropicalcyclones |
API - Base Flex - Base |
| Distance in nautical miles the winds extend from the storm center to the southeast quadrant | Current | The distance in nautical miles the winds extend from the storm center to the southeast quadrant. | position.details.windRadii.#.quadrants.se.distanceNM |
tropicalcyclones |
API - Base Flex - Base |
| Position object for the southeast extent of the wind fields | Current | Position object for the southeast extent of the wind fields. | position.details.windRadii.#.quadrants.se.loc |
tropicalcyclones |
API - Base Flex - Base |
| Longitude of the position of the southeast extent of the wind fields | Current | The longitude of the position of the southeast extent of the wind fields | position.details.windRadii.#.quadrants.se.loc.long |
tropicalcyclones |
API - Base Flex - Base |
| Latitude of the position of the southeast extent of the wind fields | Current | The latitude of the position of the southeast extent of the wind fields | position.details.windRadii.#.quadrants.se.loc.lat |
tropicalcyclones |
API - Base Flex - Base |
| Object of the wind radii for the southwest quadrant | Current | Object of the wind radii for the southwest quadrant | position.details.windRadii.#.quadrants.sw |
tropicalcyclones |
API - Base Flex - Base |
| Distance in kilometers the winds extend from the storm center to the southwest quadrant | Current | The distance in kilometers the winds extend from the storm center to the southwest quadrant. | position.details.windRadii.#.quadrants.sw.distanceKM |
tropicalcyclones |
API - Base Flex - Base |
| Distance in statute miles the winds extend from the storm center to the southwest quadrant | Current | The distance in statute miles the winds extend from the storm center to the southwest quadrant. | position.details.windRadii.#.quadrants.sw.distanceMI |
tropicalcyclones |
API - Base Flex - Base |
| Distance in nautical miles the winds extend from the storm center to the southwest quadrant | Current | The distance in nautical miles the winds extend from the storm center to the southwest quadrant. | position.details.windRadii.#.quadrants.sw.distanceNM |
tropicalcyclones |
API - Base Flex - Base |
| Position object for the southwest extent of the wind fields | Current | Position object for the southwest extent of the wind fields. | position.details.windRadii.#.quadrants.sw.loc |
tropicalcyclones |
API - Base Flex - Base |
| Longitude of the position of the southwest extent of the wind fields | Current | The longitude of the position of the southwest extent of the wind fields | position.details.windRadii.#.quadrants.sw.loc.long |
tropicalcyclones |
API - Base Flex - Base |
| Latitude of the position of the southwest extent of the wind fields | Current | The latitude of the position of the southwest extent of the wind fields | position.details.windRadii.#.quadrants.sw.loc.lat |
tropicalcyclones |
API - Base Flex - Base |
| Object of the wind radii for the northwest quadrant | Current | Object of the wind radii for the northwest quadrant | position.details.windRadii.#.quadrants.nw |
tropicalcyclones |
API - Base Flex - Base |
| Distance in kilometers the winds extend from the storm center to the northwest quadrant | Current | The distance in kilometers the winds extend from the storm center to the northwest quadrant. | position.details.windRadii.#.quadrants.nw.distanceKM |
tropicalcyclones |
API - Base Flex - Base |
| Distance in statute miles the winds extend from the storm center to the northwest quadrant | Current | The distance in statute miles the winds extend from the storm center to the northwest quadrant. | position.details.windRadii.#.quadrants.nw.distanceMI |
tropicalcyclones |
API - Base Flex - Base |
| Distance in nautical miles the winds extend from the storm center to the northwest quadrant | Current | The distance in nautical miles the winds extend from the storm center to the northwest quadrant. | position.details.windRadii.#.quadrants.nw.distanceNM |
tropicalcyclones |
API - Base Flex - Base |
| Position object for the northwest extent of the wind fields | Current | Position object for the northwest extent of the wind fields. | position.details.windRadii.#.quadrants.nw.loc |
tropicalcyclones |
API - Base Flex - Base |
| Longitude of the position of the northwest extent of the wind fields | Current | The longitude of the position of the northwest extent of the wind fields | position.details.windRadii.#.quadrants.nw.loc.long |
tropicalcyclones |
API - Base Flex - Base |
| Latitude of the position of the northwest extent of the wind fields | Current | The latitude of the position of the northwest extent of the wind fields | position.details.windRadii.#.quadrants.nw.loc.lat |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON polygon of the forecast wind fields | Current | GeoJSON polygon of the forecast wind fields. Null if not available or if filter=windfields not passed. | psoition.details.windRadii.#.windField |
tropicalcyclones |
API - Base Flex - Base |
| Array containing the historical track information | Current | Array containing the historical track information. The track information is sorted descending. | track |
tropicalcyclones |
API - Base Flex - Base |
| Timestamp of the date/time of the advisory for this data set, as issued by the NHC or JTWC | Current | Unix timestamp of the date/time of the advisory for this data set, as issued by the NHC or JTWC. | track.#.timestamp |
tropicalcyclones |
API - Base Flex - Base |
| Date of the date/time of the advisory for this data set, as issued by the NHC or JTWC | Current | ISO 8601 date of the date/time of the advisory for this data set, as issued by the NHC or JTWC. | track.#.dateTimeISO |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON point object of the location of the tropical system | Current | The GeoJSON point object of the location of the tropical system. | track.#.location |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON object type | Current | The GeoJSON object type. Should always be set to Point | track.#.location.type |
tropicalcyclones |
API - Base Flex - Base |
| Array of the position, containing the longitude and latitude | Current | Array of the position, containing the longitude and latitude. | track.#.location.coordinates |
tropicalcyclones |
API - Base Flex - Base |
| Classic API location object of the location of the tropical cyclone | Current | The classic API location object of the location of the tropical cyclone | track.#.loc |
tropicalcyclones |
API - Base Flex - Base |
| Longitude of the location of the tropical cyclone | Current | The longitude of the location of the tropical cyclone. | track.#.loc.long |
tropicalcyclones |
API - Base Flex - Base |
| Latitude of the location of the tropical cyclone | Current | The latitude of the location of the tropical cyclone. | track.#.loc.lat |
tropicalcyclones |
API - Base Flex - Base |
| Object containing the tropical system details | Current | Object containing the tropical system details. | track.#.details |
tropicalcyclones |
API - Base Flex - Base |
| Storm type | Current | The storm type. Uses the same codes as profile.maxStormType | track.#.details.stormType |
tropicalcyclones |
API - Base Flex - Base |
| Storm strength category, based on wind speed | Current | The storm strength category, based on wind speed. Uses the same codes as profile.maxStormCat | track.#.details.stormCat |
tropicalcyclones |
API - Base Flex - Base |
| Full name of the storm at the time of the advisory, based on wind speed | Current | The full name of the storm at the time of the advisory, based on wind speed. Example: Tropical Storm Lee | track.#.details.stormName |
tropicalcyclones |
API - Base Flex - Base |
| Storm name without the leading storm type | Current | The storm name without the leading storm type. For example, a value of Nate for Hurricane Nate. The name is in mixed case. If the storm has not been named yet, this may be a number, i.e. Tropical Depression 4 would have a name of Four. |
track.#.details.stormShortName |
tropicalcyclones |
API - Base Flex - Base |
| Advisory number that the information is based on | Current | The advisory number that the information is based on. | track.#.details.advisoryNumber |
tropicalcyclones |
API - Base Flex - Base |
| Two letter abbreviation of the basin the storm is located within | Current | The two letter abbreviation of the basin the storm is located within. | track.#.details.basin |
tropicalcyclones |
API - Base Flex - Base |
| Object containing the movement information | Current | Object containing the movement information. NULL if movement information is not available. | track.#.details.movement |
tropicalcyclones |
API - Base Flex - Base |
| Direction the storm is moving in cardinal coordinates | Current | The direction the storm is moving in cardinal coordinates. | track.#.details.movement.direction |
tropicalcyclones |
API - Base Flex - Base |
| Direction the storm is moving in degrees, 0 to 360, with 0 being North | Current | The direction the storm is moving in degrees, 0 to 360, with 0 being North. | track.#.details.movement.directionDEG |
tropicalcyclones |
API - Base Flex - Base |
| Speed of the storm in knots | Current | The speed of the storm in knots. | track.#.details.movement.speedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Speed of the storm in kilometers per hour | Current | The speed of the storm in kilometers per hour. | track.#.details.movement.speedKPH |
tropicalcyclones |
API - Base Flex - Base |
| Speed of the storm in miles per hour | Current | The speed of the storm in miles per hour. | track.#.details.movement.speedMPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum sustained wind speed reported in the advisory in knots | Current | The maximum sustained wind speed reported in the advisory in knots | track.#.details.windSpeedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Maximum sustained wind speed reported in the advisory in kilometers per second | Current | The maximum sustained wind speed reported in the advisory in kilometers per second | track.#.details.windSpeedKPH |
tropicalcyclones |
API - Base Flex - Base |
| maximum sustained wind speed reported in the advisory in miles per hour | Current | The maximum sustained wind speed reported in the advisory in miles per hour | track.#.details.windSpeedMPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum wind gust speed as reported in the advisory in knots | Current | The maximum wind gust speed as reported in the advisory in knots. NULL is not available. | track.#.details.gustSpeedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Maximum wind gust speed as reported in the advisory in kilometers per hour | Current | The maximum wind gust speed as reported in the advisory in kilometers per hour. NULL is not available. | track.#.details.gustSpeedKPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum wind gust speed as reported in the advisory in miles per hour | Current | The maximum wind gust speed as reported in the advisory in miles per hour. NULL is not available. | track.#.details.gustSpeedMPH |
tropicalcyclones |
API - Base Flex - Base |
| Minimum pressure reported in the advisory in millibars | Current | The minimum pressure reported in the advisory in millibars. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
track.#.details.pressureMB |
tropicalcyclones |
API - Base Flex - Base |
| Minimum pressure reported in the advisory in inches of mercury | Current | The minimum pressure reported in the advisory in inches of mercury. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
track.#.details.pressureIN |
tropicalcyclones |
API - Base Flex - Base |
| Array containing the forecast information | Current | Array containing the forecast information. The track information is sorted ascending. NULL if the storm is not active or the forecast is unavailable. | forecast |
tropicalcyclones |
API - Base Flex - Base |
| Timestamp of the date/time of the forecast point information | Current | Unix timestamp of the date/time of the forecast point information. | forecast.#.timestamp |
tropicalcyclones |
API - Base Flex - Base |
| Date of the date/time of the forecast point information | Current | forecast.#.dateTimeISO |
tropicalcyclones |
API - Base Flex - Base |
|
| GeoJSON point object of the forecast location of the tropical system | Current | The GeoJSON point object of the forecast location of the tropical system | forecast.#.location |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON object type | Current | The GeoJSON object type. Should always be set to Point | forecast.#.location.type |
tropicalcyclones |
API - Base Flex - Base |
| Position, containing the longitude and latitude | Current | Array of the position, containing the longitude and latitude. | forecast.#.location.coordinates |
tropicalcyclones |
API - Base Flex - Base |
| Classic API location object of the forecast location of the tropical cyclone | Current | The classic API location object of the forecast location of the tropical cyclone | forecast.#.loc |
tropicalcyclones |
API - Base Flex - Base |
| Longitude of the forecast location of the tropical cyclone | Current | The longitude of the forecast location of the tropical cyclone | forecast.#.loc.long |
tropicalcyclones |
API - Base Flex - Base |
| Latitude of the forecast location of the tropical cyclone | Current | The latitude of the forecast location of the tropical cyclone | forecast.#.loc.lat |
tropicalcyclones |
API - Base Flex - Base |
| Object containing the tropical system forecast details | Current | Object containing the tropical system forecast details. | forecast.#.details |
tropicalcyclones |
API - Base Flex - Base |
| Storm type | Current | The storm type. Uses the same codes as profile.maxStormType | forecast.#.details.stormType |
tropicalcyclones |
API - Base Flex - Base |
| Storm strength category, based on wind speed | Current | The storm strength category, based on wind speed. Uses the same codes as profile.maxStormCat | forecast.#.details.stormCat |
tropicalcyclones |
API - Base Flex - Base |
| Full name of the storm, based on the forecast wind speed | Current | The full name of the storm, based on the forecast wind speed. Example: Tropical Storm Lee | forecast.#.details.stormName |
tropicalcyclones |
API - Base Flex - Base |
| Storm name without the leading storm type | Current | The storm name without the leading storm type. For example, a value of Nate for Hurricane Nate. The name is in mixed case. If the storm has not been named yet, this may be a number, i.e. Tropical Depression 4 would have a name of Four. |
forecast.#.details.stormShortName |
tropicalcyclones |
API - Base Flex - Base |
| The two letter abbreviation of the basin the storm will be located within | Current | The two letter abbreviation of the basin the storm will be located within. | forecast.#.details.basin |
tropicalcyclones |
API - Base Flex - Base |
| Maximum forecast sustained wind speed in knots | Current | The maximum forecast sustained wind speed in knots | forecast.#.details.windSpeedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Maximum forecast sustained wind speed in kilometers per second | Current | The maximum forecast sustained wind speed in kilometers per second | forecast.#.details.windSpeedKPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum forecast sustained wind speed in miles per hour | Current | The maximum forecast sustained wind speed in miles per hour | forecast.#.details.windSpeedMPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum forecast wind gust speed in knots | Current | The maximum forecast wind gust speed in knots. NULL if not available | forecast.#.details.gustSpeedKTS |
tropicalcyclones |
API - Base Flex - Base |
| Maximum forecast wind gust speed in kilometers per hour | Current | The maximum forecast wind gust speed in kilometers per hour. NULL if not available | forecast.#.details.gustSpeedKPH |
tropicalcyclones |
API - Base Flex - Base |
| Maximum forecast wind gust speed in miles per hour | Current | The maximum forecast wind gust speed in miles per hour. NULL if not available | forecast.#.details.gustSpeedMPH |
tropicalcyclones |
API - Base Flex - Base |
| Wind radii for the forecast point | Current | The wind radii for the forecast point. Null if unavailable. See the properties for position.details.windRadii for the complete list of individual elements. |
forecast.#.details.windRadii |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON polygon object of the forecast error cone | Current | GeoJSON polygon object of the forecast error cone. NULL if the storm is not active, the forecast information is unavailable or if the geo filter not provided. NOTE: Due to the error cone containing a large amount of data, the cone is not returned by default. Use filter=geo to force the API to return the error cone. |
errorCone |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON object type | Current | The GeoJSON object type. Should always be set to Polygon | errorCone.Type |
tropicalcyclones |
API - Base Flex - Base |
| Array of the error cone polygon information | Current | Array of the error cone polygon information. | errorCone.coordinates |
tropicalcyclones |
API - Base Flex - Base |
| An array of NHC issued warnings and watches along the coastlines | Current | An array of NHC issued warnings and watches along the coastlines. NULL if not available. Only available for the Atlantic and East Pacific basins. The breakpoint alerts are commonly used to draw lines along the coastlines. These should not be confused with the official tropical and hurricane-related alerts issued by the local National Weather Service offices. |
breakPointAlerts |
tropicalcyclones |
API - Base Flex - Base |
| Type of alert issued | Current | The type of alert issued. TR.A = Tropical Storm Watch TR.W = Tropical Storm Warning HU.A = Hurricane Watch HU.W = Hurricane Warning |
breakPointAlerts.alertType |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON LineString object of NHC issued breakpoint alerts along the coasts | Current | GeoJSON LineString object of NHC issued breakpoint alerts along the coasts. | breakPointAlerts.coords |
tropicalcyclones |
API - Base Flex - Base |
| GeoJSON object type | Current | The GeoJSON object type. Should always be set to LineString | breakPointAlerts.coords.type |
tropicalcyclones |
API - Base Flex - Base |
| Array of the LineString coordinates | Current | Array of the LineString coordinates | breakPointAlerts.coords.coordinates |
tropicalcyclones |
API - Base Flex - Base |
| tropical system ID | Historical | The tropical system ID. The storm ID will be similar too: 2017-AL-16 : YEAR-BASIN-EVENTNUMBER |
id |
tropicalcyclones/archive |
API - Base Flex - Base |
| Historical | profile |
tropicalcyclones/archive |
API - Base Flex - Base |
||
| Storm name without the leading storm type | Historical | The storm name without the leading storm type. For example, a value of Nate for Hurricane Nate. The name is in mixed case. If the storm has not been named yet, this may be a number, i.e. Tropical Depression 4 would have a name of Four. |
profile.name |
tropicalcyclones/archive |
API - Base Flex - Base |
| Tropical season year that the storm initialized within | Historical | The tropical season year that the storm initialized within. | profile.year |
tropicalcyclones/archive |
API - Base Flex - Base |
| Basin abbreviation that the storm is originated within | Historical | The basin abbreviation that the storm is originated within. AL = Atlantic EP = Eastern Pacific CP = Central Pacific WP = Western Pacific IO = Indian Ocean SH = Southern Hemisphere |
profile.basinOrigin |
tropicalcyclones/archive |
API - Base Flex - Base |
| Basin abbreviation that the storm is currently location within | Historical | The basin abbreviation that the storm is currently location within. Null for inactive storms | profile.basinCurrent |
tropicalcyclones/archive |
API - Base Flex - Base |
| Array of basin abbreviations that the storm has been within | Historical | Array of basin abbreviations that the storm has been within. Some Pacific storms may travel into multiple basins. | profile.basins |
tropicalcyclones/archive |
API - Base Flex - Base |
| Event number of the storm within the basin | Historical | The event number of the storm within the basin. | profile.event |
tropicalcyclones/archive |
API - Base Flex - Base |
| True if the storm is active, false otherwise | Historical | True if the storm is active, false otherwise. | profile.isActive |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm Lifespan | Historical | Object containing the lifespan of the storm. | profile.lifespan |
tropicalcyclones/archive |
API - Base Flex - Base |
| First Advisory Time (Unix) | Historical | Unix timestamp of when the first advisory was issued for the storm by the NHC or JTWC. | profile.lifespan.startTimestamp |
tropicalcyclones/archive |
API - Base Flex - Base |
| First Advisory Time (Date) | Historical | ISO 8601 date of when the first advisory was issued for the storm by the NHC or JTWC. | profile.lifespan.startDateTimeISO |
tropicalcyclones/archive |
API - Base Flex - Base |
| Last Advisory Time (Unix) | Historical | Unix timestamp of when the last advisory was issued for the storm by the NHC or JTWC. If a system is still active, this value will be null. | profile.lifespan.endTimestamp |
tropicalcyclones/archive |
API - Base Flex - Base |
| Last Advisory Time (Date) | Historical | ISO 8601 date of when the last advisory was issued for the storm by the NHC or JTWC. If a system is still active, this value will be null. | profile.lifespan.endDateTimeISO |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum Type of Storm | Historical | The maximum type of storm (based on wind speed), abbreviated I = Invest DB = Disturbance TD = Tropical Depression TS = Tropical Storm H = Hurricane TY = Typhoon |
profile.maxStormType |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum Storm Strength | Historical | The maximum strength category the storm achieved, based on wind speed. I = Invest DB = Disturbance TD = Tropical Depression TS = Tropical Storm H1 = Category 1 Hurricane H2 = Category 2 Hurricane H3 = Category 3 Hurricane H4 = Category 4 Hurricane H5 = Category 5 Hurricane TY = Typhoon STY = Super Typhoon |
profile.maxStormCat |
tropicalcyclones/archive |
API - Base Flex - Base |
| Object containing the maximum wind speed information | Historical | Object containing the maximum wind speed information | profile.windSpeed |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum reported wind speed of the storm during its lifetime in knots | Historical | Maximum reported wind speed of the storm during its lifetime in knots. | profile.windSpeed.maxKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum reported wind speed of the storm during its lifetime in kilometers per hour | Historical | Maximum reported wind speed of the storm during its lifetime in kilometers per hour. | profile.windSpeed.maxKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum reported wind speed of the storm during its lifetime in miles per hour | Historical | Maximum reported wind speed of the storm during its lifetime in miles per hour. | profile.windSpeed.maxMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Timestamp of the date/time of the reported maximum wind speed | Historical | Unix timestamp of the date/time of the reported maximum wind speed | profile.windSpeed.maxTimestamp |
tropicalcyclones/archive |
API - Base Flex - Base |
| Date of the date/time of the reported maximum wind speed | Historical | ISO 8601 date of the date/time of the reported maximum wind speed | profile.windSpeed.maxDateTimeISO |
tropicalcyclones/archive |
API - Base Flex - Base |
| Object containing the minimum pressure information | Historical | Object containing the minimum pressure information. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
profile.pressure |
tropicalcyclones/archive |
API - Base Flex - Base |
| Minimum reported pressure of the storm during its lifetime, in millibars | Historical | The minimum reported pressure of the storm during its lifetime, in millibars. Null if pressure information is not available. | profile.pressure.minMB |
tropicalcyclones/archive |
API - Base Flex - Base |
| Minimum Pressure (in) | Historical | The minimum reported pressure of the storm during its lifetime, in inches of mercury. Null if pressure information is not available. | profile.pressure.minIN |
tropicalcyclones/archive |
API - Base Flex - Base |
| Time Stamp of Pressure (Unix) | Historical | Unix timestamp of the date/time of the reported minimum pressure. Null if pressure information is not available. | profile.pressure.minTimestamp |
tropicalcyclones/archive |
API - Base Flex - Base |
| Time Stamp of Pressure (Date) | Historical | ISO 8601 date of the date/time of the reported minimum pressure. Null if pressure information is not available. | profile.pressureminDateTimeISO |
tropicalcyclones/archive |
API - Base Flex - Base |
| Array containing a bounding box of all the system components, including the track, forecast, error cone, and breakpoint Alerts | Historical | Array containing a bounding box of all the system components, including the track, forecast, error cone, and breakpoint Alerts. The bounding box array follows the following order: [South Latitude, West Longitude, North Latitude, East Longitude] NOTE: for systems that cross the 180th meridian, it is possible for the west longitude to have a greater value than the east longitude. |
profile.boundingBox |
tropicalcyclones/archive |
API - Base Flex - Base |
| Time Zone | Historical | The timezone name for the cyclone. If the storm is active, it will be the timezone of its current position, otherwise the timezone of the cyclones first location. | profile.tz |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Position | Historical | Object containing the latest storm position information. NULL for inactive storms. | position |
tropicalcyclones/archive |
API - Base Flex - Base |
| Time Stamp of Position (Unix) | Historical | Unix timestamp of the date/time of the advisory for this data set, as issued by the NHC or JTWC. | position.timestamp |
tropicalcyclones/archive |
API - Base Flex - Base |
| Time Stamp of Position (Date) | Historical | ISO 8601 date of the date/time of the advisory for this data set, as issued by the NHC or JTWC. | position.dateTimeISO |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON point object of the location of the tropical system | Historical | The GeoJSON point object of the location of the tropical system. | position.location |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON object type | Historical | The GeoJSON object type. Should always be set to Point | position.location.type |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Coordinates (lon./lat.) | Historical | Array of the position, containing the longitude and latitude. | position.location.coordinates |
tropicalcyclones/archive |
API - Base Flex - Base |
| Classic API location object of the latest reported location of the tropical cyclone | Historical | The classic API location object of the latest reported location of the tropical cyclone. | position.loc |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Coordinates (lon.) | Historical | The longitude of the latest reported location of the tropical cyclone. | position.loc.long |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Coordinates (lat.) | Historical | The latitude of the latest reported location of the tropical cyclone. | position.loc.lat |
tropicalcyclones/archive |
API - Base Flex - Base |
| Object containing the tropical system details | Historical | Object containing the tropical system details. | position.details |
tropicalcyclones/archive |
API - Base Flex - Base |
| Current storm type | Historical | The current storm type. Uses the same codes as profile.maxStormType | position.details.stormType |
tropicalcyclones/archive |
API - Base Flex - Base |
| Current storm strength category, based on wind speed | Historical | The current storm strength category, based on wind speed. Uses the same codes as profile.maxStormCat | position.details.stormCat |
tropicalcyclones/archive |
API - Base Flex - Base |
| Full Storm Name | Historical | The full name of the storm at the time of the advisory, based on wind speed. Example: Tropical Storm Lee | position.details.stormName |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Short Name | Historical | The storm name without the leading storm type. For example, a value of Nate for Hurricane Nate. The name is in mixed case. If the storm has not been named yet, this may be a number, i.e. Tropical Depression 4 would have a name of Four. |
position.details.stormShortName |
tropicalcyclones/archive |
API - Base Flex - Base |
| Advisory Number | Historical | The latest advisory number that the position information is based on. NOTE: This value is a string, as the NHC will issue intermediate advisories for storms close to landfall. These intermediate advisories may include letters, such as an Advisory Number of 4A |
position.details.advisoryNumber |
tropicalcyclones/archive |
API - Base Flex - Base |
| Basin Abbreviation | Historical | The two letter abbreviation of the basin the storm is within | position.details.basin |
tropicalcyclones/archive |
API - Base Flex - Base |
| Object containing the movement information | Historical | Object containing the movement information. NULL if movement information is not available. | position.details.movement |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Movement (cardinal coordinates) | Historical | The direction the storm is moving in cardinal coordinates. | position.details.movement.direction |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Movement (degrees) | Historical | The direction the storm is moving in degrees, 0 to 360, with 0 being North. | position.details.movement.directionDEG |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Speed (knots) | Historical | The speed of the storm in knots. | position.details.movement.speedKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Speed (kph) | Historical | The speed of the storm in kilometers per hour. | position.details.movement.speedKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm - Speed (mph) | Historical | The speed of the storm in miles per hour. | position.details.movement.speedMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum Sustained Winds (knots) | Historical | The maximum sustained wind speed reported in the advisory in knots | position.details.windSpeedKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum Sustained Winds (kph) | Historical | The maximum sustained wind speed reported in the advisory in kilometers per second | position.details.windSpeedKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum Sustained Winds (mph) | Historical | The maximum sustained wind speed reported in the advisory in miles per hour | position.details.windSpeedMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum Wind Gust (knots) | Historical | The maximum wind gust speed as reported in the advisory in knots. NULL is not available. | position.details.gustSpeedKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum Wind Gust (kph) | Historical | The maximum wind gust speed as reported in the advisory in kilometers per hour. NULL is not available. | position.details.gustSpeedKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum Wind Gust (mph) | Historical | The maximum wind gust speed as reported in the advisory in miles per hour. NULL is not available. | position.details.gustSpeedMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Minimum Pressure (mb) | Historical | The minimum pressure reported in the advisory in millibars. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
position.details.pressureMB |
tropicalcyclones/archive |
API - Base Flex - Base |
| Minimum pressure reported in the advisory in inches of mercury | Historical | The minimum pressure reported in the advisory in inches of mercury. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
position.details.pressureIN |
tropicalcyclones/archive |
API - Base Flex - Base |
| Array containing the historical track information | Historical | Array containing the historical track information. The track information is sorted descending. | track |
tropicalcyclones/archive |
API - Base Flex - Base |
| Time Stamp - Storm Track (Unix) | Historical | Unix timestamp of the date/time of the advisory for this data set, as issued by the NHC or JTWC. | track.#.timestamp |
tropicalcyclones/archive |
API - Base Flex - Base |
| Date of the date/time of the advisory for this data set, as issued by the NHC or JTWC | Historical | ISO 8601 date of the date/time of the advisory for this data set, as issued by the NHC or JTWC. | track.#.dateTimeISO |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON point object of the location of the tropical system | Historical | The GeoJSON point object of the location of the tropical system. | track.#.location |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON object type | Historical | The GeoJSON object type. Should always be set to Point | track.#.location.type |
tropicalcyclones/archive |
API - Base Flex - Base |
| Array of the position | Historical | Array of the position, containing the longitude and latitude. | track.#.location.coordinates |
tropicalcyclones/archive |
API - Base Flex - Base |
| Classic API location object of the location of the tropical cyclone | Historical | The classic API location object of the location of the tropical cyclone. | track.#.loc |
tropicalcyclones/archive |
API - Base Flex - Base |
| Longitude of the location of the tropical cyclone | Historical | The longitude of the location of the tropical cyclone. | track.#.loc.long |
tropicalcyclones/archive |
API - Base Flex - Base |
| Latitude of the location of the tropical cyclone | Historical | The latitude of the location of the tropical cyclone. | track.#.loc.lat |
tropicalcyclones/archive |
API - Base Flex - Base |
| Object containing the tropical system details | Historical | Object containing the tropical system details. | track.#.details |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm type | Historical | The storm type. Uses the same codes as profile.maxStormType | track.#.details.stormType |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm strength category | Historical | The storm strength category, based on wind speed. Uses the same codes as profile.maxStormCat | track.#.details.stormCat |
tropicalcyclones/archive |
API - Base Flex - Base |
| Full name of the storm at the time of the advisory | Historical | The full name of the storm at the time of the advisory, based on wind speed. Example: Tropical Storm Lee | track.#.details.stormName |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm name without the leading storm type | Historical | The storm name without the leading storm type. For example, a value of Nate for Hurricane Nate. The name is in mixed case. If the storm has not been named yet, this may be a number, i.e. Tropical Depression 4 would have a name of Four. |
track.#.details.stormShortName |
tropicalcyclones/archive |
API - Base Flex - Base |
| Advisory number that the information is based on | Historical | The advisory number that the information is based on. | track.#.details.advisoryNumber |
tropicalcyclones/archive |
API - Base Flex - Base |
| Two letter abbreviation of the basin the storm is within | Historical | The two letter abbreviation of the basin the storm is within | track.#.details.basin |
tropicalcyclones/archive |
API - Base Flex - Base |
| Object containing the movement information | Historical | Object containing the movement information. NULL if movement information is not available. | track.#.details.movement |
tropicalcyclones/archive |
API - Base Flex - Base |
| Direction the storm is moving in cardinal coordinates | Historical | The direction the storm is moving in cardinal coordinates. | track.#.details.movement.direction |
tropicalcyclones/archive |
API - Base Flex - Base |
| Direction the storm is moving in degrees | Historical | The direction the storm is moving in degrees, 0 to 360, with 0 being North. | track.#.details.movement.directionDEG |
tropicalcyclones/archive |
API - Base Flex - Base |
| Speed of the storm in knots | Historical | The speed of the storm in knots. | track.#.details.movement.speedKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Speed of the storm in kilometers per hour | Historical | The speed of the storm in kilometers per hour. | track.#.details.movement.speedKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Speed of the storm in miles per hour | Historical | The speed of the storm in miles per hour. | track.#.details.movement.speedMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum sustained wind speed reported in the advisory in knots | Historical | The maximum sustained wind speed reported in the advisory in knots | track.#.details.windSpeedKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum sustained wind speed reported in the advisory in kilometers per second | Historical | The maximum sustained wind speed reported in the advisory in kilometers per second | track.#.details.windSpeedKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum sustained wind speed reported in the advisory in miles per hour | Historical | The maximum sustained wind speed reported in the advisory in miles per hour | track.#.details.windSpeedMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum wind gust speed as reported in the advisory in knots | Historical | The maximum wind gust speed as reported in the advisory in knots. NULL is not available. | track.#.details.gustSpeedKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum wind gust speed as reported in the advisory in kilometers per hour | Historical | The maximum wind gust speed as reported in the advisory in kilometers per hour. NULL is not available. | track.#.details.gustSpeedKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum wind gust speed as reported in the advisory in miles per hour | Historical | The maximum wind gust speed as reported in the advisory in miles per hour. NULL is not available. | track.#.details.gustSpeedMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Minimum pressure reported in the advisory in millibars | Historical | The minimum pressure reported in the advisory in millibars. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
track.#.details.pressureMB |
tropicalcyclones/archive |
API - Base Flex - Base |
| Minimum pressure reported in the advisory in inches of mercury | Historical | The minimum pressure reported in the advisory in inches of mercury. NULL if not available. Note: Pressure information is currently not available for West Pacific, South Pacific and Indian Ocean tropical systems |
track.#.details.pressureIN |
tropicalcyclones/archive |
API - Base Flex - Base |
| Array containing the forecast information. The track information is sorted ascending | Historical | Array containing the forecast information. The track information is sorted ascending. NULL if the storm is not active or the forecast is unavailable. | forecast |
tropicalcyclones/archive |
API - Base Flex - Base |
| Timestamp of the date/time of the forecast point information | Historical | Unix timestamp of the date/time of the forecast point information. | forecast.#.timestamp |
tropicalcyclones/archive |
API - Base Flex - Base |
| Date of the date/time of the forecast point information | Historical | ISO 8601 date of the date/time of the forecast point information. | forecast.#.dateTimeISO |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON point object of the forecast location of the tropical system | Historical | The GeoJSON point object of the forecast location of the tropical system | forecast.#.location |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON object type | Historical | The GeoJSON object type. Should always be set to Point | forecast.#.location.type |
tropicalcyclones/archive |
API - Base Flex - Base |
| Array of the position, containing the longitude and latitude | Historical | Array of the position, containing the longitude and latitude. | forecast.#.location.coordinates |
tropicalcyclones/archive |
API - Base Flex - Base |
| Classic API location object of the forecast location of the tropical cyclone | Historical | The classic API location object of the forecast location of the tropical cyclone. | forecast.#.loc |
tropicalcyclones/archive |
API - Base Flex - Base |
| Longitude of the forecast location of the tropical cyclone | Historical | The longitude of the forecast location of the tropical cyclone. | forecast.#.loc.long |
tropicalcyclones/archive |
API - Base Flex - Base |
| Latitude of the forecast location of the tropical cyclone | Historical | The latitude of the forecast location of the tropical cyclone. | forecast.#.loc.lat |
tropicalcyclones/archive |
API - Base Flex - Base |
| Object containing the tropical system forecast details | Historical | Object containing the tropical system forecast details. | forecast.#.details |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm type | Historical | The storm type. Uses the same codes as profile.maxStormType | forecast.#.details.stormType |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm strength category, based on wind speed | Historical | The storm strength category, based on wind speed. Uses the same codes as profile.maxStormCat | forecast.#.details.stormCat |
tropicalcyclones/archive |
API - Base Flex - Base |
| Full name of the storm, based on the forecast wind speed | Historical | The full name of the storm, based on the forecast wind speed. Example: Tropical Storm Lee | forecast.#.details.stormName |
tropicalcyclones/archive |
API - Base Flex - Base |
| Storm name without the leading storm type | Historical | The storm name without the leading storm type. For example, a value of Nate for Hurricane Nate. The name is in mixed case. If the storm has not been named yet, this may be a number, i.e. Tropical Depression 4 would have a name of Four. |
forecast.#.details.stormShortName |
tropicalcyclones/archive |
API - Base Flex - Base |
| Two letter abbreviation of the basin the storm is forecast to be within | Historical | The two letter abbreviation of the basin the storm is forecast to be within | forecast.#.details.basin |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum forecast sustained wind speed in knots | Historical | The maximum forecast sustained wind speed in knots | forecast.#.details.windSpeedKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum forecast sustained wind speed in kilometers per second | Historical | The maximum forecast sustained wind speed in kilometers per second | forecast.#.details.windSpeedKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum forecast sustained wind speed in miles per hour | Historical | The maximum forecast sustained wind speed in miles per hour | forecast.#.details.windSpeedMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum forecast wind gust speed in knots | Historical | The maximum forecast wind gust speed in knots. NULL if not available | forecast.#.details.gustSpeedKTS |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum forecast wind gust speed in kilometers per hour | Historical | The maximum forecast wind gust speed in kilometers per hour. NULL if not available | forecast.#.details.gustSpeedKPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| Maximum forecast wind gust speed in miles per hour | Historical | The maximum forecast wind gust speed in miles per hour. NULL if not available | forecast.#.details.gustSpeedMPH |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON polygon object of the forecast error cone | Historical | GeoJSON polygon object of the forecast error cone. NULL if the storm is not active, the forecast information is unavailable or if the geo filter not provided. NOTE: Due to the error cone containing a large amount of data, the cone is not returned by default. Use filter=geo to force the API to return the error cone. |
errorCone |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON object type | Historical | The GeoJSON object type. Should always be set to Polygon | errorCone.Type |
tropicalcyclones/archive |
API - Base Flex - Base |
| Array of the error cone polygon information | Historical | Array of the error cone polygon information. | errorCone.coordinates |
tropicalcyclones/archive |
API - Base Flex - Base |
| An array of NHC issued warnings and watches along the coastlines | Historical | An array of NHC issued warnings and watches along the coastlines. NULL if not available. Only available for the Atlantic and East Pacific basins. The breakpoint alerts are commonly used to draw lines along the coastlines. These should not be confused with the official tropical and hurricane-related alerts issued by the local National Weather Service offices. |
breakPointAlerts |
tropicalcyclones/archive |
API - Base Flex - Base |
| Type of alert issued | Historical | The type of alert issued. TR.A = Tropical Storm Watch TR.W = Tropical Storm Warning HU.A = Hurricane Watch HU.W = Hurricane Warning |
breakPointAlerts.alertType |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON LineString object of NHC issued breakpoint alerts along the coasts | Historical | GeoJSON LineString object of NHC issued breakpoint alerts along the coasts. | breakPointAlerts.coords |
tropicalcyclones/archive |
API - Base Flex - Base |
| GeoJSON object type | Historical | The GeoJSON object type. Should always be set to LineString | breakPointAlerts.coords.type |
tropicalcyclones/archive |
API - Base Flex - Base |
| Array of the LineString coordinates | Historical | Array of the LineString coordinates | breakPointAlerts.coords.coordinates |
tropicalcyclones/archive |
API - Base Flex - Base |
| Version number of the API | Current | The version number of the API. | version.api |
version |
API - Base Flex - Base |
| version number of the AerisWeather Library being used | Current | The version number of the AerisWeather Library being used. | version.library |
version |
API - Base Flex - Base |