Partner-Created Meters
Beta
The Create Meters set of API endpoints are currently in beta. While not anticipated, it is possible that some changes could be made prior to general release.
For regions and programs that do not require customers to authorize utility data sharing, partners can directly create meters on the Leap platform using the Create Meters API described in this guide or by CSV upload in the Partner Portal.
The Create Meters endpoint supports the following use cases:
- As part of your customer enrollment workflow, trigger a meter to be created for desired program(s) as soon as customer agrees to participate
- Create meters in bulk for desired program(s)
- Create meters in bulk and let Leap determine which meters may be eligible for which programs
Global Required Fields
The following fields are required to be included in the request body in order for a meter to be created. Failure to include one or more of these will result in a 400 error with the response body indicating which fields are missing.
| Field Name | Description |
|---|---|
partner_reference | Unique ID that partner uses to identify this device (e.g. serial number) or utility meter (e.g. customer or site ID) |
transmission_region | Choose the ISO or geographic region this asset is part of |
customer_classification | Choose residential vs. commercial |
load_types | Choose one or more load types that are being controlled for demand response purposes |
meter_type | Choose device vs. utility meter vs. submeter |
street_1, postal_code, city, state_or_province_code, country_code | Address where customer asset resides |
Program Required Fields
Most programs require additional fields to be provided in order to meet eligibility requirements. If you know the program(s) that you want to enroll these meters into, you need to include these program-specific required fields as well.
It is also recommended to include optional fields since these additional parameters can help Leap quickly resolve issues or address questions from program operators without requiring additional data requests causing delays in the enrollment process.
Check out the following Knowledge Center articles for a list of required & optional fields:
- California DSGS fields
- New England fields (Clean Peak Standard & Connected Solutions)
- New York SCR fields
- Most partners will use Leap Connect to have customer-authorized meters created but in select cases, partners can directly create meters through this endpoint
Global vs. Program Required Fields
Only globally required fields are indicated as
requiredin the API reference file. Additional program-specific required fields are not marked as required but still need to be added if you want the meter(s) to be enrolled in those programs.
Creating and Verifying New Meters
Use the following endpoints to create meters, save the new Leap meter IDs in your internal systems, and check meter enrollment status:
- Create meters individually or in bulk via JSON or CSV input.
JSON input is detailed in the API reference file. For CSV input, use the
Content-Type: text/csvheader and include the CSV data as raw text in the POST body.
-
Use the get meters job status endpoint to query the job ID provided in the response body of step 1
If all global required fields were included, the resulting meter ID will be provided for each
partner_referenceID. If a meter was not created, the failure reason will be provided. -
Optionally call the get meter endpoint for your new meter ID to track the meter enrollment status or poll the search meters endpoint to track the statuses of all meters.
Changing or adding fields to an already created meter is not yet supported and will be coming soon. Until then, reach out to your account manager or [email protected] for assistance in updating these fields.
Updated 17 days ago