Open Savings API

Overview

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.

Operations

Get Region Savings

Returns a list of regions savings matching the supplied criteria. For a specifc 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
{
   "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=94619
{  
                "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