Get annual revenue data
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
year
int32
required
The year of the report
transmission_region
string
enum
deprecated
The transmission region to filter the reports by.
CAISOCAISOERCOTNYISOISONEPJMSERCWECC_SWWECC_PC
Show 8 enum values
transmission_regions
array of strings
The transmission regions to filter the reports by.
transmission_regions
Show 8 enum values
ADD string
programs
array of objects
The list of programs, separated by comma.
programs
Show 32 enum values
ADD string
report_statuses
array of objects
The report status to filter the reports by. When left empty, reports with any status are returned.
report_statuses
Allowed:
PRELIMINARY``FINALIZED
ADD string
``200 Yearly overview with metrics and a list of all reports for the given year
object
yearly_summary
object
required
Revenue metrics over a whole year.
actual_revenue
double
required
Total of Energy, Capacity and Adjustments for settlement period.
preliminary_revenue
double
required
The sum or all revenue for reports in a preliminary status.
potential_revenue
double
required
Potential revenue if performance reached 100%.
missed_revenue
double
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 than potential revenue.
payment_adjustment
double
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 DLRP adjustments also include any true up payments associated with updated performance factors from prior participation months
penalty
double
The sum of all penalties or market adjustments that are applied to the revenue.
performance_adjustment
double
Any revenue changes applied to Capacity Revenue. Negative values reflect penalties, when capacity performance is below nominations. Positive values reflect aggregation benefits, where overperformance from one meter can offset underperformance elsewhere.
monthly_revenue
array of objects
required
Revenue split by month.
monthly_revenue*
object
actual_revenue
double
required
Total of Energy, Capacity and Adjustments for settlement period.
preliminary_revenue
double
required
The sum or all revenue for reports in a preliminary status.
potential_revenue
double
required
Potential revenue if performance reached 100%.
month
string
required
The settlement month period. An enum representing the 12 months of the year - [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER].
revenue_sources
object
required
Revenue split by source.
capacity
object
required
Revenue information on partner participation in capacity market.
capacity object
energy
object
required
Revenue information on partner participation in the energy market.
energy object
regional_economics
object
required
Revenue split by transmission region.
regions_revenue
array of objects
required
List of revenues split by transmission region.
regions_revenue*
object
transmission_region
string
enum
required
Defines the transmission region of the meter
CAISO``ERCOT``NYISO``ISONE``PJM``SERC``WECC_SW``WECC_PC
revenue
double
required
The revenue of the given transmission region.
unit_economics
object
required
Unit revenue data.
average_market_group_revenue
double
required
Average revenue at market group level.
average_meter_revenue
double
required
Average revenue at meter level.
meters_dispatched_count
int32
required
Total number of meters dispatched.
average_kw_revenue
double
required
Average revenue at kw level.
reports
array of objects
required
List of all revenue reports for the given year.
reports*
object
settlement_period
object
required
The period for which the revenue report is generated for.
settlement_period object
settlement_type
string
enum
required
The time period of the revenue report.
YEAR``MONTH``SEASON
total_payment
double
required
The total revenue for the current revenue report. total_potential_revenue
double
required
Revenue if performance reached 100%.
missed_revenue
double
missed_revenue_by_diagnosis
array of objects
Missed revenue by diagnosis
missed_revenue_by_diagnosis
object
missed_revenue
double
diagnosis
string
enum
UNRESPONSIVE``NOT_APPLICABLE
statuses
array of objects
required
The revenue report statuses
statuses*
object
status
string
enum
required
The report status
PRELIMINARY``FINALIZED
updated_at
date-time
ISO-8601 timestamp of the settlement update date dispatch_days_count
int32
required
The number of days that were dispatched
transmission_region
string
enum
required
Defines the transmission region of the meter
CAISO``ERCOT``NYISO``ISONE``PJM``SERC``WECC_SW``WECC_PC
programs
array of objects
required
The list of the program identifiers that report is associated with
Identifier of program
CAISO-CCA-SC_ONLY``CAISO-HOLD_OPEN``CCA``CEC-DSGS-OPTION4``CEC-DSGS``CONED-CSRP``CONED-DLRP``DRAM``ELRP``ENERGY-ONLY``ERCOT-ERS``EVERSOURCE-CS``MA_DOER-CPS``NATGRID-CS``NRG-REALTIME``NRG-RED``NYISO-SCR``ONCOR-CLM``PGE-ART``PGE-CBP``PJM-CAPACITY``PSEGLI-CSRP``PSEGLI-DLRP``RIE-CS``UNITIL-CS``PSE-RPO``SRP-RPO``TVA-RPO``CAISO-ELRP-A4``CEC-DSGS-OPTION2``ENERGYHUB-CS``CT_GB-ESS
``400 Returns 400 if the request is invalid.
``401 Returns 401 if the request is unauthorized.
``403 Returns 403 if the request doesn't have the right values.
``415 Returns 415 if provided content in the request is not supported.
``500 Returns 500 if there is an internal server error.
Updated 4 days ago
Base URL
https://api.staging.leap.energy/v1.1/revenue/yearly/{year}
xxxxxxxxxx
curl --request GET \
--url https://api.staging.leap.energy/v1.1/revenue/yearly/year \
--header 'accept: application/json'
xxxxxxxxxx
{
"yearly_summary": {
"actual_revenue": 7600.55,
"preliminary_revenue": 3800.15,
"potential_revenue": 104366.8,
"missed_revenue": 20000.3,
"payment_adjustment": 20,
"penalty": 11,
"performance_adjustment": 12,
"monthly_revenue": [
{
"actual_revenue": 7600.55,
"preliminary_revenue": 3800.15,
"potential_revenue": 104366.8,
"month": "JANUARY"
},
{
"actual_revenue": 7600.55,
"preliminary_revenue": 3800.15,
"potential_revenue": 104366.8,
"month": "JANUARY"
}
]
},
"revenue_sources": {
"capacity": {
"revenue": 27600.3,
"earned_w": 11600.88,
"nomination_w": 16600.88,
"performance_percentage": 55.32
},
"energy": {
"revenue": 27600.3,
"earned_wh": 11600.88,
"awarded_wh": 450,
"performance_percentage": 55.32
}
},
"regional_economics": {
"regions_revenue": [
{
"transmission_region": "CAISO",
"revenue": 2600.66
},
{
"transmission_region": "CAISO",
"revenue": 2600.66
}
]
},
"unit_economics": {
"average_market_group_revenue": 207600,
"average_meter_revenue": 207600,
"meters_dispatched_count": 0,
"average_kw_revenue": 207600
},
"reports": [
{
"settlement_period": {
"period_start": "2023-03",
"period_end": "2023-03"
},
"settlement_type": "YEAR",
"total_payment": 207600,
"total_potential_revenue": 207600,
"missed_revenue": 20000.3,
"missed_revenue_by_diagnosis": [
{
"missed_revenue": 20000.3,
"diagnosis": "UNRESPONSIVE"
},
{
"missed_revenue": 20000.3,
"diagnosis": "UNRESPONSIVE"
}
],
"statuses": [
{
"status": "PRELIMINARY",
"updated_at": "2000-01-23T04:56:07.000+00:00"
},
{
"status": "PRELIMINARY",
"updated_at": "2000-01-23T04:56:07.000+00:00"
}
],
"dispatch_days_count": 6,
"transmission_region": "CAISO",
"programs": [
"CCA",
"ENERGY-ONLY"
]
},
{
"settlement_period": {
"period_start": "2023-03",
"period_end": "2023-03"
},
"settlement_type": "YEAR",
"total_payment": 207600,
"total_potential_revenue": 207600,
"missed_revenue": 20000.3,
"missed_revenue_by_diagnosis": [
{
"missed_revenue": 20000.3,
"diagnosis": "UNRESPONSIVE"
},
{
"missed_revenue": 20000.3,
"diagnosis": "UNRESPONSIVE"
}
],
"statuses": [
{
"status": "PRELIMINARY",
"updated_at": "2000-01-23T04:56:07.000+00:00"
},
{
"status": "PRELIMINARY",
"updated_at": "2000-01-23T04:56:07.000+00:00"
}
],
"dispatch_days_count": 6,
"transmission_region": "CAISO",
"programs": [
"CCA",
"ENERGY-ONLY"
]
}
]
}