Constraints

List Binding Totals For Location

Get each binding constraint's total impact on a location's price over [start_time, end_time), largest first.

get/constraints/locations/{location_gs_entity_id}/binding-totals

Request

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

location_gs_entity_idstring required

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)

limitinteger

Maximum number of constraints to return, largest total first

api_keystring nullable

API key for authentication (query)

x-api-keystring nullable

API key for authentication (header)

Successful Response

constraint_gs_entity_idstring required

constraint_namestring required

shift_factornumber required

binding_hoursnumber required

total_impactnumber required

Sum of shadow_price × interval hours × shift_factor, signed per market, in $/MW. Positive raises the location's congestion price.