API Reference
Log in to see full request history
Query Params
string

Our identifier for this home

string

The street address of the property

string

City of the property

string

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

string
required

5-digit zip code of the property

string
Defaults to en

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

boolean
Defaults to false
number

EID of Utility which is getting in electricity info API

string

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

boolean
Defaults to false

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

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json