Skip to content
Xpansiv Power (formerly A...
/
/
API Report Parameters
Last updated

API Report Parameters

The Report Download Request allows users to access reports from APX MarketSuite® in a specific format. The report is delivered as a compressed ZIP file, similar to how reports are viewed and downloaded from the MarketSuite Reports page—just through an automated process instead of manually. The report data comes from our central data warehouse for the requested parameters.

  • If no matching information is found based on the selected filters (parameter values), the system may return a message indicating that the input values are not valid for the report. The error message may state similar to, "Default value or value provided for the report parameter '<...>' is not a valid value".

Below is a list of available report parameters by region. These parameters correspond to the filters shown on the left-hand side of the Reports page on MarketSuite. Please note that parameter names vary between ERCOT and other regions, even if they represent similar data. Also, parameter names are case-sensitive.

ISOs: CAISO, PJM, ISONE, SPP, NYISO, MISO

ISO Market Volumes

Report NamePath
ISO Market Volumes /Scheduling/ISO Market Volumes
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesAvailable Values
RegionStringFalseFalseFalseMRTUPJM
Market_ParticipantStringFalseFalseFalse[Dynamic list][Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse
End_Trade_DateDateTimeFalseFalseFalse
Market_Stage_ListStringFalseFalseTRUEDynamic List but primarily:
DA
FMM
RT		[Dynamic List]
DA
RT
Location_Type_ListStringFalseFalseTRUEDynamic List but primarily:
TSINAlias
Hub
AS Region
GenAlias
Load
TIE
Control Area
ISO
Gen		[Dynamic List]
AGGREGATE
GEN
HUB
INTERFACE
ZONE
RESIDUAL_METERED_EDC
Location_ListStringFalseFalseTRUE[Dynamic list][Dynamic list]
Only_Display_Records_Updated_AfterDateTimeTRUEFalseFalse
Aggregate_IntervalsStringFalseFalseFalseHourly
Original Resolution		Hourly
Original Resolution

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-08-05" },
  { "key": "End_Trade_Date", "value": "2025-08-07" },
  { "key": "Market_Stage_List", "value": "DA" },
  { "key": "Location_Type_List", "value": "GenAlias" },
  { "key": "Location_List", "value": "SAMPLE_LOCATION1" },
  { "key": "Aggregate_Intervals", "value": "Original Resolution" }
]

ISO Prices

Report NamePath
ISO Prices /Scheduling/ISO Prices
Parameter NameTypeNullableAllowBlankMultiValueAvailable Values
RegionStringFalseFalseFalseMRTU
Market_ParticipantStringFalseFalseFalse [Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse
End_Trade_DateDateTimeFalseFalseFalse
Market_StageStringFalseFalseFalse[Dynamic list]
Hour_EndingStringFalseFalseFalse1-24, "All"
PortfolioStringFalseFalseFalse[Dynamic list]
Portfolio_LocationStringFalseFalseTRUE[Dynamic list]
Pricing_TypeStringFalseFalseTRUE[Dynamic list]
Only_Display_Prices_Updated_AfterDateTimeTRUEFalseFalse
Pricing_IntervalStringFalseFalseFalse[Dynamic list]

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-08-01" },
  { "key": "End_Trade_Date", "value": "2025-08-08" },
  { "key": "Market_Stage", "value": "RT" },
  { "key": "Hour_Ending", "value": "All" },
  { "key": "Portfolio", "value": "All Locations" },
  { "key": "Portfolio_Location", "value": "SAMPLE_LOCATION1" },
  { "key": "Portfolio_Location", "value": "SAMPLE_LOCATION2" },
  { "key": "Pricing_Type", "value": "LMP (5-Minute)" },
  { "key": "Pricing_Interval", "value": "Original Resolution" }
]

Load Performance

Report NamePath
Load Performance/Scheduling/Load Performance
Parameter NameTypeNullableAllowBlankMultiValueAvailableValues
RegionStringFalseFalseFalseMRTU
Market_ParticipantStringFalseFalseFalse[Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse
End_Trade_DateDateTimeFalseFalseFalse
Meter_SourceStringFalseFalseFalse[Dynamic list]
LocationStringFalseFalseTRUE
Aggregate_IntervalsStringFalseFalseFalseOriginal Resolution
Hourly
Daily

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-07-01" },
  { "key": "End_Trade_Date", "value": "2025-07-08" },
  { "key": "Meter_Source", "value": "MRIS" },
  { "key": "Location", "value": "SAMPLE_LOCATION1" },
  { "key": "Aggregate_Intervals", "value": "Original Resolution" }
]

Meter Data by Source

Report NamePath
Meter Data by Source/Scheduling/Meter Data by Source
Parameter NameTypeNullableAllowBlankMultiValueAvailableValues
RegionStringFalseFalseFalseMRTU
Market_ParticipantStringFalseFalseFalse[Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse
End_Trade_DateDateTimeFalseFalseFalse
SourceStringFalseFalseFalse[Dynamic list]
Location_TypeStringFalseFalseTRUE[Dynamic list]
LocationStringFalseFalseTRUE[Dynamic list]
Meter_IntervalStringFalseFalseFalseOriginal Resolution
Hourly
Daily

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-07-06" },
  { "key": "End_Trade_Date", "value": "2025-07-06" },
  { "key": "Source", "value": "MRIS (determinant)" },
  { "key": "Location_Type", "value": "Gen" },
  { "key": "Location", "value": "SAMPLE_LOCATION1" },
  { "key": "Meter_Interval", "value": "Original Resolution" }
]

Meter Data Source Comparison

Report NamePath
Meter Data Source Comparison/Scheduling/Meter Data Source Comparison
Parameter NameTypeNullableAllowBlankMultiValueAvailableValues
RegionStringFalseFalseFalseMRTU
Market_ParticipantStringFalseFalseFalse[Dynamic list]
Trade_DateDateTimeFalseFalseFalse
SourceStringFalseFalseTRUE[Dynamic list]
Location_TypeStringFalseFalseTRUE[Dynamic list]
LocationStringFalseFalseTRUE[Dynamic list]
Meter_IntervalStringFalseFalseFalseOriginal Resolution
Hourly

Generator Performance

Report NamePath
Generator Performance/Scheduling/Generator Performance
Parameter NameTypeNullableAllowBlankMultiValueAvailable Values
RegionStringFalseFalseFalseMRTU
Market_ParticipantStringFalseFalseFalse[Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse
End_Trade_DateDateTimeFalseFalseFalse
LocationStringFalseFalseTRUE[Dynamic list]
Aggregate_IntervalsStringFalseFalseFalseOriginal Resolution
Hourly
Daily

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-08-05" },
  { "key": "End_Trade_Date", "value": "2025-08-06" },
  { "key": "Location", "value": "SAMPLE_LOCATION1" },
  { "key": "Aggregate_Intervals", "value": "Daily" }
]

Invoice vs Statement

Report NamePath
Invoice vs Statement/Settlement/Invoice vs Statement
Parameter NameTypeNullableAllowBlankMultiValueAvailable Values
system_operator_codeStringFalseFalseFalseMRTU
market_participantStringFalseFalseTRUE[Dynamic list]
publish_dateDateTimeFalseFalseFalse[Dynamic list based on harvested invoices]

Example Body

[
  { "key": "system_operator_code", "value": "MRTU" },
  { "key": "market_participant", "value": "SAMPLE" },
  { "key": "publish_date", "value": "2024-07-17" }
]

Renewable Resource Shadow Settlements

Report NamePath
Renewable Resource Shadow Settlements/Settlement/Renewable Resource Shadow Settlements
Parameter NameTypeNullableAllowBlankMultiValueAvailable Values
RegionStringFalseFalseFalseMRTU
Market_ParticipantStringFalseFalseFalse[Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse
End_Trade_DateDateTimeFalseFalseFalse
LocationStringFalseFalseTRUE[Dynamic list]
Aggregate_IntervalsStringFalseFalseFalseOriginal Resolution
Hourly
Daily
15-Min

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-08-01" },
  { "key": "End_Trade_Date", "value": "2025-08-08" },
  { "key": "Location", "value": "SAMPLE_LOCATION1" },
  { "key": "Aggregate_Intervals", "value": "Original Resolution" }
]

Settlement Detail

Report NamePath
Settlement Detail/Settlement/Settlement Detail
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesAvailable Values
RegionStringFalseFalseFalseMRTUPJM
Market_ParticipantStringFalseFalseFalse[Dynamic list][Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse
End_Trade_DateDateTimeFalseFalseFalse
Data_SourceStringFalseFalseFalseAPX Detail
ISO Statement		APX Detail
ISO Statement
VersionStringTRUEFalseFalseLatest [+ dynamic list of CAISO versions for trade dates]Latest
Charge_CodeStringTRUEFalseTRUE[Dynamic list][Dynamic list]
Aggregate_IntervalsStringFalseFalseFalseOriginal Resolution
Hourly
Daily		Original Resolution
Hourly
Daily

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-07-01" },
  { "key": "End_Trade_Date", "value": "2025-07-30" },
  { "key": "Data_Source", "value": "ISO Statement" },
  { "key": "Version", "value": "Latest" },
  { "key": "Charge_Code", "value": "1111" },
  { "key": "Charge_Code", "value": "2222" },
  { "key": "Aggregate_Intervals", "value": "Daily" }
]

Settlement Summary

Report NamePath
Settlement Summary/Settlement/Settlement Summary
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesExampleAvailable Values
RegionStringFalseFalseFalseMRTUPJM
Market_ParticipantStringFalseFalseFalse[Dynamic list][Dynamic list]
Trade_Monthdatetime MM/DD/YYYY HH:mm:ss AM/PMFalseFalseFalse[Dynamic list]2020-09-01 12:00:00 AM[Dynamic list]
Data_SourceStringFalseFalseFalseISO Statement
APX Detail		ISO Statement
APX Detail
VersionStringFalseFalseFalse[Dynamic list of valid ISO versions for trade date][Dynamic list of valid ISO versions for trade date]
Latest with History
<Version Date>
Group_ByStringFalseFalseFalseCharge Code
Location		Charge Code
Location

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Trade_Month", "value": "7/1/2025 12:00:00 AM" },
  { "key": "Data_Source", "value": "ISO Statement" },
  { "key": "Version", "value": "Initial" },
  { "key": "Group_By", "value": "Charge Code" }
]

Battery and Hybrid Performance

Report NamePath
Battery and Hybrid Performance Report/Settlement/Battery and Hybrid Performance
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesExample
RegionStringFalseFalseFalseCAISO
Market_ParticipantStringFalseFalseFalse[Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse2020-09-01 12:00:00 AM
End_Trade_DateDateTimeFalseFalseFalse
LocationStringFalseFalseFalse[Dynamic list of valid ISO versions for trade date]
State_of_ChargeStringFalseFalseTRUECharge
Discharge
Aggregate_IntervalsStringFalseFalseFalse5 Min
15 Min
Hourly
Daily

Example Body

[
  { "key": "Region", "value": "MRTU" },
  { "key": "Market_Participant", "value": "SAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-07-01" },
  { "key": "End_Trade_Date", "value": "2025-07-30" },
  { "key": "Location", "value": "SAMPLE_LOCATION1" },
  { "key": "State_of_Charge", "value": "Charge" },
  { "key": "State_of_Charge", "value": "Discharge" },
  { "key": "Aggregate_Intervals", "value": "Daily" }
]

CAISO

Physical Transactions

Report NamePath
Physical Transactions Report/Settlement/Physical Transactions
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesExample
RegionStringFalseFalseFalseCAISO
Market_ParticipantStringFalseFalseFalse[Dynamic list]
Begin_Trade_DateDateTimeFalseFalseFalse7/1/2025
End_Trade_DateDateTimeFalseFalseFalse9/30/2025
LocationStringFalseFalseFalse[Dynamic list of valid ISO versions for trade date]
IncludeChargingStringFalseTRUEFalse0 [Default Value]
1		0

Example Body

[
 { "key": "Region",  "value": "MRTU"  },
 { "key": "market_participant",  "value": "SAMPLE"  },
 { "key": "Begin_Trade_Date",  "value": "7/1/2025"  },
 { "key": "End_Trade_Date",  "value": "9/30/2025"  },
 { "key": "IncludeCharging",  "value": "1"  }
]

ERCOT

ISO Market Volumes (TX)

Report NamePath
ISO Market Volumes (TX)/Scheduling/ISO Market Volumes_TX
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
begin_trade_dateDateTimeFalseFalseFalse
end_trade_dateDateTimeFalseFalseFalse
interval_typeStringFalseFalseFalseDaily
Hourly
15 Min
Original Resolution
market_stage_listStringFalseTRUETRUE[Dynamic list]
location_type_listStringFalseTRUETRUE[Dynamic list]
location_key_listStringFalseTRUETRUE[Dynamic list]All Locations

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "begin_trade_date", "value": "2025-08-05" },
  { "key": "end_trade_date", "value": "2025-08-07" },
  { "key": "interval_type", "value": "Daily" },
  { "key": "market_stage_list", "value": "N/A" },
  { "key": "location_type_list", "value": "Load Resource" },
  { "key": "location_key_list", "value": "SAMPLE_LOCATION1" },
  { "key": "location_key_list", "value": "SAMPLE_LOCATION2" }
]

Dispatched Energy_TX

Report NamePath
Dispatched Energy_TX/Scheduling/Dispatched Energy_TX
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
begin_trade_dateDateTimeFalseFalseFalse
end_trade_dateDateTimeFalseFalseFalse
interval_typeStringFalseFalseFalse15 Min
locationStringTRUEFalseTRUE[Dynamic list]
price_sourceStringTRUEFalseFalseMIS
SCADA		MIS

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "begin_trade_date", "value": "2025-08-05" },
  { "key": "end_trade_date", "value": "2025-08-07" },
  { "key": "interval_type", "value": "15 Min" },
  { "key": "location", "value": "SAMPLE_LOCATION1" },
  { "key": "location", "value": "SAMPLE_LOCATION2" },
  { "key": "price_source", "value": "MIS" }
]

ISO Prices

Report NamePath
ISO Prices/Scheduling/ISO Prices
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
RegionStringFalseFalseFalse
Market_Participant
Begin_Trade_DateDateTimeFalseFalseFalse
End_Trade_DateDateTimeFalseFalseFalse
Market_StageStringFalseFalseFalse[Dynamic list]
Hour_EndingStringFalseFalseFalse1-24, "All"
PortfolioStringFalseFalseFalse[Dynamic list]
Portfolio_LocationStringFalseFalseTRUE[Dynamic list]
Pricing_TypeStringFalseFalseTRUE[Dynamic list]
Only_Display_Prices_Updated_AfterDateTimeTRUEFalseFalse
Pricing_IntervalStringFalseFalseFalse[Dynamic list]

Example Body

[
  { "key": "Region", "value": "TX" },
  { "key": "Market_Participant", "value": "QSAMPLE" },
  { "key": "Begin_Trade_Date", "value": "2025-08-05" },
  { "key": "End_Trade_Date", "value": "2025-08-10" },
  { "key": "Market_Stage", "value": "RT" },
  { "key": "Hour_Ending", "value": "All" },
  { "key": "Portfolio", "value": "Private" },
  { "key": "Portfolio_Location", "value": "SAMPLE_LOCATION1" },
  { "key": "Portfolio_Location", "value": "SAMPLE_LOCATION2" },
  { "key": "Pricing_Type", "value": "SPP (15-Minute)" },
  { "key": "Pricing_Type", "value": "SPP Energy Weighted (15-Minute)" },
  { "key": "Only_Display_Prices_Updated_After", "value": "2025-08-06" },
  { "key": "Pricing_Interval", "value": "Original Resolution" }
]

Meter Data

Report NamePath
Meter Data/Scheduling/Meter Data
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseTRUEFalse
begin_trade_dateDateTimeFalseFalseFalse
end_trade_dateDateTimeFalseFalseFalse
interval_typeStringFalseFalseFalse5 min
10 min
15 min
hourly		10 min
meter_sourceStringFalseFalseFalse[Dynamic list]
Location_TypeStringFalseFalseTRUE[Dynamic list]
LocationStringFalseTRUETRUE[Dynamic list]

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "begin_trade_date", "value": "2025-08-05" },
  { "key": "end_trade_date", "value": "2025-08-06" },
  { "key": "interval_type", "value": "10 min" },
  { "key": "meter_source", "value": "SCADA RAW" },
  { "key": "Location_Type", "value": "Gen" },
  { "key": "Location_Type", "value": "Load Resource" },
  { "key": "Location", "value": "SAMPLE_LOCATION1" },
  { "key": "Location", "value": "SAMPLE_LOCATION2" }
]

Meter Data_Web Service

Report NamePath
Meter Data_Web Service/Scheduling/Meter Data_Web Service
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseTRUEFalse
begin_trade_dateDateTimeFalseFalseFalse
end_trade_dateDateTimeFalseFalseFalse
interval_typeStringFalseFalseFalse5 min
10 min
15 min
hourly		10 min
meter_sourceStringFalseFalseTRUE[Dynamic list]

MeterVsSchedule

Report NamePath
MeterVsSchedule/Scheduling/MeterVsSchedule
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseTRUEFalse[Dynamic list]
begin_trade_dateDateTimeFalseTRUEFalse
end_trade_dateDateTimeFalseTRUEFalse
interval_typeStringFalseFalseFalse[Dynamic list]
locationStringFalseFalseTRUE[Dynamic list]
meter_sourceStringFalseFalseFalse[Dynamic list]
price_sourceStringFalseFalseFalseMIS
SCADA		MIS
include_da_awardsStringFalseFalseFalse1
0		0

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "begin_trade_date", "value": "2025-08-05" },
  { "key": "end_trade_date", "value": "2025-08-06" },
  { "key": "interval_type", "value": "15 min" },
  { "key": "meter_source", "value": "SCADA RAW" },
  { "key": "location", "value": "SAMPLE_LOCATION1" },
  { "key": "location", "value": "SAMPLE_LOCATION2" },
  { "key": "price_source", "value": "MIS" },
  { "key": "include_da_awards", "value": "0" }
]

APX Allocation Detail (ERCOT)

Report NamePath
APX Allocation Detail (ERCOT)/Settlement/APX Allocation Detail
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
begin_trade_dateDateTimeFalseFalseFalse
end_trade_dateDateTimeFalseFalseFalse
statement_versionStringFalseFalseFalse[Dynamic list]
location_typeStringFalseFalseTRUE[Dynamic list]
locationStringFalseFalseTRUE[Dynamic list]
include_CCStringFalseFalseFalse[Dynamic list]
AggregateSubHourlyToHourStringFalseTRUEFalse[Dynamic list]
business_days_in_pastStringFalseFalseFalse0

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "begin_trade_date", "value": "2025-08-01" },
  { "key": "end_trade_date", "value": "2025-08-16" },
  { "key": "statement_version", "value": "DAM_Initial_Determinants" },
  { "key": "location_type", "value": "GEN" },
  { "key": "location", "value": "SAMPLE_LOCATION1" },
  { "key": "include_CC", "value": "N/A" },
  { "key": "AggregateSubHourlyToHour", "value": "No" },
  { "key": "business_days_in_past", "value": "0" }
]

APX Allocation Detail by Watermark (ERCOT)

Report NamePath
APX Allocation Detail by Watermark (ERCOT)/Settlement/APX Allocation Detail by Watermark
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
watermarkDateTimeFalseFalseFalse
include_expired_rowsStringFalseFalseFalse0
1		1

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "watermark", "value": "2025-07-15" },
  { "key": "include_expired_rows", "value": "1" }
]

APX Allocation Summary (ERCOT)

Report NamePath
APX Allocation Summary (ERCOT)/Settlement/APX Allocation Summary
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
trade_dateStringFalseFalseFalse[Dynamic list]
statement_versionStringFalseFalseFalse[Dynamic list]
location_typeStringFalseFalseTRUE[Dynamic list]
locationStringFalseFalseTRUE[Dynamic list]
include_CCStringFalseFalseFalse[Dynamic list]
location_flagStringFalseFalseFalse11

Invoice vs Statement

Report NamePath
Invoice vs Statement/Settlement/Invoice vs Statement
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
system_operator_codeStringFalseFalseFalse
market_participantStringFalseFalseTRUE
publish_dateStringFalseFalseFalse[Dynamic list]

Example Body

[
  { "key": "system_operator_code", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "publish_date", "value": "2024-11-14" }
]

Settlement By Trade or Publish Date (ERCOT)

Report NamePath
Settlement by Trade or Publish Date (ERCOT)/Settlement/Settlement By Trade or Publish Date
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
business_days_in_pastStringFalseFalseFalselabel value
Trade Date 0
Published in Last 1 Business Day 1
Published in Last 2 Business Days 2
Published in Last 3 Business Days 3
Published in Last 4 Business Days 4
Published in Last 5 Business Days 5		0
begin_trade_dateDateTimeFalseFalseFalse
end_trade_dateDateTimeFalseFalseFalse
source_groupStringFalseFalseFalse[Dynamic list]
source_versionStringFalseFalseTRUE[Dynamic list]
AggregateIntervalsStringFalseFalseFalseDay
Hour
No		No
UseAPXAllocatedAmtsStringFalseFalseFalse[Dynamic list]

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "business_days_in_past", "value": "0" },
  { "key": "begin_trade_date", "value": "2025-08-03" },
  { "key": "end_trade_date", "value": "2025-08-10" },
  { "key": "source_group", "value": "Determinants" },
  { "key": "source_version", "value": "DAM_Initial_Determinants" },
  { "key": "AggregateIntervals", "value": "No" },
  { "key": "UseAPXAllocatedAmts", "value": "N/A" }
]

Statement Detail by Watermark (ERCOT)

Report NamePath
Statement Detail by Watermark (ERCOT)/Settlement/Statement Detail by Watermark
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
watermarkDateTimeFalseFalseFalse
source_groupStringFalseFalseFalse[Dynamic list]
include_expired_rowsStringFalseFalseFalseYes
No		Yes

Example Body

[
 {    "key": "region",    "value": "TX"  },
 {    "key": "market_participant",    "value": "QSAMPLE"  },
 {    "key": "watermark",    "value": "2025-08-12"  },
 {    "key": "source_group",    "value": "Determinants"  },
 {    "key": "include_expired_rows",    "value": "No"  }
]

Statement Detail Daily by Interval (ERCOT)

Report NamePath
Statement Detail Daily by Interval (ERCOT)/Settlement/Statement Detail Daily By Interval
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
begin_trade_dateDateTimeFalseFalseFalse
end_trade_dateDateTimeFalseFalseFalse
source_groupStringFalseFalseFalse
statement_versionStringFalseFalseFalse
LowestGranularityStringFalseFalseFalse[Dynamic list]
location_type_listStringFalseTRUETRUEGen
Hub
ISO
Load Zone
N/A
location_listStringFalseTRUETRUE[Dynamic list]
charge_code_id_listStringFalseTRUETRUE[Dynamic list]

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "begin_trade_date", "value": "2025-07-04" },
  { "key": "end_trade_date", "value": "2025-08-10" },
  { "key": "source_group", "value": "Statements" },
  { "key": "statement_version", "value": "RTM_Initial_Statement" },
  { "key": "LowestGranularity", "value": "No" },
  { "key": "location_type_list", "value": "ISO" },
  { "key": "location_list", "value": "ERCOT" },
  { "key": "charge_code_id_list", "value": "RTECRAMT" },
  { "key": "charge_code_id_list", "value": "RUCCSAMTQSETOT" }
]

Statement Summary Monthly by Day (ERCOT)

Report NamePath
Statement Summary Monthly by Day (ERCOT)/Settlement/Statement Summary Monthly By Day
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
market_participantStringFalseFalseFalse
trade_dateStringFalseFalseFalse
source_groupStringFalseFalseFalse[Dynamic list]
statement_versionStringFalseFalseFalse[Dynamic list]

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "market_participant", "value": "QSAMPLE" },
  { "key": "trade_date", "value": "2025-06" },
  { "key": "source_group", "value": "Statements" },
  { "key": "statement_version", "value": "RTM_Initial_Statement" }
]

COP Data

Report NamePath
COP Data/Operations/COP Data
Parameter NameTypeNullableAllowBlankMultiValueAvailable ValuesDefault
regionStringFalseFalseFalse
qseStringFalseFalseTRUE[Dynamic list]
start_dateDateTimeFalseFalseFalse
end_dateDateTimeFalseFalseFalse
iso_currentStringFalseFalseTRUEYes
No
exclude_facilitiesStringFalseFalseTRUE[Dynamic list]0 [None]

Example Body

[
  { "key": "region", "value": "TX" },
  { "key": "qse", "value": "QSAMPLE" },
  { "key": "start_date", "value": "2025-08-12" },
  { "key": "end_date", "value": "2025-08-18" },
  { "key": "iso_current", "value": "No" },
  { "key": "exclude_facilities", "value": "None" }
]
Previous page
Next page