Indices API Parameters

Request parameters | Response parameters

 



Daily Indices API Query String Parameters

Parameter Description Default value
api Hostname to be used only in production: api.accuweather.com N/A Required
apidev Hostname to be used only in development: apidev.accuweather.com N/A Required
apikey Unique code used to access the API N/A Required
version Version of the API v1 Required
locationkey Unique ID used to search for a specific location N/A Required
format Format of the response JSON Optional
language String indicating the language in which to return the resource en-us Optional
details Boolean value (true or false) that specifies whether or not to include a truncated version of the indices object or the full object (details = true) false Optional
group id Numeric id used to identify a group of related indices No filter Optional
index id Numeric id used to identify a specific index No filter Optional

Top of Page



 

Daily Indices API Response Parameters

Parameter Description
Name Name of the index
ID Numeric id used to identify the specific index
Ascending Bit that describes the direction of the index value.  When true, the poorest value is 0,  best value is 10.  When false, the poorest value is 10, best value is 0
LocalDateTime Valid datetime of the index displayed in ISO8601 format: yyyy-mm-ddThh:mm:ss±hh:mm
EpochDateTime Valid datetime for the index displayed as the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT)
Value Index value.  Ranges from 0.0 to 10.0
Category Level that the index value falls.  Categories differ among indices  
CategoryValue Level that the index value falls represented by an int. This value can be 1 through 5 and should be used in combination with the ascending flag because it can differ among indices
Text Sentence that can be used for display purposes to sum up the index value and category
MobileLink Link to indices on AccuWeather's mobile site for the requested location
Link Link to indices on AccuWeather's free site for the requested location

Top of Page