Get LSEs

get

https://api.genability.com/rest/public/lses

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Use this endpoint to find utilities and other organizations that sell or deliver electricity. You can search by name or filter by location, ownership type, and supported service types.

Resource URI

GET /rest/public/lses

Query parameters

Parameter	Type	Description
`search`	String	Text to search for, such as part of an LSE name. Optional.
`searchOn`	String	Comma-separated fields to search. Defaults to `name` when `search` is specified. Optional.
`zipCode`	String	ZIP code or postcode where you want to find LSEs. When using this field, also pass `country`. Optional but recommended for location-based searches.
`postCode`	String	Alias for `zipCode`. Optional.
`country`	String	ISO country code for the ZIP code or postcode, such as `US`. Optional.
`ownerships`	Array	Ownership structures to include, such as `INVESTOR`, `COOP`, or `MUNI`. Optional.
`serviceTypes`	Array	Service types offered to any customer class, such as `ELECTRICITY` or `SOLAR_PV`. Optional.
`residentialServiceTypes`	Array	Service types offered to residential customers. Optional.
`commercialServiceTypes`	Array	Service types offered to commercial customers. Optional.
`industrialServiceTypes`	Array	Service types offered to industrial customers. Optional.
`transportationServiceTypes`	Array	Service types offered to transportation customers. Optional.
`fields`	String	Pass `ext` to include extended LSE fields. Optional.

For the full LoadServingEntity data model and examples, see Load Serving Entities.

Example

GET /rest/public/lses?zipCode=94105&country=US&residentialServiceTypes=ELECTRICITY&fields=ext

A successful response returns a standard response payload with type set to LoadServingEntity and results containing matching LSEs.

Query Params

searchOn

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).

zipCode

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)

postCode

string

Alias for zipCode, you can use either.

country

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

Resource URI

Query parameters

Example

200200

400400