GRgridstatus
Constraints

Get Constraint Binding Heat Map

Changed on

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

get/constraints/binding/heat_map

Request

Query parameters

api_keystring nullable

API key for authentication (query)

dataset_idstring required
start_timestring date-time required

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)

timezonestring nullable

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.

group_by'constraint' | 'constraint_contingency'

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.

hoursstring nullable

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)

Response

Successful Response

OR

Changes

  • 43e6e1047e53Revision changes
    • info

      added the new optional query request parameter days_of_week

    • info

      added the new optional query request parameter hours

  • de58449b43e2Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      deleted the query request parameter price_threshold

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter bucket_mode

    • info

      added the new optional query request parameter group_by

    • info

      added the new optional query request parameter timezone

    • info

      added to the response body anyOf list for the response status