Sign in

v2

latestOpenAPI 3.1.02026-07-312954143.9 KB
Constraints

List Constraint Costs For Location

Get location-adjusted constraint costs over a time range.

The endpoint computes total cost per constraint/contingency pair from the specified constraint dataset in ClickHouse, then multiplies each by the location's aggregated shift factor (mean) from linear_estimated_shift_factors for the same dataset. For datasets without contingency_gs_entity_id, costs are computed per constraint and reused across that constraint's shift-factor contingency rows.

get/constraints/locations/{location_gs_entity_id}/constraint-costs

Path parameters

location_gs_entity_idstring required

Query parameters

dataset_idstring required
start_timestring date-time required

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

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)

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

api_keystring nullable

API key for authentication (query)

API key for authentication (query)

Headers

x-api-keystring nullable

API key for authentication (header)

API key for authentication (header)

Response

Successful Response

constraint_gs_entity_idstring required
constraint_namestring required
contingency_gs_entity_idstring nullable required
contingency_namestring nullable required
shift_factornumber required
total_costnumber nullable required
adjusted_costnumber nullable required