API Docs

Initial Setup

Complete the steps below before attempting to access the Leap API.

Credentials

Credentials are required for authentication. If you don't have them already, please submit a request to support@leap.energy.

Environments

Leap offers the following API environments and versions:

EnvironmentEndpointversion
Productionhttps://api.leap.acv1.1
Staginghttps://stagingapi.leap.acv1.1

Note: the full endpoint for each environment is endpoint + version, for example: https://api.leap.energy/v1.1 for production.

Leap's staging environment is available for tinkering with features before moving to production.

Account ID

Accounts represent user organizations. account-id is included in the path of most endpoints.

You can treat your organization's account-id as an environment variable, or hardcode account-id in the path of your requests.

https://api.leap.ac/V1.1/account/p2c12ced-62w3-49aa-bq8d-7b4pmmc8b857/meters/search

Authentication request

Test your credentials by sending an auth request. A successful request will return a token that must be used in subsequent calls.

cURL

Execute the command below:

curl --location --request POST 'https://stagingapi.leap.ac/v1.1/login' \
--header 'Content-Type: application/json' \
--data-raw '{
"email":"your@email",
"password":"pwd"

Postman

The Leap API is available as a Postman Collection. Postman is an API client that makes testing endpoint quick and easy.

To get the collection, click Run in Postman in the API Reference. This will clone the collection in your local client.

Note: be sure to update the environment variables to include your credentials, account id, and Staging URL.