Constraints

Get Constraint

Get data for a specific constraint by its GS entity ID.

get/constraints/{gs_entity_id}

Request

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

gs_entity_idstring required

GS entity ID of the constraint to query

api_keystring nullable

API key for authentication (query)

x-api-keystring nullable

API key for authentication (header)

Successful Response

gs_entity_idstring required

constraint_namestring required

market_idstring required

earliest_seen_utcstring date-time nullable required

latest_seen_utcstring date-time nullable required

available_datasetsstring[] nullable required

rt_absolute_costnumber nullable

da_absolute_costnumber nullable

gs_created_at_utcstring date-time nullable

gs_updated_at_utcstring date-time nullable