Search meter details
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
page_token
string
If there are more meters to fetch, this token will be populated as next_page_token in the response. Use it to fetch the next page.
page_size
int32
1 to 500
Defaults to 500
Amount of results to return. Defaults to 500.
transmission_region
string
enum
Defines the transmission region of the meter
CAISOCAISOERCOTNYISOISONEPJMSERCWECC_SWWECC_PC
Show 8 enum values
customer_classification
string
enum
Whether this is a residential (home) asset or a commercial (business) asset.
RESIDENTIALRESIDENTIALCOMMERCIAL
Allowed:
RESIDENTIAL``COMMERCIAL
meter_ids
array of uuids
length between 0 and 1000
Meter ID
meter_ids ADD uuid
partner_references
array of strings
length between 1 and 1000
Filter meters with a partner reference that is included in this list.
partner_references string
The partner-supplied reference ID to help identify the customer or site that a Leap meter correlates to a partner’s internal systems.
ADD string
global_enrollment_statuses
array of objects
length between 1 and 5
Filter meters with a global_enrollment_status that is included in this list.
ACTIVEELIGIBLEINELIGIBLENOT_PARTICIPATINGPENDING
meter_types
array of objects
length between 1 and 20
The type of meter
UTILITY_METERSUBMETERDEVICE
load_types
array of objects
length between 1 and 20
The type of meter
HVACEV_CHARGINGBATTERY_STORAGECOLD_STORAGEPUMPINGWATER_HEATINGBUILDING_AUTOMATIONGENERATIONMANUFACTURINGLIGHTINGOTHER
customer_groups
array of strings
length between 1 and 20
The customer group associated with the meter.
customer_groups string
ADD string
tags
array of strings
length between 1 and 20
A tag associated with the meter.
tags string
ADD string
last_modified_date_time
date-time
Find meters that have been modified after this date
created_after_date_time
date-time
Find meters created after this date
created_before_date_time
date-time
Find meters created before this date
partner_action_required boolean
Defaults to false
When true, returns only meters that require partner action. False returns all meters.
truefalse
exclude_archived boolean
Defaults to false
When true, archived meters are excluded in the response. By default they are included.
truefalse
connection_reference_ids
array of strings
length between 1 and 100
Filter by a set of connection reference IDs, which are the refIDs supplied during completed Leap Connect authorizations. A meter may have multiple connection reference IDs if multiple people authorized the same meter or a single person authorized a meter multiple times with different reference IDs each time.
connection_reference_ids string
The partner-supplied reference ID to help identify the customer or site that a Leap meter correlates to a partner’s internal systems.
ADD string
action_type
array of objects
length between 1 and 20
The type of action required
IS_AUTHORIZEDDOCUMENTS_SIGNEDHAS_AMINOT_ENROLLED_IN_CONFLICTING_PROGRAMPARTICIPATINGHAS_MARKET_REGISTRATIONNO_MISSING_FIELDGENERATORADDRESSHAS_NOMINATIONSHAS_BIDDING_STRATEGYIS_ELIGIBLEIS_ASSIGNED_TO_A_RESOURCEMEETS_EXTRA_PROGRAM_REQUIREMENTS
`` 200 Successful response with a list of meters that match the search criteria.
object
Response object for the retrieval of a list of meters.
next_page_token
string
If there are more meters to fetch, this token will be populated. Use it to fetch the next page of provisional assets.
meters
array of objects
required
meters*
object
Details about a meter such as customer, utility, site, and device information.
meter_id
uuid
required
The unique identifier for the meter.
partner_reference
string
length between 3 and 256
^[^\/?\]\[{}!#$%^&*()<>|]{3,256}$
The partner-supplied reference ID to help identify the customer or site that a Leap meter correlates to a partner’s internal systems.
transmission_region
string
enum
required
Defines the transmission region of the meter
CAISO``ERCOT``NYISO``ISONE``PJM``SERC``WECC_SW``WECC_PC
customer_classification
string
enum
Whether this is a residential (home) asset or a commercial (business) asset.
RESIDENTIAL``COMMERCIAL
load_types
array of objects
length ≥ 1
The partner-controlled and curtailable assets associated with the meter. Multiple load types per meter are supported.
The load type of the device
HVAC``EV_CHARGING``BATTERY_STORAGE``COLD_STORAGE``PUMPING``WATER_HEATING``BUILDING_AUTOMATION``GENERATION``MANUFACTURING``LIGHTING``OTHER
meter_type
string
enum
required
The type of asset.
UTILITY_METER``SUBMETER``DEVICE
connection_references
array of strings
List of connection reference IDs, which are the refIDs supplied during completed Leap Connect authorizations. A meter may have multiple connection reference IDs if multiple people authorized the same meter or a single person authorized a meter multiple times with different reference IDs each time.
The partner-supplied reference ID to help identify the customer or site that a Leap meter correlates to a partner’s internal systems.
customer_group
string
^[’'+#"@()/&.,;A-Za-z\u00C0-\u024F\u1E00-\u1EFF0-9\s_\-]{0,128}$
The customer group associated with the meter.
tags
array of strings
Tags set by partner or Leap to help group and identify meters
is_archived
boolean
required
Whether the meter is archived
customer
object
required
customer object
device
object
device object
site
object
site object
caiso
object
caiso object
isone
object
isone object
nyiso
object
nyiso object
utility
object
utility object
audit
object
required audit object
`` 400 The request is not valid
`` 401 You are not authorized to perform this operation.
`` 403 You do not have the necessary permissions for this operation.
`` 404 Meter not found
`` 500 Internal server error
Updated about 2 months ago
Base URL
https://api.staging.leap.energy/v2/meters/search
xxxxxxxxxx
curl --request POST \
--url https://api.staging.leap.energy/v2/meters/search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"page_size": 500,
"partner_references": [],
"global_enrollment_statuses": [],
"meter_types": [],
"load_types": [],
"customer_groups": [],
"tags": [],
"partner_action_required": false,
"exclude_archived": false,
"connection_reference_ids": [],
"action_type": []
}
'
xxxxxxxxxx
{
"next_page_token": "next_page_token",
"meters": [\
\
{\
\
"load_types": [\
\
"HVAC"\
\
],\
\
"isone": {\
\
"in_connected_solutions": true\
\
},\
\
"customer_classification": "RESIDENTIAL",\
\
"caiso": {\
\
"is_receiving_sgip_funding": true,\
\
"nem_type": "NEM2"\
\
},\
\
"utility": {\
\
"utility_meter_serial_number": "utility-meter-serial-number",\
\
"load_serving_entity": "PGE",\
\
"utility_name": "PGE",\
\
"electric_service_account_number": "12243243-121",\
\
"tariff": "tariff code",\
\
"bill_service_agreement_number": "bill_service_agreement_number",\
\
"bill_customer_account_number": "bill_customer_account_number",\
\
"voltage": ">= 600 V"\
\
},\
\
"meter_type": "UTILITY_METER",\
\
"transmission_region": "CAISO",\
\
"tags": [\
\
"tags",\
\
"tags"\
\
],\
\
"connection_references": [\
\
"connection-reference-id-1",\
\
"connection-reference-id-1"\
\
],\
\
"site": {\
\
"number_of_devices": 1,\
\
"generator_serial_number": "generator-serial-number",\
\
"load_zone": "load-zone",\
\
"generator_capacity_kw": 1.234,\
\
"renewable_generator": true,\
\
"generator_fuel_type": "",\
\
"generator_manufacturer": "Manufacturer of the generator",\
\
"on_site_fossil_generator": true,\
\
"generator_model_year": 2020,\
\
"site_devices": [\
\
{\
\
"energy_capacity_duration_hours": 4,\
\
"model_year": 2020,\
\
"device_type": null,\
\
"model": "device-model",\
\
"serial_number": "device-serial-number",\
\
"power_capacity_kw": 9.876,\
\
"voltage_level": "EVSE_LEVEL_1",\
\
"fuel_type": "DIESEL",\
\
"manufacturer": "device-manufacturer",\
\
"energy_capacity_kwh": 39.504\
\
},\
\
{\
\
"energy_capacity_duration_hours": 4,\
\
"model_year": 2020,\
\
"device_type": null,\
\
"model": "device-model",\
\
"serial_number": "device-serial-number",\
\
"power_capacity_kw": 9.876,\
\
"voltage_level": "EVSE_LEVEL_1",\
\
"fuel_type": "DIESEL",\
\
"manufacturer": "device-manufacturer",\
\
"energy_capacity_kwh": 39.504\
\
}\
\
]\
\
},\
\
"customer_group": "customer_group",\
\
"is_archived": true,\
\
"partner_reference": "unique-reference-id-12345",\
\
"audit": {\
\
"updated_at": "2000-01-23T04:56:07.000+00:00",\
\
"created_at": "2000-01-23T04:56:07.000+00:00",\
\
"created_by": "PARTNER"\
\
},\
\
"nyiso": {\
\
"company_type": "INDIVIDUAL_OR_SOLE_PROPRIETOR",\
\
"partner_nyiso_resource_name": "666266",\
\
"existing_nyiso_resource_id": "666266",\
\
"cbl_method": "AVERAGE_DAY"\
\
},\
\
"meter_id": "11111111-1111-1111-1111-111111111111",\
\
"device": {\
\
"permission_to_operate_date": "2000-01-23",\
\
"device_model": "device-model",\
\
"device_type": "BATTERY",\
\
"device_serial_number": "device-serial-number",\
\
"battery_duration_hours": 4,\
\
"install_date": "2000-01-23",\
\
"battery_power_capacity_kw": 1.233,\
\
"device_manufacturer": "device-manufacturer",\
\
"battery_energy_capacity_kwh": 9.876\
\
},\
\
"customer": {\
\
"end_customer_email": "email@address.com",\
\
"is_in_wholesale_capacity_market": true,\
\
"end_customer_phone_number": "(123) 123-4567",\
\
"partner_customer_reference": "partner-customer-reference-1",\
\
"city": "New York",\
\
"end_customer_name": "Customer Name",\
\
"partner_offering_name": "Offering Name",\
\
"dispatch_option": "DAILY",\
\
"end_customer_company_name": "Company Name Inc.",\
\
"end_customer_title": "Mrs.",\
\
"billing": {\
\
"country_code": "US",\
\
"street_1": "132 My Billing Street",\
\
"city": "Los Angeles",\
\
"street_2": "Apartment 32",\
\
"postal_code": "90210",\
\
"state_or_province_code": "CA"\
\
},\
\
"country_code": "US",\
\
"street_1": "132 My Street",\
\
"partner_offering_date": "2000-01-23",\
\
"street_2": "Apartment 32",\
\
"postal_code": "10001",\
\
"state_or_province_code": "NY"\
\
}\
\
},\
\
{\
\
"load_types": [\
\
"HVAC"\
\
],\
\
"isone": {\
\
"in_connected_solutions": true\
\
},\
\
"customer_classification": "RESIDENTIAL",\
\
"caiso": {\
\
"is_receiving_sgip_funding": true,\
\
"nem_type": "NEM2"\
\
},\
\
"utility": {\
\
"utility_meter_serial_number": "utility-meter-serial-number",\
\
"load_serving_entity": "PGE",\
\
"utility_name": "PGE",\
\
"electric_service_account_number": "12243243-121",\
\
"tariff": "tariff code",\
\
"bill_service_agreement_number": "bill_service_agreement_number",\
\
"bill_customer_account_number": "bill_customer_account_number",\
\
"voltage": ">= 600 V"\
\
},\
\
"meter_type": "UTILITY_METER",\
\
"transmission_region": "CAISO",\
\
"tags": [\
\
"tags",\
\
"tags"\
\
],\
\
"connection_references": [\
\
"connection-reference-id-1",\
\
"connection-reference-id-1"\
\
],\
\
"site": {\
\
"number_of_devices": 1,\
\
"generator_serial_number": "generator-serial-number",\
\
"load_zone": "load-zone",\
\
"generator_capacity_kw": 1.234,\
\
"renewable_generator": true,\
\
"generator_fuel_type": "",\
\
"generator_manufacturer": "Manufacturer of the generator",\
\
"on_site_fossil_generator": true,\
\
"generator_model_year": 2020,\
\
"site_devices": [\
\
{\
\
"energy_capacity_duration_hours": 4,\
\
"model_year": 2020,\
\
"device_type": null,\
\
"model": "device-model",\
\
"serial_number": "device-serial-number",\
\
"power_capacity_kw": 9.876,\
\
"voltage_level": "EVSE_LEVEL_1",\
\
"fuel_type": "DIESEL",\
\
"manufacturer": "device-manufacturer",\
\
"energy_capacity_kwh": 39.504\
\
},\
\
{\
\
"energy_capacity_duration_hours": 4,\
\
"model_year": 2020,\
\
"device_type": null,\
\
"model": "device-model",\
\
"serial_number": "device-serial-number",\
\
"power_capacity_kw": 9.876,\
\
"voltage_level": "EVSE_LEVEL_1",\
\
"fuel_type": "DIESEL",\
\
"manufacturer": "device-manufacturer",\
\
"energy_capacity_kwh": 39.504\
\
}\
\
]\
\
},\
\
"customer_group": "customer_group",\
\
"is_archived": true,\
\
"partner_reference": "unique-reference-id-12345",\
\
"audit": {\
\
"updated_at": "2000-01-23T04:56:07.000+00:00",\
\
"created_at": "2000-01-23T04:56:07.000+00:00",\
\
"created_by": "PARTNER"\
\
},\
\
"nyiso": {\
\
"company_type": "INDIVIDUAL_OR_SOLE_PROPRIETOR",\
\
"partner_nyiso_resource_name": "666266",\
\
"existing_nyiso_resource_id": "666266",\
\
"cbl_method": "AVERAGE_DAY"\
\
},\
\
"meter_id": "11111111-1111-1111-1111-111111111111",\
\
"device": {\
\
"permission_to_operate_date": "2000-01-23",\
\
"device_model": "device-model",\
\
"device_type": "BATTERY",\
\
"device_serial_number": "device-serial-number",\
\
"battery_duration_hours": 4,\
\
"install_date": "2000-01-23",\
\
"battery_power_capacity_kw": 1.233,\
\
"device_manufacturer": "device-manufacturer",\
\
"battery_energy_capacity_kwh": 9.876\
\
},\
\
"customer": {\
\
"end_customer_email": "email@address.com",\
\
"is_in_wholesale_capacity_market": true,\
\
"end_customer_phone_number": "(123) 123-4567",\
\
"partner_customer_reference": "partner-customer-reference-1",\
\
"city": "New York",\
\
"end_customer_name": "Customer Name",\
\
"partner_offering_name": "Offering Name",\
\
"dispatch_option": "DAILY",\
\
"end_customer_company_name": "Company Name Inc.",\
\
"end_customer_title": "Mrs.",\
\
"billing": {\
\
"country_code": "US",\
\
"street_1": "132 My Billing Street",\
\
"city": "Los Angeles",\
\
"street_2": "Apartment 32",\
\
"postal_code": "90210",\
\
"state_or_province_code": "CA"\
\
},\
\
"country_code": "US",\
\
"street_1": "132 My Street",\
\
"partner_offering_date": "2000-01-23",\
\
"street_2": "Apartment 32",\
\
"postal_code": "10001",\
\
"state_or_province_code": "NY"\
\
}\
\
}\
\
]
}