API Docs

Quickstart

Set-up a meter to earn grid services revenues on the Leap platform

Before Getting Started: Review Initial Setup to obtain credentials and connect to the appropriate environment.

Collect a Meter Authorization

Use a Registration Link to authorize participation of an end customer.

Registration links enable your customers to authorize their participation in a Leap grid services program. A registration link can be generated using Leap's Portal, or by manipulating the URL parameters listed below.

https://www.addleap.com/<org-name>/<utility-id>/getting-started?ref-id=<ref-id>

Complete Registration and Await Data Sharing

Render the web page in a browser. Enter utility credentials and approve the authorization. Leap does not store customer credentials.

Note: Utilities can take 1-3 days to process new authorizations. Once processed, the meter will appear in the /meters API and Leap Portal. If you're new to Leap, use the Meters created in the staging environment in the steps below.

Get Meter Details

Collect a list of meters and their metadata by sending a POST request to /meters/search.

Each meter contains metadata about the customer, location, site, and billing account. Copy the meter_id of a specific meter, and save it in an environment variable for future steps. 💾

{
"meter_id": "261ww30e-x41f-483a-b245-b2da23619949",
"partner_reference": "521d3as5w1x",
"transmission_region": "CAISO",
"utility": "SCE",
...
}

Submit Bids

Bids represent a meter's strike price over a time period. Use bids to define the amount of power (in kilowatts) that a meter is willing to provide for a given price (in $/kWh).

Standing bids are bid schedules for a meter over a lengthy period. They enable repeat use of the same bid over time. Submit a standing bid by sending a POST request to /bidding/standing_bid

{
"standing_bids": [
{
"meter_id": "261ww30e-x41f-483a-b245-b2da23619949",
"start_time": "2021-05-30T18:00:00Z",
"end_time": "2021-07-01T18:00:00Z",
"day_type": "business",
"hours": [
{
"hour_ending": 17,
"curve": [
{
"quantity_in_kw": 5,
"price": 0.7
},
{
"quantity_in_kw": 50,
"price": 0.95
}
]
},
{
"hour_ending": 18,
"curve": [
{
"quantity_in_kw": 9,
"price": 0.9
},
{
"quantity_in_kw": 75,
"price": 0.95
}
]
}
]
}
]
}

This bid configures meter_id: 261ww30e-x41f-483a-b245-b2da23619949 on business days between May 30 2021 and July 01 2021 to offer:

  • From 4-5pm PT: 5 kW for $0.70/kWh and 50 kW for $0.95/kWh
  • From 5-6pm PT: 9 kW for $0.90/kWh and 75 kW for $0.95/kWh

Receive Dispatches

Dispatches are discrete requests for grid services. Setup a Webhook URL to receive dispatch notifications as soon as they are available.

Set a Webhook URL

Send a PUT request to /bidding/dispatch/webhook.

If you don't have a URL for an internal server, use a free tool like webhook.site or Mockbin for testing.

Create a Test Notification

Use Leap's testing endpoint to simulate the different types of dispatches you could receive.

To create a custom test notification that is delivered to your Webhook URL, send a POST request to /bidding/dispatch/webhook/test_url.

{
"meter_id": "261ww30e-x41f-483a-b245-b2da23619949",
"timeslot": {
"start_time": "2021-05-25T22:00:00Z",
"end_time": "2021-05-25T23:00:00Z",
"energy_kw": "1000",
"test_event": true,
"market_type": "day-ahead"
}
}

The notification will arrive immediately as an HTTP request at your URL.

Congratulations!

You've completed the core steps to working with Leap's API. Continue reading for deeper guides to each section and workflow.