Attention Developers: Our Documentation Is Moving!
Explore the latest updates and features in our new Signal Product Documentation and Switch Product Documentation.
Please note, this site’s retirement date will be announced soon, so make sure to update your bookmarks.
Explore the latest updates and features in our new Signal Product Documentation and Switch Product Documentation.
Please note, this site’s retirement date will be announced soon, so make sure to update your bookmarks.
Open Savings API (RETIRED)
Note that this API is deprecated.
Open Savings API returns aggregated savings data by region.
Attributions
Just as you’d never quote someone without attribution, credit Genability when using our data. Whenever Genability OpenSavings data is displayed on the screen (or used to calculate your own results), attribution to Genability should be visible and link back to Genability’s OpenSavings page. You can use some of our assets or just text containing the word “Genability,” or a combination of both. If you have any questions, please email us.
Data Definitions
Region Savings
Region Savings has the following data structure.
| Name | Type | Fields | Description |
|---|---|---|---|
| cityKey | Long | M | The matching cityKey for the region. |
| region | String | M | The associated region / city. |
| regionType | String | M | The type of the region |
| sunshineRating | Rating | M | Relative sunshine rating by state. |
| popularityRating | Rating | M | Relative popularity rating by state. |
| pvRatesRating | Rating | M | Relative pv rates by state. |
| pre | Map | M | The associated utility costs before solar. |
| post | Map | M | The associated utility costs after solar. |
| utilitySavings | Map | M | The total utility cost savings. |
| netSavings | Map | M | The net cost savings. |
| utilitySavingsRank | Long | M | Relative utility savings by state. |
| netSavingsRank | Long | M | Relative net savings by state. |
| housingStock | Map | M | The details for the housing stock of the region. |
Cost Savings
Cost Savings has the following data structure.
| Name | Type | Fields | Description |
|---|---|---|---|
| regionType | String | M | The type of the region |
| calcType | String | M | Calculation type used to perform the cost savings analysis (e.g. TTM = Trailing Twelve Months) |
| buildingType | String | M | Calendar name |
| usageType | String | M | Usage profile used in the pre and post calc analysis. |
| pre | Map | M | The associated utility costs before solar. |
| post | Map | M | The associated utility costs after solar. |
| utilitySavings | Map | M | The total utility cost savings. |
| netSavings | Map | M | The net cost savings. |
Get Region Savings
Returns a list of regions savings matching the supplied criteria. For a specific address, there will be only one Region Savings
Resource URI
GET /rest/alpha/open/region
Request Parameters
| Name | Type | Description |
|---|---|---|
| addressString | String | An address of any kind. Ideally this will contain a zipcode or post code. (Optional) |
| zipCode | String | An alternate to using addressString. Make sure its just the ZIP code though. (Optional) |
Example
GET /rest/alpha/open/costSavings?zipCode=94619
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
{
"status":"success",
"count":1,
"type":"RegionSavings",
"results":[
{
"cityKey":2457,
"region":"OAKLAND, CA",
"regionType":"city",
"ratesRating":{
"ratingType":"ratesRating",
"ratingTypeKey":{
"keyName":"ratesRating",
"displayName":"Rates Rating",
"family":"billing",
"keyspace":"electricity",
"description":"Rating of the electric rate ($/kWh) paid by a typical customer in the area.",
"dataType":"CHOICE",
"quantityUnit":"",
"lookbackPeriod":"",
"privacy":"PUBLIC",
"choices":[
{
"displayValue":"Low",
"value":"1",
"dataValue":"1",
"likelihood":null
},
{
"displayValue":"Moderate",
"value":"2",
"dataValue":"2",
"likelihood":null
},
{
"displayValue":"High",
"value":"3",
"dataValue":"3",
"likelihood":null
},
{
"displayValue":"Very High",
"value":"4",
"dataValue":"4",
"likelihood":null
}
]
},
"min":0.200000,
"max":100.000000,
"description":"Very High"
},
"sunshineRating":{
"ratingType":"sunshineRating",
"ratingTypeKey":{
"keyName":"sunshineRating",
"displayName":"Sunshine Rating",
"family":"production",
"keyspace":"solarPV",
"description":"Rating of the typical solar PV system production (kWh/kW-DC) available in the area.",
"dataType":"CHOICE",
"quantityUnit":"",
"lookbackPeriod":"",
"privacy":"PUBLIC",
"choices":[
{
"displayValue":"Poor",
"value":"1",
"dataValue":"1",
"likelihood":null
},
{
"displayValue":"OK",
"value":"2",
"dataValue":"2",
"likelihood":null
},
{
"displayValue":"Good",
"value":"3",
"dataValue":"3",
"likelihood":null
},
{
"displayValue":"Great",
"value":"4",
"dataValue":"4",
"likelihood":null
}
]
},
"min":1500.000000,
"max":5000.000000,
"description":"Great"
},
"popularityRating":{
"ratingType":"popularityRating",
"ratingTypeKey":{
"keyName":"popularityRating",
"displayName":"Popularity Rating",
"family":"system",
"keyspace":"solarPV",
"description":"Rating of the popularity (installations, proposals, etc) of solar PV in the area.",
"dataType":"CHOICE",
"quantityUnit":"",
"lookbackPeriod":"",
"privacy":"PUBLIC",
"choices":[
{
"displayValue":"Low",
"value":"1",
"dataValue":"1",
"likelihood":null
},
{
"displayValue":"Moderate",
"value":"2",
"dataValue":"2",
"likelihood":null
},
{
"displayValue":"High",
"value":"3",
"dataValue":"3",
"likelihood":null
},
{
"displayValue":"Very High",
"value":"4",
"dataValue":"4",
"likelihood":null
}
]
},
"min":1000.000000,
"max":5000.000000,
"description":"Moderate"
},
"pvRatesRating":{
"ratingType":"pvRatesRating",
"ratingTypeKey":{
"keyName":"pvRatesRating",
"displayName":"PV Rates Rating",
"family":"billing",
"keyspace":"electricity",
"description":"Rating of the pv rate ($/kWh) paid by a typical customer in the area.",
"dataType":"CHOICE",
"quantityUnit":"",
"lookbackPeriod":"",
"privacy":"PUBLIC",
"choices":[
{
"displayValue":"Low",
"value":"1",
"dataValue":"1",
"likelihood":null
},
{
"displayValue":"Moderate",
"value":"2",
"dataValue":"2",
"likelihood":null
},
{
"displayValue":"High",
"value":"3",
"dataValue":"3",
"likelihood":null
},
{
"displayValue":"Very High",
"value":"4",
"dataValue":"4",
"likelihood":null
}
]
},
"min":0.120000,
"max":0.150000,
"description":"Moderate"
},
"pre":{
"usageKWh":8098.798817,
"usageKW":2.370252,
"costFixed":-54.552710,
"costDemand":0.000000,
"costConsumption":0.000000,
"costMin":53.934619,
"costTotal":1892.575182
},
"post":{
"usageKWh":1611.903871,
"usageKW":2.177673,
"costFixed":-54.552710,
"costDemand":0.000000,
"costConsumption":0.000000,
"costMin":53.934619,
"costTotal":221.597026
},
"utilitySavings":{
"usageKWh":6486.894946,
"usageKW":0.192579,
"costFixed":0.000000,
"costDemand":0.000000,
"costConsumption":0.000000,
"costTotal":1670.978156
},
"netSavings":{
"usageKWh":0.000000,
"usageKW":0.000000,
"costFixed":0.000000,
"costDemand":0.000000,
"costConsumption":0.000000,
"costTotal":697.943570
},
"utilitySavingsRank":810,
"netSavingsRank":15,
"housingStock":{
"singleFamilyDetached":74967,
"singleFamilyAttached":6431,
"apartmentUnder5Units":29111,
"apartmentOver4Units":55499,
"mobileHome":464,
"totalHousingUnits":166554
}
}
],
"sEcho":null,
"iTotalRecords":1,
"iTotalDisplayRecords":1,
"pageCount":25,
"pageStart":0
}
Get Cost Savings
Returns a break out of cost savings by scenario matching the supplied criteria.
Resource URI
GET /rest/alpha/open/costSavings
Request Parameters
| Name | Type | Description |
|---|---|---|
| cityKey | Long | Will match costSavings to a particular city key. The CityKey is returned in the Get Region Savings call. (Optional) |
| addressString | String | An address of any kind. Ideally this will contain a zipcode or post code. (Optional) |
| zipCode | String | An alternate to using addressString. Make sure its just the ZIP code though. (Optional) |
Example
GET /rest/alpha/open/costSavings?cityKey=2457
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
"regionType":"utilityClimateZone",
"calcType":"TTM",
"buildingType":"RESIDENTIAL",
"usageType":"Average customer usage, 80% solar offset.",
"pre":{
"usageKWh":6748.000000,
"usageKW":1.980000,
"costFixed":-54.580000,
"costDemand":0.000000,
"costConsumption":1483.392464,
"costOther":0.000000,
"costMin":53.961600,
"costTotal":1428.810000
},
"post":{
"usageKWh":1343.050000,
"usageKW":1.820000,
"costFixed":-54.580000,
"costDemand":0.000000,
"costConsumption":212.958067,
"costOther":0.000000,
"costMin":53.961600,
"costTotal":158.378067
},
"utilitySavings":{
"usageKWh":5404.950000,
"usageKW":0.160000,
"costFixed":0.000000,
"costDemand":0.000000,
"costConsumption":1270.434397,
"costOther":0.000000,
"costTotal":1270.431933
},
"netSavings":{
"usageKWh":0.000000,
"usageKW":0.000000,
"costFixed":0.000000,
"costDemand":0.000000,
"costConsumption":459.692251,
"costOther":0.000000,
"costTotal":459.689787
}
}
History
- Initial Release - 6/9/2015