Constraints

Get Constraint Binding Heat Map

Return absolute costs and shadow-price aggregates by bucket and constraint.

get/constraints/binding/heat_map

Query parameters

api_keystring nullable

API key for authentication (query)

API key for authentication (query)

dataset_idstring required
start_timestring date-time required

Filter to rows where time index >= start_time (ISO 8601)

Filter to rows where time index >= start_time (ISO 8601)

end_timestring date-time required

Filter to rows where time index < end_time (ISO 8601 timestamp)

Filter to rows where time index < end_time (ISO 8601 timestamp)

timezonestring nullable

Optional IANA timezone used for daily bucket boundaries. Defaults to the dataset market timezone.

Optional IANA timezone used for daily bucket boundaries. Defaults to the dataset market timezone.

bucket_mode'auto' | 'raw' | 'hourly' | 'daily'

Bucket resolution. Raw preserves the native interval; hourly and daily use explicit buckets. Auto derives resolution from the native interval and selected range. Explicit modes that exceed the range limit resolve to the nearest available mode.

Bucket resolution. Raw preserves the native interval; hourly and daily use explicit buckets. Auto derives resolution from the native interval and selected range. Explicit modes that exceed the range limit resolve to the nearest available mode.

group_by'constraint' | 'constraint_contingency'

Group rows by constraint and contingency by default, or by constraint only.

Group rows by constraint and contingency by default, or by constraint only.

days_of_weekstring nullable

Optional comma-separated market-local days of the week, where Monday is 1 and Sunday is 7. An empty value matches no rows.

Optional comma-separated market-local days of the week, where Monday is 1 and Sunday is 7. An empty value matches no rows.

hoursstring nullable

Optional comma-separated market-local hour starts from 0 through 23. An empty value matches no rows.

Optional comma-separated market-local hour starts from 0 through 23. An empty value matches no rows.

Headers

x-api-keystring nullable

API key for authentication (header)

API key for authentication (header)

Response

Successful Response

OR

Changes