Security

Pelm

Schedule Demo

Contact

Unit Codes

Welcome

Getting Started

Core Concepts

Connect Guide

Supported Utilities

If you aren't ready to use real data yet or don't have a utility account available with which to test, you can test Pelm using the Sandbox User.

Sandbox User

Pelm uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success and codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, an address is invalid, etc.). Codes in the 5xx range indicate an error with Pelm's servers.

Errors

Create Access Token

Create a Connect token using client credentials in order to initiate the Connect flow.

Create Connect token

Get User

Revoke your authorization to this `User`'s data and delete their data from Pelm. You won't be charged for making this request.

Delete User

Get a list of `Account` objects that are tied to a given `User`.

Get Accounts

Get a list of interval objects corresponding to energy usage and greenhouse gas emissions for a given `Account` in a specific time range. Emissions data is currently only available for PG&E, SCE, SDG&E, SoCalGas, and LADWP.

Get Usage Intervals

Get all `Bill`s for the given `User`, ordered by `statement_date` descending.

Get Bills

Returns the pdf of a bill with specified `bill_id` as a file.

Get Bill PDF

Get emission rate intervals for a given utility.

measurement	unit
Electricity usage	kWh
Gas usage	therm
CO2 emissions	kg CO2e
CO2 emissions rate	kg CO2e / kWh

Home

Guides

Reference

API Reference

Unit Codes