Power Disruption Index
Overview
- Domain Portfolio: Forecast
- Domain: Lifestyle - Indices
- Usage Classification: Standard
- Geography: Global
- Attribution Required: n/a
- Attribution Requirements: n/a
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: | |
---|---|
Request by Geocode (Latitude & Longitude): Required Parameters: geocode, language, format https://api.weather.com/v2/indices/powerDisruption/daypart/<duration>?geocode=33.74,-84.39&language=en-US&format=<json>&apiKey=yourApiKey |
Aggregate Product Name |
https://api.weather.com/v2/indices/powerDisruption/daypart/15day?geocode=33.74,-84.39&language=en-US&format=json&apiKey=yourApiKey | v2idxPowerDaypart15 |
Request by Postal Code: Required Parameters: postalCode, countryCode, language, format https://api.weather.com/v2/indices/powerDisruption/daypart/<duration>?postalCode=94608&countryCode=US&format=<json>&language=en-US&apiKey=yourApiKey |
Aggregate Product Name |
https://api.weather.com/v2/indices/powerDisruption/daypart/15day?postalCode=94608&countryCode=US&format=json&language=en-US&apiKey=yourApiKey | v2idxPowerDaypart15 |
Power Disruption Index - Daypart API |
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 Long - Range - Sequential hour number, where 1 = first available hour of forecast, usually <= 1hr from “now” |
[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 | |||||||
Power Disruption Index | powerDisruptionCategory | Descriptive text of Power Disruption Index | [string] | Low | N | Display As Provided | |
powerDisruptionIndex |
Index indicating the potential for power disruptions due to weather. 0=none, 1=low, 2=moderate, 3=high, 4=very high |
[integer] | 0-4 | 1 | N | Display As Provided |
JSON Sample
JSON Sample - Daypart
{ "metadata": {}, "powerDisruptionIndex12hour": { "fcstValid": [], "fcstValidLocal": [], "dayInd": [], "num": [], "daypartName": [], "powerDisruptionIndex": [], "powerDisruptionCategory": [] } } |
{//JSON payload}, {//JSON payload}, {//JSON payload}, {//JSON payload}, {//JSON payload}, {//JSON payload}, {//JSON payload}, |