Constraints
List Binding Constraints With Locations
Changed onGet unique binding constraints for a dataset/time window with locations.
Scans binding observations for dataset_id in [start_time, end_time), collapses peak-|shadow| per (constraint, interval), keeps the top limit constraints by peak |shadow|, joins facility coordinates and contingency identity/names, and returns one object per constraint with nested observations, ordered by that ranking.
get/constraints/binding/locations
Request
- Base URLhttps://api.gridstatus.io/v1
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
limitinteger
Maximum number of unique binding constraints to return (all intervals for each are included).
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)
Headers
x-api-keystring nullable
API key for authentication (header)
Response
Successful Response
Changes
- info
endpoint added
- info