Heating and Cooling Index-v2.0
Overview
- Domain Portfolio: Forecast
- Domain: Lifestyle - Indices
- Usage Classification: Standard
- Geography: Global
- Attribution Required: n/a
- Attribution Requirements: n/a
The Heating and Cooling index provides indices describing the amount of heating/cooling that is required to maintain a comfortable indoor temperature, based on weather conditions.
HTTP Headers and Data Lifetime - Caching and Expiration
For details on appropriate header values as well as caching and expiration definitions, please see The Weather Company Data | API Common Usage Guide.
URL Construction
Atomic API URL Examples: | |
---|---|
Heating and Cooling Index - Daypart API | |
Request by Geocode (Latitude & Longitude): Required Parameters: geocode, language, format https://api.weather.com/v2/indices/heatCool/daypart/<duration>?geocode=33.74,-84.39&language=en-US&format=<json>&apiKey=yourApiKey |
Aggregate Product Name |
https://api.weather.com/v2/indices/heatCool/daypart/15day?geocode=33.74,-84.39&language=en-US&format=json&apiKey=yourApiKey |
v2idxHeatCoolDaypart15 |
Request by Postal Code: Required Parameters: postalCode, countryCode, language, format https://api.weather.com/v2/indices/heatCool/daypart/<duration>?postalCode=94608&countryCode=US&format=<json>&language=en-US&apiKey=yourApiKey |
Aggregate Product Name |
https://api.weather.com/v2/indices/heatCool/daypart/15day?postalCode=94608&countryCode=US&format=json&language=en-US&apiKey=yourApiKey | v2idxHeatCoolDaypart15 |
Data Elements & Definitions
API Name | Field Name | Description | Type | Range | Sample | Nulls Allowed | Usage |
---|---|---|---|---|---|---|---|
Repeating Elements: Unique to Forecast | |||||||
fcstValid | Time forecast is valid ... start of the forecast period, always 7am local time. | [epoch] | 1369306800 | N | Display As Provided | ||
fcstValidLocal | Time forecast is valid ... start of the forecast period, always 7am local time. | [ISO] | 2013-05-23T07:00:00-0400 | N | Display As Provided | ||
Repeating Elements: Common Per Time Segment | |||||||
num | Daypart Segment (12hour) - Sequential daypart number, where 1 = daytime of Day 0 | [integer] | 21 | N | Display As Provided | ||
dayInd | Day / Night Indicator | [string] | D, N | D | N | Display As Provided | |
daypartName | Name of 12hr daypart, not including day names in first 48hrs | [string] | Tomorrow | N | Display As Provided | ||
Atomic Indices | |||||||
Heating and Cooling Index | heatingCoolingCategory | Descriptive text of Heating and Cooling Index | [string] | Some Heating for Comfort | N | Display As Provided | |
heatingCoolingIndex |
Index describing the amount of heating/cooling that is required to maintain a comfortable indoor temperature, based on weather conditions. 0=No Heating or Cooling, 1-2=Little or No Cooling Required, 3-6=Some Cooling for Comfort, 7-8=Cooling May be Necessary, 9-10=Cooling Required, -1to-2=Little or No Heating Required, -3to-6=Some Heating for Comfort, -7to-8=Moderate Heating, -9 to-10=Heating Required |
[integer] | -10 to 10 | -5 | N | Display As Provided |
JSON Sample
JSON Sample - Daypart
{ "metadata": {}, "heatingCoolingIndex12hour": { "fcstValid": [], "fcstValidLocal": [], "dayInd": [], "num": [], "daypartName": [], "heatingCoolingIndex": [], "heatingCoolingCategory": [] } } |
{//JSON payload}, {//JSON payload}, {//JSON payload}, {//JSON payload}, {//JSON payload}, {//JSON payload}, {//JSON payload}, |