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.
CAISO, PJM, ISONE, SPP, NYISO, MISO
ISO Market Volumes
Report Name | Path |
---|---|
ISO Market Volumes | /Scheduling/ISO Market Volumes |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Available Values |
---|---|---|---|---|---|---|
Region | String | False | False | False | MRTU | PJM |
Market_Participant | String | False | False | False | [Dynamic list] | [Dynamic list] |
Begin_Trade_Date | DateTime | False | False | False | ||
End_Trade_Date | DateTime | False | False | False | ||
Market_Stage_List | String | False | False | TRUE | Dynamic List but primarily: DA FMM RT |
[Dynamic List] DA RT |
Location_Type_List | String | False | False | TRUE | Dynamic 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_List | String | False | False | TRUE | [Dynamic list] | [Dynamic list] |
Only_Display_Records_Updated_After | DateTime | TRUE | False | False | ||
Aggregate_Intervals | String | False | False | False | Hourly 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 Name | Path |
---|---|
ISO Prices | /Scheduling/ISO Prices |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values |
---|---|---|---|---|---|
Region | String | False | False | False | MRTU |
Market_Participant | String | False | False | False | [Dynamic list] |
Begin_Trade_Date | DateTime | False | False | False | |
End_Trade_Date | DateTime | False | False | False | |
Market_Stage | String | False | False | False | [Dynamic list] |
Hour_Ending | String | False | False | False | 1-24, "All" |
Portfolio | String | False | False | False | [Dynamic list] |
Portfolio_Location | String | False | False | TRUE | [Dynamic list] |
Pricing_Type | String | False | False | TRUE | [Dynamic list] |
Only_Display_Prices_Updated_After | DateTime | TRUE | False | False | |
Pricing_Interval | String | False | False | False | [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 Name | Path |
---|---|
Load Performance | /Scheduling/Load Performance |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | AvailableValues |
---|---|---|---|---|---|
Region | String | False | False | False | MRTU |
Market_Participant | String | False | False | False | [Dynamic list] |
Begin_Trade_Date | DateTime | False | False | False | |
End_Trade_Date | DateTime | False | False | False | |
Meter_Source | String | False | False | False | [Dynamic list] |
Location | String | False | False | TRUE | |
Aggregate_Intervals | String | False | False | False | 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-08" }, { "key": "Meter_Source", "value": "MRIS" }, { "key": "Location", "value": "SAMPLE_LOCATION1" }, { "key": "Aggregate_Intervals", "value": "Original Resolution" } ]
Meter Data by Source
Report Name | Path |
---|---|
Meter Data by Source | /Scheduling/Meter Data by Source |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | AvailableValues |
---|---|---|---|---|---|
Region | String | False | False | False | MRTU |
Market_Participant | String | False | False | False | [Dynamic list] |
Begin_Trade_Date | DateTime | False | False | False | |
End_Trade_Date | DateTime | False | False | False | |
Source | String | False | False | False | [Dynamic list] |
Location_Type | String | False | False | TRUE | [Dynamic list] |
Location | String | False | False | TRUE | [Dynamic list] |
Meter_Interval | String | False | False | False | Original 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 Name | Path |
---|---|
Meter Data Source Comparison | /Scheduling/Meter Data Source Comparison |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | AvailableValues |
---|---|---|---|---|---|
Region | String | False | False | False | MRTU |
Market_Participant | String | False | False | False | [Dynamic list] |
Trade_Date | DateTime | False | False | False | |
Source | String | False | False | TRUE | [Dynamic list] |
Location_Type | String | False | False | TRUE | [Dynamic list] |
Location | String | False | False | TRUE | [Dynamic list] |
Meter_Interval | String | False | False | False | Original Resolution Hourly |
Generator Performance
Report Name | Path |
---|---|
Generator Performance | /Scheduling/Generator Performance |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values |
---|---|---|---|---|---|
Region | String | False | False | False | MRTU |
Market_Participant | String | False | False | False | [Dynamic list] |
Begin_Trade_Date | DateTime | False | False | False | |
End_Trade_Date | DateTime | False | False | False | |
Location | String | False | False | TRUE | [Dynamic list] |
Aggregate_Intervals | String | False | False | False | Original 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 Name | Path |
---|---|
Invoice vs Statement | /Settlement/Invoice vs Statement |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values |
---|---|---|---|---|---|
system_operator_code | String | False | False | False | MRTU |
market_participant | String | False | False | TRUE | [Dynamic list] |
publish_date | DateTime | False | False | False | [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 Name | Path |
---|---|
Renewable Resource Shadow Settlements | /Settlement/Renewable Resource Shadow Settlements |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values |
---|---|---|---|---|---|
Region | String | False | False | False | MRTU |
Market_Participant | String | False | False | False | [Dynamic list] |
Begin_Trade_Date | DateTime | False | False | False | |
End_Trade_Date | DateTime | False | False | False | |
Location | String | False | False | TRUE | [Dynamic list] |
Aggregate_Intervals | String | False | False | False | Original 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 Name | Path |
---|---|
Settlement Detail | /Settlement/Settlement Detail |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Available Values |
---|---|---|---|---|---|---|
Region | String | False | False | False | MRTU | PJM |
Market_Participant | String | False | False | False | [Dynamic list] | [Dynamic list] |
Begin_Trade_Date | DateTime | False | False | False | ||
End_Trade_Date | DateTime | False | False | False | ||
Data_Source | String | False | False | False | APX Detail ISO Statement |
APX Detail ISO Statement |
Version | String | TRUE | False | False | Latest [+ dynamic list of CAISO versions for trade dates] | Latest |
Charge_Code | String | TRUE | False | TRUE | [Dynamic list] | [Dynamic list] |
Aggregate_Intervals | String | False | False | False | Original 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 Name | Path |
---|---|
Settlement Summary | /Settlement/Settlement Summary |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Example | Available Values |
---|---|---|---|---|---|---|---|
Region | String | False | False | False | MRTU | PJM | |
Market_Participant | String | False | False | False | [Dynamic list] | [Dynamic list] | |
Trade_Month | datetime MM/DD/YYYY HH:mm:ss AM/PM | False | False | False | [Dynamic list] | 2020-09-01 12:00:00 AM | [Dynamic list] |
Data_Source | String | False | False | False | ISO Statement APX Detail |
ISO Statement APX Detail |
|
Version | String | False | False | False | [Dynamic list of valid ISO versions for trade date] | [Dynamic list of valid ISO versions for trade date] Latest with History <Version Date> |
|
Group_By | String | False | False | False | Charge 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 Name | Path |
---|---|
Battery and Hybrid Performance Report | /Settlement/Battery and Hybrid Performance |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Example |
---|---|---|---|---|---|---|
Region | String | False | False | False | CAISO | |
Market_Participant | String | False | False | False | [Dynamic list] | |
Begin_Trade_Date | DateTime | False | False | False | 2020-09-01 12:00:00 AM | |
End_Trade_Date | DateTime | False | False | False | ||
Location | String | False | False | False | [Dynamic list of valid ISO versions for trade date] | |
State_of_Charge | String | False | False | TRUE | Charge Discharge |
|
Aggregate_Intervals | String | False | False | False | 5 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" } ]
ERCOT
ISO Market Volumes (TX)
Report Name | Path |
---|---|
ISO Market Volumes (TX) | /Scheduling/ISO Market Volumes_TX |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
begin_trade_date | DateTime | False | False | False | ||
end_trade_date | DateTime | False | False | False | ||
interval_type | String | False | False | False | Daily Hourly 15 Min Original Resolution |
|
market_stage_list | String | False | TRUE | TRUE | [Dynamic list] | |
location_type_list | String | False | TRUE | TRUE | [Dynamic list] | |
location_key_list | String | False | TRUE | TRUE | [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 Name | Path |
---|---|
Dispatched Energy_TX | /Scheduling/Dispatched Energy_TX |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
begin_trade_date | DateTime | False | False | False | ||
end_trade_date | DateTime | False | False | False | ||
interval_type | String | False | False | False | 15 Min | |
location | String | TRUE | False | TRUE | [Dynamic list] | |
price_source | String | TRUE | False | False | MIS 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 Name | Path |
---|---|
ISO Prices | /Scheduling/ISO Prices |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
Region | String | False | False | False | ||
Market_Participant | ||||||
Begin_Trade_Date | DateTime | False | False | False | ||
End_Trade_Date | DateTime | False | False | False | ||
Market_Stage | String | False | False | False | [Dynamic list] | |
Hour_Ending | String | False | False | False | 1-24, "All" | |
Portfolio | String | False | False | False | [Dynamic list] | |
Portfolio_Location | String | False | False | TRUE | [Dynamic list] | |
Pricing_Type | String | False | False | TRUE | [Dynamic list] | |
Only_Display_Prices_Updated_After | DateTime | TRUE | False | False | ||
Pricing_Interval | String | False | False | False | [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 Name | Path |
---|---|
Meter Data | /Scheduling/Meter Data |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | TRUE | False | ||
begin_trade_date | DateTime | False | False | False | ||
end_trade_date | DateTime | False | False | False | ||
interval_type | String | False | False | False | 5 min 10 min 15 min hourly |
10 min |
meter_source | String | False | False | False | [Dynamic list] | |
Location_Type | String | False | False | TRUE | [Dynamic list] | |
Location | String | False | TRUE | TRUE | [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 Name | Path |
---|---|
Meter Data_Web Service | /Scheduling/Meter Data_Web Service |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | TRUE | False | ||
begin_trade_date | DateTime | False | False | False | ||
end_trade_date | DateTime | False | False | False | ||
interval_type | String | False | False | False | 5 min 10 min 15 min hourly |
10 min |
meter_source | String | False | False | TRUE | [Dynamic list] |
MeterVsSchedule
Report Name | Path |
---|---|
MeterVsSchedule | /Scheduling/MeterVsSchedule |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | TRUE | False | [Dynamic list] | |
begin_trade_date | DateTime | False | TRUE | False | ||
end_trade_date | DateTime | False | TRUE | False | ||
interval_type | String | False | False | False | [Dynamic list] | |
location | String | False | False | TRUE | [Dynamic list] | |
meter_source | String | False | False | False | [Dynamic list] | |
price_source | String | False | False | False | MIS SCADA |
MIS |
include_da_awards | String | False | False | False | 1 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 Name | Path |
---|---|
APX Allocation Detail (ERCOT) | /Settlement/APX Allocation Detail |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
begin_trade_date | DateTime | False | False | False | ||
end_trade_date | DateTime | False | False | False | ||
statement_version | String | False | False | False | [Dynamic list] | |
location_type | String | False | False | TRUE | [Dynamic list] | |
location | String | False | False | TRUE | [Dynamic list] | |
include_CC | String | False | False | False | [Dynamic list] | |
AggregateSubHourlyToHour | String | False | TRUE | False | [Dynamic list] | |
business_days_in_past | String | False | False | False | 0 |
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 Name | Path |
---|---|
APX Allocation Detail by Watermark (ERCOT) | /Settlement/APX Allocation Detail by Watermark |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
watermark | DateTime | False | False | False | ||
include_expired_rows | String | False | False | False | 0 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 Name | Path |
---|---|
APX Allocation Summary (ERCOT) | /Settlement/APX Allocation Summary |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
trade_date | String | False | False | False | [Dynamic list] | |
statement_version | String | False | False | False | [Dynamic list] | |
location_type | String | False | False | TRUE | [Dynamic list] | |
location | String | False | False | TRUE | [Dynamic list] | |
include_CC | String | False | False | False | [Dynamic list] | |
location_flag | String | False | False | False | 1 | 1 |
Invoice vs Statement
Report Name | Path |
---|---|
Invoice vs Statement | /Settlement/Invoice vs Statement |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
system_operator_code | String | False | False | False | ||
market_participant | String | False | False | TRUE | ||
publish_date | String | False | False | False | [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 Name | Path |
---|---|
Settlement by Trade or Publish Date (ERCOT) | /Settlement/Settlement By Trade or Publish Date |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
business_days_in_past | String | False | False | False | label 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_date | DateTime | False | False | False | ||
end_trade_date | DateTime | False | False | False | ||
source_group | String | False | False | False | [Dynamic list] | |
source_version | String | False | False | TRUE | [Dynamic list] | |
AggregateIntervals | String | False | False | False | Day Hour No |
No |
UseAPXAllocatedAmts | String | False | False | False | [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 Name | Path |
---|---|
Statement Detail by Watermark (ERCOT) | /Settlement/Statement Detail by Watermark |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
watermark | DateTime | False | False | False | ||
source_group | String | False | False | False | [Dynamic list] | |
include_expired_rows | String | False | False | False | Yes 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 Name | Path |
---|---|
Statement Detail Daily by Interval (ERCOT) | /Settlement/Statement Detail Daily By Interval |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
begin_trade_date | DateTime | False | False | False | ||
end_trade_date | DateTime | False | False | False | ||
source_group | String | False | False | False | ||
statement_version | String | False | False | False | ||
LowestGranularity | String | False | False | False | [Dynamic list] | |
location_type_list | String | False | TRUE | TRUE | Gen Hub ISO Load Zone N/A |
|
location_list | String | False | TRUE | TRUE | [Dynamic list] | |
charge_code_id_list | String | False | TRUE | TRUE | [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 Name | Path |
---|---|
Statement Summary Monthly by Day (ERCOT) | /Settlement/Statement Summary Monthly By Day |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
market_participant | String | False | False | False | ||
trade_date | String | False | False | False | ||
source_group | String | False | False | False | [Dynamic list] | |
statement_version | String | False | False | False | [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 Name | Path |
---|---|
COP Data | /Operations/COP Data |
Parameter Name | Type | Nullable | AllowBlank | MultiValue | Available Values | Default |
---|---|---|---|---|---|---|
region | String | False | False | False | ||
qse | String | False | False | TRUE | [Dynamic list] | |
start_date | DateTime | False | False | False | ||
end_date | DateTime | False | False | False | ||
iso_current | String | False | False | TRUE | Yes No |
|
exclude_facilities | String | False | False | TRUE | [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" } ]