HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get LSEs

Return a full or filtered list of Load Serving Entities (LSEs).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

This is from the standard searching and sorting parameters. You can search within one or more of the attributes within the LSE object (see above).

string

Zip or post code where you would like to see a list of LSEs for (e.g. 5 digit ZIP code for USA). Most countries have regional, not national, Utility Service Areas. When populating this field you should also populate country too. (Recommended)

string

Alias for zipCode, you can use either.

string

Use an ISO Country Code when passing in a zipCode or postCode, and set it to the ISO Country Code of your zipCode or postCode since some countries use the same format

ownerships
array of strings

Filter results by the type of ownership structure for the LSE. Values include "INVESTOR", "COOP", "MUNI", but see ownership field above for complete list.

ownerships
serviceTypes
array of strings

Filter results to LSEs that just offer this service type to a customer class. Valid values include "ELECTRICITY" and "SOLAR_PV"

serviceTypes
residentialServiceTypes
array of strings

Filter results to LSEs that just offer this service type to their residential customers. Valid values include "ELECTRICITY" and "SOLAR_PV"

residentialServiceTypes
commercialServiceTypes
array of strings

Filter results to LSEs that just offer this service type to their commercial (business) customers. Valid values include "ELECTRICITY" and "SOLAR_PV"

commercialServiceTypes
industrialServiceTypes
array of strings

Filter results to LSEs that just offer this service type to their industrial customers. Valid values include "ELECTRICITY" and "SOLAR_PV"

industrialServiceTypes
transportationServiceTypes
array of strings

Filter results to LSEs that just offer this service type to their transportation customers. Valid values include "ELECTRICITY" and "SOLAR_PV" (Optional).

transportationServiceTypes
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json