v1

latestOpenAPI 3.0.22026-07-141713124.8 KB
Offers

Offers

get/offers

Query parameters

wattkeystring

Our identifier for this home

addressstring

The street address of the property

citystring

City of the property

statestring

State of the property as a two letter code (e.g. "TX")

zipstring required

5-digit zip code of the property

language'en' | 'es'

Language code to be used for offer URLs. Supported languages are English (en) and Spanish (es).

is_rentertrue | false
utility_eidnumber

EID of Utility which is getting in electricity info API

category'electricity_plans' | 'rooftop_solar' | 'smart_plugs' | 'community_solar' | 'demand_response' | 'smart_thermostat' | 'light_bulbs' | 'ev_chargers' | 'heat_pump' | 'heat_pump_water_heater'

The category of offers to return. All offers will be returned if category is not provided.

alltrue | false

If true will return all the electricity_plans, Otherwise, will return only recommended plans

Response

All available offers

statusstring
wattkeystring

Example response

{
  "status": "ok"
}