v1

latestOpenAPI 3.0.0Apache 2.02026-07-1422655.4 KB
Accounts

Get energy accounts

Get a list of energy account ids that are tied to a given user.

Note that this endpoint was previously named '/users/{user_id}/accounts', which is still live (user_id is the id you submitted for the user that you submitted when you initialized a Connect Token).

get/accounts

Headers

Authorizationstring required

access_token passed as "Bearer {access_token}"

Pelm-Client-Idstring required

Pelm-Client-Id given to a developer when they register

Pelm-Secretstring required

Pelm-Secret given to a developer when they register

Response

Successful operation

idstring
account_numberstring
addressstring
available_meter_typesMeterType[]

The types of meters available for this account. This defines what kind of intervals you can query for this account via /intervals.

usage_unitstring
gas_usage_unitstring

Unit for gas usage. Omitted if account does not have a gas meter. https://pelm.readme.io/reference/unit-codes

ghg_emissions_unitstring

Unit for greenhouse gas emissions. https://pelm.readme.io/reference/unit-codes