Constraints

List Constraint Binding Intervals By Hour

Get filtered binding interval counts grouped by hour-of-day.

get/constraints/{constraint_id}/binding_intervals_by_hour

Request

Base URL
https://api.gridstatus.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/gridstatus/apis/grid-status-api/docs/constraints/:constraint_id/binding_intervals_by_hour/get.ts
A function with typed inputs. Its response is checked against the schema.

constraint_idstring required

GS entity ID of the constraint to query

api_keystring nullable

API key for authentication (query)

dataset_idstring required

timezonestring nullable

Optional IANA timezone (e.g. America/New_York). When provided, buckets are computed in this timezone.

start_timestring date-time nullable

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

end_timestring date-time nullable

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

price_thresholdnumber nullable

Optional threshold. When set, only include rows where ABS(configured shadow price column) > price_threshold.

contingency_idstring nullable

Optional contingency GS entity ID filter.

x-api-keystring nullable

API key for authentication (header)

Successful Response

hourinteger required

countinteger required

No recorded changes to this operation across all 14 revisions of this API.