Leap Revenue and Analytics API is one of 8 APIs that Leap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Revenue. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
9 operations
across 9 paths,
organized into 2 resource areas,
and defines 90 schemas.
It is described by OpenAPI 3.0.3, at version 1.1.
Requests are made against 2 base URLs: https://api.staging.leap.energy, https://api.leap.energy.
The identity and technical contract details declared by the specification.
PeriodicSearchAggregationRequest
object
Search for aggregations in a specific period. Max allowed period between start and end is 3 months.
8 properties
3 required
SortRequest
object
2 properties
2 required
PeriodicCustomerAggregationResponse
object
2 properties
1 required
PeriodicCustomerAggregation
object
24 properties
8 required
ErrorResponseBadRequest
object
3 properties
3 required
ErrorResponseDetail
object
2 properties
2 required
ErrorResponseUnauthorized
object
3 properties
3 required
ErrorResponseForbidden
object
3 properties
3 required
ErrorResponseUnsupportedMediaType
object
3 properties
3 required
ErrorResponseInternalServerError
object
3 properties
3 required
PeriodicLoadTypeAggregationResponse
object
2 properties
1 required
PeriodicLoadTypeAggregation
object
23 properties
7 required
ExtendedLoadType
string
Load type
PeriodicMarketGroupAggregationResponse
object
2 properties
1 required
PeriodicMarketGroupAggregation
object
24 properties
8 required
PeriodicMeterAggregationResponse
object
2 properties
1 required
PeriodicMeterAggregation
object
36 properties
9 required
PeriodicUtilityAggregationResponse
object
2 properties
1 required
PeriodicUtilityAggregation
object
23 properties
9 required
UtilityCapacityMetrics
object
Capacity metrics for all meters in a given utility's territory. There are 3 subsections: - earnedcapacity: Earned capacity metrics; - fourhourcapacitybonus: Fo…
3 properties
3 required
UtilityCapacityMetric
object
6 properties
3 required
UtilityEnergyMetrics
object
Capacity metrics for all meters in a given utility's territory. There are 2 subsections: - energyearned: Energy earned metrics; - performancebonus: Four-hour c…
2 properties
2 required
UtilityEnergyMetric
object
5 properties
1 required
program_identifier
string
Identifier of program
PeriodicReportResponse
object
20 properties
11 required
CapacityMetrics
object
Capacity details
6 properties
2 required
EnergyMetrics
object
Energy details
4 properties
1 required
SettlementPeriod
object
The period for which the revenue report is generated for.
2 properties
2 required
PeriodicReportStatus
object
7 properties
4 required
CapacityPerformancePeriod
object
The period in which the capacity performance was calculated.
2 properties
PeriodicReportVersionResponse
object
3 properties
3 required
transmission_region
string
Defines the transmission region of the meter
ReportStatusType
string
The report status
YearlyOverview
object
5 properties
5 required
YearlySummary
object
Revenue metrics over a whole year.
8 properties
4 required
RevenueMetrics
object
4 properties
4 required
RevenueSources
object
Revenue split by source.
2 properties
2 required
CapacityRevenueSource
object
Revenue information on partner participation in capacity market.
4 properties
2 required
EnergyRevenueSource
object
Revenue information on partner participation in the energy market.
4 properties
1 required
RegionalEconomics
object
Revenue split by transmission region.
1 property
1 required
RegionRevenue
object
2 properties
2 required
UnitEconomics
object
Unit revenue data.
4 properties
4 required
SettlementReport
object
10 properties
8 required
MissedRevenueByDiagnosis
object
2 properties
SettlementReportStatus
object
2 properties
1 required
MonthlyUnresponsiveMetersRequest
object
12 properties
1 required
MeterProgram
object
2 properties
2 required
MonthlyUnresponsiveMetersResponse
object
4 properties
1 required
UnresponsiveMetersSummary
object
3 properties
UnresponsiveMeter
object
11 properties
6 required
period_start
string
The start of the period for the report in ISO-8601 formatted year and month (YYYY-MM).
period_end
string
The end of the period for the report in ISO 8601 format (YYYY-MM), which is inclusive.
page_token
string
If there are more records to fetch, this token will be populated as nextpagetoken in the response. Use it to fetch the next page. When requesting a CSV format…
page_size
integer
Specifies the number of results to return. Defaults to 100 if not set, with a maximum limit of 1000 per page. When requesting a CSV format via Accept header wi…
version
string
The report version. If not specified the latest version is returned.
SortDirection
string
Sort direction for a field. Can be ASC for ascending or DESC for descending.
meter_count
integer
The number of meters
nomination_w
number
Target quantity set for capacity market.
capacity_revenue
number
Revenue received by the partner for participating in capacity market.
energy_revenue
number
Revenue received by the partner for actively participating in energy programs.
delivery_date
string
ISO-8601 formatted year and month (YYYY-MM) representing the settlement delivery period date.
monetized_w
number
Monetized capacity wattage. Partners provide nomination and then Leap will calculate what capacity can be monetized based on program rules.
total_revenue
number
Total revenue
capacity_performance_percentage
number
Capacity performance percentage
energy_performance_percentage
number
Energy performance percentage
data_coverage_percentage
number
Data coverage percentage
energy_earned_wh
number
Energy earned watt hour
potential_revenue
number
Potential revenue if performance reached 100%.
capacity_earned_w
number
Capacity earned wattage
payment_adjustment
number
A sum of any bonuses, Leap adjustments like missed enrollment, and any adjustment payments if this report has multiple versions (V2, V3, etc.). In NY CSRP and…
penalty
number
The sum of all penalties or market adjustments that are applied to the revenue.
performance_adjustment
number
Any revenue changes applied to Capacity Revenue. Negative values reflect penalties, when capacity performance is below nominations. Positive values reflect agg…
missed_revenue
number
The difference between potential revenue and the actual revenue of the revenue report over the settlement period. Rounded to zero if actual revenue is greater…
capacity_price
number
Capacity price
energy_price_kwh
number
Energy price
load_type
string
The load type of the device
UnassignedLoadType
string
Unassigned load type
market_group
string
The specific market group or category in which the customer participates.
performance_factor
number
The average of the event performance over the month
RevenueType
string
Revenue type reflects how a meter generated revenue.
PerformanceDiagnosis
string
HistoricalResponsiveness
string
Shows the meter?s responsiveness for the last 12 months.
actual_revenue
number
Total of Energy, Capacity and Adjustments for settlement period.
earned_w
number
Quantity curtailed by the partner as part of capacity market.
performance_percentage
number
Partner performance in capacity market; value between 0 and 100.
earned_wh
number
Earned wattage.
awarded_wh
number
Awarded Wh
updated_at
string
ISO-8601 timestamp of the settlement update date
preliminary_revenue
number
The sum or all revenue for reports in a preliminary status.
SettlementType
string
The time period of the revenue report.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Leap publishes across the network.
