Leap Meter Details API
Retrieve and search meter details — customer, utility, site and device information — for the meters in a partner portfolio. Meters are the basic unit of inventory providing grid services.
OpenAPI Specification
openapi: 3.0.2
info:
description: "Get details about a meter such as customer, utility, site, and device\
\ information."
title: Get meter detail
version: "2"
servers:
- description: Leap staging API
url: https://api.staging.leap.energy
- description: Leap production API
url: https://api.leap.energy
security:
- Bearer: []
tags:
- name: Meter Details
paths:
/v2/meters/{meter_id}:
get:
description: "Get details about a meter such as customer, utility, site, and\
\ device information."
operationId: getMeterDetails
parameters:
- description: Meter ID
in: path
name: meter_id
required: true
schema:
example: 11111111-1111-1111-1111-111111111111
format: uuid
type: string
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/MeterDetailsResponse"
description: OK
"400":
content:
application/json:
examples:
Meter id is not a UUID:
value:
title: Meter id is not a UUID
status: 400
details:
meter_id: abcdef
schema:
$ref: "#/components/schemas/ErrorResponse"
description: The request is not valid
"401":
content:
application/json:
examples:
Unauthorized:
value:
title: Unauthorized
status: 401
details: {}
schema:
$ref: "#/components/schemas/ErrorResponse"
description: You are not authorized to perform this operation.
"403":
content:
application/json:
examples:
Forbidden:
value:
title: You do not have the necessary permissions for this operation
status: 403
details: {}
schema:
$ref: "#/components/schemas/ErrorResponse"
description: You do not have the necessary permissions for this operation.
"404":
content:
application/json:
examples:
Meter not found:
value:
title: Meter not found
status: 404
details:
meter_id: f5c5e328-e325-4d6d-b357-5015ed5962a7
schema:
$ref: "#/components/schemas/ErrorResponse"
description: Meter not found
"500":
content:
application/json:
examples:
Internal Error:
value: An error happened whilst processing your request
schema:
type: string
description: Internal server error
summary: Get meter details
tags:
- Meter Details
/v2/meters/search:
post:
description: "Retrieve meter details, such as customer, utility, site, and device\
\ information for all meters. Optionally filter by one or more request parameters."
operationId: searchMeterDetails
requestBody:
content:
application/json:
examples:
all fields:
$ref: "#/components/examples/AllFields"
default:
$ref: "#/components/examples/Default"
paging:
$ref: "#/components/examples/Paging"
meter ids:
$ref: "#/components/examples/MeterIds"
active meters:
$ref: "#/components/examples/ActiveMeters"
last modified:
$ref: "#/components/examples/LastModified"
connection ref:
$ref: "#/components/examples/ConnectionRef"
schema:
$ref: "#/components/schemas/MeterFilterRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/ListMeterDetailsResponse"
description: Successful response with a list of meters that match the search
criteria.
"400":
content:
application/json:
examples:
Meter id is not a UUID:
value:
title: Meter id is not a UUID
status: 400
details:
meter_id: abcdef
schema:
$ref: "#/components/schemas/ErrorResponse"
description: The request is not valid
"401":
content:
application/json:
examples:
Unauthorized:
value:
title: Unauthorized
status: 401
details: {}
schema:
$ref: "#/components/schemas/ErrorResponse"
description: You are not authorized to perform this operation.
"403":
content:
application/json:
examples:
Forbidden:
value:
title: You do not have the necessary permissions for this operation
status: 403
details: {}
schema:
$ref: "#/components/schemas/ErrorResponse"
description: You do not have the necessary permissions for this operation.
"404":
content:
application/json:
examples:
Meter not found:
value:
title: Meter not found
status: 404
details:
meter_id: f5c5e328-e325-4d6d-b357-5015ed5962a7
schema:
$ref: "#/components/schemas/ErrorResponse"
description: Meter not found
"500":
content:
application/json:
examples:
Internal Error:
value: An error happened whilst processing your request
schema:
type: string
description: Internal server error
summary: Search meter details
tags:
- Meter Details
components:
examples:
AllFields:
value:
transmission_region: CAISO
customer_classification: RESIDENTIAL
meter_ids:
- 3fa85f64-5717-4562-b3fc-2c963f66afa6
partner_references:
- a-partner-reference
global_enrollment_statuses:
- ACTIVE
meter_types:
- UTILITY_METER
load_types:
- HVAC
customer_groups:
- CustomerGroup1
tags:
- tag1
last_modified_date_time: 2024-10-21T11:43:05.892Z
created_after_date_time: 2024-10-21T11:43:05.892Z
created_before_date_time: 2024-10-21T11:43:05.892Z
partner_action_required: false
exclude_archived: false
connection_reference_ids:
- connectionReferenceId1
Default:
value:
page_size: 500
Paging:
value:
page_token: INSERT PAGE TOKEN FROM PREVIOUS RESPONSE
page_size: 100
MeterIds:
value:
meter_ids:
- 3fa85f64-5717-4562-b3fc-2c963f66afa1
- 3fa85f64-5717-4562-b3fc-2c963f66afa2
- 3fa85f64-5717-4562-b3fc-2c963f66afa3
- 3fa85f64-5717-4562-b3fc-2c963f66afa4
ActiveMeters:
value:
global_enrollment_statuses:
- ACTIVE
LastModified:
value:
last_modified_date_time: 2024-10-21T11:43:05.892Z
created_after_date_time: 2024-10-21T11:43:05.892Z
created_before_date_time: 2024-10-21T11:43:05.892Z
ConnectionRef:
value:
connection_reference_ids:
- connectionReferenceId1
parameters:
PathMeterId:
description: Meter ID
in: path
name: meter_id
required: true
schema:
example: 11111111-1111-1111-1111-111111111111
format: uuid
type: string
responses:
"400":
content:
application/json:
examples:
Meter id is not a UUID:
value:
title: Meter id is not a UUID
status: 400
details:
meter_id: abcdef
schema:
$ref: "#/components/schemas/ErrorResponse"
description: The request is not valid
"401":
content:
application/json:
examples:
Unauthorized:
value:
title: Unauthorized
status: 401
details: {}
schema:
$ref: "#/components/schemas/ErrorResponse"
description: You are not authorized to perform this operation.
"403":
content:
application/json:
examples:
Forbidden:
value:
title: You do not have the necessary permissions for this operation
status: 403
details: {}
schema:
$ref: "#/components/schemas/ErrorResponse"
description: You do not have the necessary permissions for this operation.
"404":
content:
application/json:
examples:
Meter not found:
value:
title: Meter not found
status: 404
details:
meter_id: f5c5e328-e325-4d6d-b357-5015ed5962a7
schema:
$ref: "#/components/schemas/ErrorResponse"
description: Meter not found
"500":
content:
application/json:
examples:
Internal Error:
value: An error happened whilst processing your request
schema:
type: string
description: Internal server error
schemas:
MeterDetailsResponse:
allOf:
- $ref: "#/components/schemas/MeterIdentifiers"
- $ref: "#/components/schemas/CommonMeter"
- $ref: "#/components/schemas/ReadUtility"
- $ref: "#/components/schemas/AuditInfo"
description: "Details about a meter such as customer, utility, site, and device\
\ information."
example:
meter_id: 11111111-1111-1111-1111-111111111111
partner_reference: unique-reference-id-12345
transmission_region: CAISO
customer_classification: RESIDENTIAL
load_types:
- HVAC
meter_type: UTILITY_METER
connection_references:
- connection-reference-id-1
- connection-reference-id-1
customer_group: customer_group
tags:
- tags
- tags
is_archived: true
customer:
street_1: 132 My Street
street_2: Apartment 32
postal_code: "10001"
city: New York
state_or_province_code: NY
country_code: US
end_customer_name: Customer Name
end_customer_title: Mrs.
end_customer_email: email@address.com
end_customer_phone_number: (123) 123-4567
end_customer_company_name: Company Name Inc.
partner_offering_name: Offering Name
partner_offering_date: 2000-01-23
is_in_wholesale_capacity_market: true
dispatch_option: DAILY
billing:
street_1: 132 My Billing Street
street_2: Apartment 32
postal_code: "90210"
city: Los Angeles
state_or_province_code: CA
country_code: US
partner_customer_reference: partner-customer-reference-1
device:
device_type: BATTERY
device_serial_number: device-serial-number
device_model: device-model
device_manufacturer: device-manufacturer
install_date: 2000-01-23
battery_power_capacity_kw: 1.233
battery_energy_capacity_kwh: 9.876
battery_duration_hours: 4
permission_to_operate_date: 2000-01-23
site:
load_zone: load-zone
number_of_devices: 1
on_site_fossil_generator: true
renewable_generator: true
generator_capacity_kw: 1.234
generator_model_year: 2020
generator_manufacturer: Manufacturer of the generator
generator_fuel_type: ""
generator_serial_number: generator-serial-number
site_devices:
- device_type: BATTERY
model: device-model
manufacturer: device-manufacturer
serial_number: device-serial-number
energy_capacity_kwh: 39.504
power_capacity_kw: 9.876
energy_capacity_duration_hours: 4
voltage_level: EVSE_LEVEL_1
model_year: 2020
fuel_type: DIESEL
max_energy_production_rate_kw: 7.5
max_energy_consumption_rate_kw: 7.5
battery_max_state_of_charge_percentage: 95
battery_min_state_of_charge_percentage: 10
installer: Acme Installations Inc.
pv_connected: true
- device_type: BATTERY
model: device-model
manufacturer: device-manufacturer
serial_number: device-serial-number
energy_capacity_kwh: 39.504
power_capacity_kw: 9.876
energy_capacity_duration_hours: 4
voltage_level: EVSE_LEVEL_1
model_year: 2020
fuel_type: DIESEL
max_energy_production_rate_kw: 7.5
max_energy_consumption_rate_kw: 7.5
battery_max_state_of_charge_percentage: 95
battery_min_state_of_charge_percentage: 10
installer: Acme Installations Inc.
pv_connected: true
caiso:
is_receiving_sgip_funding: true
nem_type: NEM2
isone:
in_connected_solutions: true
nyiso:
cbl_method: AVERAGE_DAY
company_type: INDIVIDUAL_OR_SOLE_PROPRIETOR
existing_nyiso_resource_id: "666266"
partner_nyiso_resource_name: "666266"
utility:
utility_name: PGE
load_serving_entity: PGE
electric_service_account_number: 12243243-121
tariff: tariff code
voltage: '>= 600 V'
utility_meter_serial_number: utility-meter-serial-number
bill_service_agreement_number: bill_service_agreement_number
bill_customer_account_number: bill_customer_account_number
audit:
created_by: PARTNER
created_at: 2000-01-23T04:56:07.000+00:00
updated_at: 2000-01-23T04:56:07.000+00:00
required:
- audit
- meter_id
type: object
ListMeterDetailsResponse:
description: Response object for the retrieval of a list of meters.
example:
next_page_token: next_page_token
meters:
- meter_id: 11111111-1111-1111-1111-111111111111
partner_reference: unique-reference-id-12345
transmission_region: CAISO
customer_classification: RESIDENTIAL
load_types:
- HVAC
meter_type: UTILITY_METER
connection_references:
- connection-reference-id-1
- connection-reference-id-1
customer_group: customer_group
tags:
- tags
- tags
is_archived: true
customer:
street_1: 132 My Street
street_2: Apartment 32
postal_code: "10001"
city: New York
state_or_province_code: NY
country_code: US
end_customer_name: Customer Name
end_customer_title: Mrs.
end_customer_email: email@address.com
end_customer_phone_number: (123) 123-4567
end_customer_company_name: Company Name Inc.
partner_offering_name: Offering Name
partner_offering_date: 2000-01-23
is_in_wholesale_capacity_market: true
dispatch_option: DAILY
billing:
street_1: 132 My Billing Street
street_2: Apartment 32
postal_code: "90210"
city: Los Angeles
state_or_province_code: CA
country_code: US
partner_customer_reference: partner-customer-reference-1
device:
device_type: BATTERY
device_serial_number: device-serial-number
device_model: device-model
device_manufacturer: device-manufacturer
install_date: 2000-01-23
battery_power_capacity_kw: 1.233
battery_energy_capacity_kwh: 9.876
battery_duration_hours: 4
permission_to_operate_date: 2000-01-23
site:
load_zone: load-zone
number_of_devices: 1
on_site_fossil_generator: true
renewable_generator: true
generator_capacity_kw: 1.234
generator_model_year: 2020
generator_manufacturer: Manufacturer of the generator
generator_fuel_type: ""
generator_serial_number: generator-serial-number
site_devices:
- device_type: BATTERY
model: device-model
manufacturer: device-manufacturer
serial_number: device-serial-number
energy_capacity_kwh: 39.504
power_capacity_kw: 9.876
energy_capacity_duration_hours: 4
voltage_level: EVSE_LEVEL_1
model_year: 2020
fuel_type: DIESEL
max_energy_production_rate_kw: 7.5
max_energy_consumption_rate_kw: 7.5
battery_max_state_of_charge_percentage: 95
battery_min_state_of_charge_percentage: 10
installer: Acme Installations Inc.
pv_connected: true
- device_type: BATTERY
model: device-model
manufacturer: device-manufacturer
serial_number: device-serial-number
energy_capacity_kwh: 39.504
power_capacity_kw: 9.876
energy_capacity_duration_hours: 4
voltage_level: EVSE_LEVEL_1
model_year: 2020
fuel_type: DIESEL
max_energy_production_rate_kw: 7.5
max_energy_consumption_rate_kw: 7.5
battery_max_state_of_charge_percentage: 95
battery_min_state_of_charge_percentage: 10
installer: Acme Installations Inc.
pv_connected: true
caiso:
is_receiving_sgip_funding: true
nem_type: NEM2
isone:
in_connected_solutions: true
nyiso:
cbl_method: AVERAGE_DAY
company_type: INDIVIDUAL_OR_SOLE_PROPRIETOR
existing_nyiso_resource_id: "666266"
partner_nyiso_resource_name: "666266"
utility:
utility_name: PGE
load_serving_entity: PGE
electric_service_account_number: 12243243-121
tariff: tariff code
voltage: '>= 600 V'
utility_meter_serial_number: utility-meter-serial-number
bill_service_agreement_number: bill_service_agreement_number
bill_customer_account_number: bill_customer_account_number
audit:
created_by: PARTNER
created_at: 2000-01-23T04:56:07.000+00:00
updated_at: 2000-01-23T04:56:07.000+00:00
- meter_id: 11111111-1111-1111-1111-111111111111
partner_reference: unique-reference-id-12345
transmission_region: CAISO
customer_classification: RESIDENTIAL
load_types:
- HVAC
meter_type: UTILITY_METER
connection_references:
- connection-reference-id-1
- connection-reference-id-1
customer_group: customer_group
tags:
- tags
- tags
is_archived: true
customer:
street_1: 132 My Street
street_2: Apartment 32
postal_code: "10001"
city: New York
state_or_province_code: NY
country_code: US
end_customer_name: Customer Name
end_customer_title: Mrs.
end_customer_email: email@address.com
end_customer_phone_number: (123) 123-4567
end_customer_company_name: Company Name Inc.
partner_offering_name: Offering Name
partner_offering_date: 2000-01-23
is_in_wholesale_capacity_market: true
dispatch_option: DAILY
billing:
street_1: 132 My Billing Street
street_2: Apartment 32
postal_code: "90210"
city: Los Angeles
state_or_province_code: CA
country_code: US
partner_customer_reference: partner-customer-reference-1
device:
device_type: BATTERY
device_serial_number: device-serial-number
device_model: device-model
device_manufacturer: device-manufacturer
install_date: 2000-01-23
battery_power_capacity_kw: 1.233
battery_energy_capacity_kwh: 9.876
battery_duration_hours: 4
permission_to_operate_date: 2000-01-23
site:
load_zone: load-zone
number_of_devices: 1
on_site_fossil_generator: true
renewable_generator: true
generator_capacity_kw: 1.234
generator_model_year: 2020
generator_manufacturer: Manufacturer of the generator
generator_fuel_type: ""
generator_serial_number: generator-serial-number
site_devices:
- device_type: BATTERY
model: device-model
manufacturer: device-manufacturer
serial_number: device-serial-number
energy_capacity_kwh: 39.504
power_capacity_kw: 9.876
energy_capacity_duration_hours: 4
voltage_level: EVSE_LEVEL_1
model_year: 2020
fuel_type: DIESEL
max_energy_production_rate_kw: 7.5
max_energy_consumption_rate_kw: 7.5
battery_max_state_of_charge_percentage: 95
battery_min_state_of_charge_percentage: 10
installer: Acme Installations Inc.
pv_connected: true
- device_type: BATTERY
model: device-model
manufacturer: device-manufacturer
serial_number: device-serial-number
energy_capacity_kwh: 39.504
power_capacity_kw: 9.876
energy_capacity_duration_hours: 4
voltage_level: EVSE_LEVEL_1
model_year: 2020
fuel_type: DIESEL
max_energy_production_rate_kw: 7.5
max_energy_consumption_rate_kw: 7.5
battery_max_state_of_charge_percentage: 95
battery_min_state_of_charge_percentage: 10
installer: Acme Installations Inc.
pv_connected: true
caiso:
is_receiving_sgip_funding: true
nem_type: NEM2
isone:
in_connected_solutions: true
nyiso:
cbl_method: AVERAGE_DAY
company_type: INDIVIDUAL_OR_SOLE_PROPRIETOR
existing_nyiso_resource_id: "666266"
partner_nyiso_resource_name: "666266"
utility:
utility_name: PGE
load_serving_entity: PGE
electric_service_account_number: 12243243-121
tariff: tariff code
voltage: '>= 600 V'
utility_meter_serial_number: utility-meter-serial-number
bill_service_agreement_number: bill_service_agreement_number
bill_customer_account_number: bill_customer_account_number
audit:
created_by: PARTNER
created_at: 2000-01-23T04:56:07.000+00:00
updated_at: 2000-01-23T04:56:07.000+00:00
properties:
next_page_token:
description: "If there are more meters to fetch, this token will be populated.\
\ Use it to fetch the next page of provisional assets."
type: string
meters:
items:
$ref: "#/components/schemas/MeterDetailsResponse"
type: array
required:
- meters
type: object
ErrorResponse:
example:
title: Bad Request
status: 400
details:
error: Meter id is not a UUID
properties:
title:
description: Summary of what went wrong
example: Bad Request
maxLength: 2000
minLength: 1
type: string
status:
description: "An error code indicating what went wrong, usually the same\
\ as the HTTP Status Code"
example: 400
type: integer
details:
description: Extra information about the error.
example:
error: Meter id is not a UUID
type: object
type: object
MeterFilterRequest:
example:
page_token: page_token
page_size: 100
transmission_region: CAISO
customer_classification: RESIDENTIAL
meter_ids:
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
partner_references:
- a-partner-reference
global_enrollment_statuses:
- ACTIVE
- ACTIVE
- ACTIVE
- ACTIVE
- ACTIVE
meter_types:
- UTILITY_METER
- UTILITY_METER
- UTILITY_METER
- UTILITY_METER
- UTILITY_METER
load_types:
- HVAC
- HVAC
- HVAC
- HVAC
- HVAC
customer_groups:
- CustomerGroup1
tags:
- tag1
last_modified_date_time: 2024-01-01T00:00:11Z
created_after_date_time: 2024-02-01T00:00:22Z
created_before_date_time: 2024-03-01T00:00:33Z
partner_action_required: false
exclude_archived: false
connection_reference_ids:
- connectionReferenceId1
action_type:
- IS_AUTHORIZED
- IS_AUTHORIZED
- IS_AUTHORIZED
- IS_AUTHORIZED
- IS_AUTHORIZED
properties:
page_token:
description: "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."
type: string
page_size:
default: 500
description: Amount of results to return. Defaults to 500.
example: 100
format: int32
maximum: 500
minimum: 1
type: integer
transmission_region:
$ref: "#/components/schemas/transmission_region"
customer_classification:
$ref: "#/components/schemas/CustomerClassification"
meter_ids:
description: Meter ID
items:
format: uuid
type: string
maxItems: 1000
minItems: 0
type: array
uniqueItems: true
partner_references:
description: Filter meters with a partner reference that is included in
this list.
example:
- a-partner-reference
items:
allOf:
- $ref: "#/components/schemas/PartnerReference"
example: a-partner-reference
type: string
maxItems: 1000
minItems: 1
type: array
uniqueItems: true
global_enrollment_statuses:
description: Filter meters with a `global_enrollment_status` that is included
in this list.
items:
$ref: "#/components/schemas/EnrollmentStatus"
maxItems: 5
minItems: 1
type: array
uniqueItems: true
meter_types:
description: The type of meter
items:
$ref: "#/components/schemas/MeterType"
maxItems: 20
minItems: 1
type: array
uniqueItems: true
load_types:
description: The type of meter
items:
$ref: "#/components/schemas/load_type"
maxItems: 20
minItems: 1
type: array
uniqueItems: true
customer_groups:
description: The customer group associated with the meter.
example:
- CustomerGroup1
items:
type: string
maxItems: 20
minItems: 1
type: array
uniqueItems: true
tags:
description: A tag associated with the meter.
example:
- tag1
items:
type: string
maxItems: 20
minItems: 1
type: array
uniqueItems: true
last_modified_date_time:
description: Find meters that have been modified after this date
example: 2024-01-01T00:00:11Z
format: date-time
type: string
created_after_date_time:
description: Find meters created after this date
example: 2024-02-01T00:00:22Z
format: date-time
type: string
created_before_date_time:
description: Find meters created before this date
example: 2024-03-01T00:00:33Z
format: date-time
type: string
partner_action_required:
default: false
description: "When true, returns only meters that require partner action.\
\ False returns all meters."
type: boolean
exclude_archived:
default: false
description: "When true, archived meters are excluded in the response. By\
\ default they are included."
type: boolean
connection_reference_ids:
description: "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."
example:
- connectionReferenceId1
items:
allOf:
- $ref: "#/components/schemas/PartnerReference"
type: string
maxItems: 100
minItems: 1
type: array
uniqueItems: true
action_type:
description: The type of action required
items:
$ref: "#/components/schemas/action_type"
maxItems: 20
minItems: 1
type: array
uniqueItems: true
type: object
ReadMeter:
allOf:
- $ref: "#/components/schemas/MeterIdentifiers"
- $ref: "#/components/schemas/CommonMeter"
- $ref: "#/components/schemas/ReadUtility"
- $ref: "#/components/schemas/AuditInfo"
description: "Details about a meter such as customer, utility, site, and device\
\ information."
example:
meter_id: 11111111-1111-1111-1111-111111111111
partner_reference: unique-reference-id-12345
transmission_region: CAISO
customer_classification: RESIDENTIAL
load_types:
- HVAC
meter_type: UTILITY_METER
connection_references:
- connection-reference-id-1
- connection-reference-id-1
customer_group: customer_group
tags:
- tags
- tags
is_archived: true
customer:
street_1: 132 My Street
street_2: Apartment 32
postal_code: "10001"
city: New York
state_or_province_code: NY
country_code: US
end_customer_name: Customer Name
end_customer_title: Mrs.
end_customer_email: email@address.com
end_customer_phone_number: (123) 123-4567
end_customer_company_name: Company Name Inc.
partner_offering_name: Offering Name
partner_offering_date: 2000-01-23
is_in_wholesale_capacity_market: true
dispatch_option: DAILY
billing:
street_1: 132 My Billing Street
street_2: Ap
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/leap/refs/heads/main/openapi/leap-meters-openapi-original.yml