Get meter details

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

meter_id

uuid

required

Meter ID

``200 OK

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

street_1

string

required

length between 1 and 128

^[’'+#"@()/&.,;\sA-Za-zÀ-ɏḀ-ỿ0-9\-]{1,128}$

Physical street this asset is located in. If you need to provide extensions like apartment or unit number, please add those to the 'street2' field.

street_2

string

length between 1 and 128

^[’'+#"@()/&.,;\sA-Za-zÀ-ɏḀ-ỿ0-9\-]{1,128}$

Provide extensions like apartment or unit number here.

postal_code

string

required

^[0-9]{5}(?:-[0-9]{4})?$

Postal code of the location this asset is located in.

city

string

required

length between 1 and 128

^[’'+#"@()/&.,;\sA-Za-zÀ-ɏḀ-ỿ0-9\-]{1,128}$

City this asset is located in.

state_or_province_code

string

required

length between 2 and 2

State or province this asset is located in.

country_code

string

required

length between 2 and 2

Defaults to US

ISO 3166-1 alpha-2 country code of the country this asset is located in.

end_customer_name

string

length between 1 and 128

^(?!.*[�\u00A0\uFFFD?])[,A-Za-zÀ-ɏḀ-ỿ0-9\s]{1,128}$

End customer name or contact name

end_customer_title

string

length between 1 and 15

^[’'+#"@()/&.,;\sA-Za-zÀ-ɏḀ-ỿ0-9\-]{1,128}$

Title of the primary contact for the end customer; only applicable for Commercial & Industrial customers

end_customer_email

string

length between 3 and 128

The customer email address

end_customer_phone_number

string

length between 3 and 32

This would ideally be the phone number on file with the LSE; it may be used by the CEC and/or Utility Distribution Company (UDC) for verification purposes; please do not use any special characters for this column, and do not include a "1" at the front of the phone number.

end_customer_company_name

string

length between 1 and 128

^[’'+#"@()/&.,;\sA-Za-zÀ-ɏḀ-ỿ0-9\-]{1,128}$

Legal company name of the end customer site; only applicable for Commercial & Industrial customers

partner_offering_name

string

length between 1 and 128

The name of Partner's program/offering in which the end-customer enrolled/contracted.

partner_offering_date

date

Date in which the end customer enrolled in Partner's offering

is_in_wholesale_capacity_market

boolean

Forward Capacity Market in ISONE

dispatch_option

string

enum

Dispatch strategy used in ConnectedSolutions.

DAILY``TARGETED

billing

object

Billing address for the customer.

billing object

partner_customer_reference

string

length between 3 and 256

^[^\/\\?\]\[{}!#$%^&*()<>|]{3,256}$

Partner identifier for customer or site. This should match the refId used in Leap Connect when combining customer-supplied data in Leap Connect with partner-supplied data in Create Meters/Meter Uploads.

device

object

device_type

string

enum

Type of device on premise

BATTERY``GENERATOR``EV``EV_CHARGER``BIDIRECTIONAL_EV_CHARGER``SMART_THERMOSTAT``AIR_CONDITIONER``HEAT_PUMP

device_serial_number

string

length between 1 and 256

The serial number of the device

device_model

string

length between 1 and 128

The model of the device

device_manufacturer

string

length between 1 and 128

The manufacturer of the device

install_date

date

Could also be the activation date for the device

battery_power_capacity_kw

number

0 to 999999

The lower value between the inverter maximum output OR the nameplate maximum battery output according to battery specification sheet in kilowatts.

battery_energy_capacity_kwh

number

0 to 999999

Total battery energy capacity according to battery specification sheet in kilowatt-hours.

battery_duration_hours

int32

0 to 100

Leap's default approach will be to determine duration based on Battery Capacity and Battery Energy Capacity, but Leap Partner can recommend an alternative nomination as they see fit. Measured in hours

permission_to_operate_date

date

This data should be found on the Utility or Electric Distribution Company Permission to Operate (PTO) letter that the battery installer received at the conclusion of the interconnection process.

site

object

load_zone

string

length between 1 and 128

Sub region of the transmission region that the meter is located

number_of_devices

int32

0 to 99

Refers to the total number of devices available for dispatch behind this Leap meter. For CA DSGS Option 3, this field is required to indicate if multiple batteries are being stacked behind a single inverter.

on_site_fossil_generator

boolean

Is there a fossil fuel powered generator on site

renewable_generator

boolean

Is there a behind the meter renewable generator on site

generator_capacity_kw

number

0 to 999999

deprecated

Deprecated. Use site_devices.power_capacity_kw for the capacity in kW of the generator on site. generator_model_year

int32

1900 to 2100

deprecated

Deprecated. Use site_devices.model_year for the year in which the generator was manufactured. generator_manufacturer

string

length between 1 and 128

deprecated

Deprecated. Use site_devices.manufacturer for generator manufacturer’s name. generator_fuel_type

string

enum

deprecated

The fuel source for a generator.

DIESEL``NATURAL_GAS``DUAL_FUEL``CO_GEN``ENERGY_STORAGE``OTHER generator_serial_number

string

length between 1 and 256

deprecated

Deprecated. Use site_devices.serial_number for the serial number on the generator.

site_devices

array of objects

length ≥ 0

List of additional information about devices on the premise

site_devices

object

device_type

string

enum

required

Type of device on premise

BATTERY``GENERATOR``EV``EV_CHARGER``BIDIRECTIONAL_EV_CHARGER``SMART_THERMOSTAT``AIR_CONDITIONER``HEAT_PUMP

model

string

length between 1 and 128

The model of the device

manufacturer

string

length between 1 and 128

The manufacturer of the device

serial_number

string

length between 1 and 256

The serial number of the device

energy_capacity_kwh

number

0 to 999999

Total device energy capacity according to device specification sheet in kilowatt-hours. power_capacity_kw

number

0 to 999999

The lower value between the inverter maximum output OR the nameplate maximum device output according to device specification sheet in kilowatts. energy_capacity_duration_hours

int32

0 to 100

voltage_level

string

enum

Device voltage level

EVSE_LEVEL_1``EVSE_LEVEL_2

model_year

int32

1900 to 2100

Year in which the device was manufactured

fuel_type

string

enum

The fuel source for a generator.

DIESEL``NATURAL_GAS``DUAL_FUEL``CO_GEN``ENERGY_STORAGE``OTHER caiso

object

is_receiving_sgip_funding

boolean

Only needed if the battery is installed after June 30, 2023 to verify eligibility for no baseline.

nem_type

string

enum

Is the battery under NEM2 or NEM3 rules

NEM2``NEM3 isone

object

in_connected_solutions

boolean

Is the meter also participating in ConnectedSolutions; used for CPS

nyiso

object

cbl_method

string

enum

Choice of the Customer Baseline Load (CBL) verification methodology that will be used to calculate load reduction.

AVERAGE_DAY``WEATHER_ADJUSTED

company_type

string

enum

Required for customers enrolling in PSEGLI CSRP/DLRP

INDIVIDUAL_OR_SOLE_PROPRIETOR``LIMITED_LIABILITY_COMPANY``PARTNERSHIP``CORPORATION``OTHER``EXEMPT_PAYEE

existing_nyiso_resource_id

string

If the meter has previously been enrolled in SCR, they have had a resource_id assigned to it by NYISO

partner_nyiso_resource_name

string

If the meter has previously been enrolled in SCR, they have had a resource_id assigned to it by partner

utility

object

utility_name

string

enum

The name of the Investor Owned Utility or Publicly Owned Utility whose territory the customer is in.

PGE``SCE``SDGE``SMUD``LADWP``SVP``CECONY``ORU``PSEGLI``NYS``RIE``EVERSOURCE``NATGRID``UNITIL``PPL``CAPELIGHT``SMT``AEP_CENTRAL``AEP_NORTH``NUECES_ELECTRIC``ONCOR``CENTERPOINT``ENTERGY_GULF``SWEPCO``TNMP``DEMO``DEMO2``LEAP_TEST_CAISO``LEAP_TEST_NYISO``COMED``BGE``PECO``METED``PENELEC``PSEG``DOMINION``WESTPENN``PENNPOWER``PEPCO``PJM_DEMO``OTHER``NES``MLGW``KUB``NPU``MTEMC``PRECC``HSVU``SRP``PSE``TVA

load_serving_entity

string

length between 1 and 128

The utility or community choice aggregator that the customer buys electricity from electric_service_account_number

string

length between 1 and 128

This is also known as Service Agreement ID or Service Account Number, depending on utility in CAISO, Electric Account Number in ISO-NE, ESIID in ERCOT, or TO Account Number in NYISO. tariff

string

length between 1 and 128

The tariff or electric rate code can be found on the electric bill. For California DSGS, virtual net energy metering storage assets must indicate 'VNEM'. voltage

string

length between 1 and 128

Transmission Owner voltage service level description (e.g., High tension, Transmission, Primary) or range (e.g., >= 600 V, < 35kV).While this information is required for customers enrolling in NYISO SCR, Leap is usually able to identify the TO service voltage level for the site. utility_meter_serial_number

string

length between 1 and 256

Serial number of the electricity meter

bill_service_agreement_number

string

The Bill Service Agreement Number can be found on the customer’s bills and is the number that the customer would use to interact with the utility. This number may be called a different name by the utility. Use the table below to determine what it’s called and where to find it on the customer’s bill.

bill_customer_account_number

string

The Bill Customer Account Number represents the customer account, which may have multiple service agreements open with the utility.

audit

object

required

created_by

string

enum

Which entity created the meter

PARTNER``LEAP``UTILITY

created_at

date-time

When the meter was created

updated_at

date-time

When the meter was last updated

``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/{meter_id}


xxxxxxxxxx

curl --request GET \

--url https://api.staging.leap.energy/v2/meters/meter_id \

--header 'accept: application/json'

{ "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" } }