Overview
With this API, you can get high-level Intelligence on widespread power outages affecting U.S. States, Territories, and Counties.
Endpoint Details
All requests must set the following headers:
| Header Name | Header Value |
| Content-Type | application/json |
| Authorization | Bearer <your API token> |
Request Method
GET
Request URL
https://api.gisual.com/v1/outages/power/regional/overview
Request Parameters
| Parameter | Description | Type |
| affected_regions_only |
Add this parameter to filter the response to U.S. States and Territories that have Counties which exceed 4% of electric customers without power. |
Boolean |
Response Body
This is an abbreviated representation of the response body.
Some States and Territories and all GeoJSON objects are omitted for brevity.
All U.S. States and Territories are included in the response body under administrative_area.
Counties are present inside each State/Territory (under administrative_area_2) when the percent of electric customers without power exceeds 4% county-wide. You can see this in the example response under Arkansas.
{
"country": [
{
"name": "United States",
"administrative_area": [
{
"name": "Alabama",
"geojson": {},
"percent_affected": 0.0002245940849146349,
"administrative_area_2": []
},
{
"name": "Alaska",
"geojson": {},
"percent_affected": 0.0005601102648442949,
"administrative_area_2": []
},
{
"name": "Arizona",
"geojson": {},
"percent_affected": 0.0014425946806393844,
"administrative_area_2": []
},
{
"name": "Arkansas",
"geojson": {},
"percent_affected": 0.002302512385668859,
"administrative_area_2": [
{
"name": "Pike County",
"geojson": {},
"percent_affected": 0.044629029987329295,
"number_affected": 529
}
]
},
...
{
"name": "Wyoming",
"geojson": {},
"percent_affected": 4.0113279902444505e-05,
"administrative_area_2": []
}
]
}
]
}
Field Details
| Field name | Description | Type |
| administrative_area | An associative array of U.S. State or Territory name to widespread regional power outage intel. | Object |
| administrative_area_2 | An associative array of County name to widespread regional power outage intel. | Object |
|
geojson
|
A GeoJSON polygon representing the State, Territory, or County. | Object |
| name | The name of the County, State, or Territory. | String |
| percent_affected | The percent of electric customers without power in a County, State, or Territory. | Number |
| number_affected | The number of electric customers without power in a County. | Number |
Comments
0 comments
Article is closed for comments.