Sign in

v2

latestOpenAPI 3.1.02026-07-312954143.9 KB
Constraints

List Constraints

Get a list of constraints with optional filtering by ISOs and a search term.

Returns constraints where market_id matches an item in the comma-separated isos list and constraint_name contains the search term. When sort_order is not specified and there is a search term, results are sorted by relevance (shorter constraint_names first). When sort_order is not specified, there is no search term, and include_costs is false, results are sorted by latest_seen_utc descending (most recently seen first), then market_id ascending, then constraint_name ascending. When include_costs is true and there is no search term, results are sorted by rt_cost descending with nulls last.

Use include_costs, include_timestamps, and include_dataset_metadata to opt into rt_cost/da_cost, GS timestamps, and pricing dataset metadata.

get/constraints

Query parameters

include_costsboolean

When true, include rt_cost and da_cost on each constraint. Uses cost_start_time and cost_end_time when provided.

When true, include rt_cost and da_cost on each constraint. Uses cost_start_time and cost_end_time when provided.

include_timestampsboolean

When true, include gs_created_at_utc and gs_updated_at_utc.

When true, include gs_created_at_utc and gs_updated_at_utc.

include_dataset_metadataboolean

When true, include dataset_metadata with pricing dataset specs.

When true, include dataset_metadata with pricing dataset specs.

cost_start_timestring date-time nullable

Optional lower bound for the cost window. When set, include rows where time index >= cost_start_time. Only used when include_costs is true.

Optional lower bound for the cost window. When set, include rows where time index >= cost_start_time. Only used when include_costs is true.

cost_end_timestring date-time nullable

Optional upper bound for the cost window. When set, include rows where time index < cost_end_time. Only used when include_costs is true.

Optional upper bound for the cost window. When set, include rows where time index < cost_end_time. Only used when include_costs is true.

api_keystring nullable

API key for authentication (query)

API key for authentication (query)

isosstring nullable

Comma-separated list of market IDs to filter by

Comma-separated list of market IDs to filter by

active_afterstring date-time nullable

Filter latest_seen_utc to be on or after this timestamp

Filter latest_seen_utc to be on or after this timestamp

limitinteger nullable

Maximum number of results to return (default: 10000)

Maximum number of results to return (default: 10000)

sort_order'asc' | 'desc'

Sort order: asc or desc. Defaults to desc when omitted.

searchstring nullable

Optional search term to filter by constraint_name

Optional search term to filter by constraint_name

sort_column'constraint_name' | 'market_id' | 'earliest_seen_utc' | 'latest_seen_utc' nullable

Column to sort by. Must be one of: constraint_name, market_id, earliest_seen_utc, latest_seen_utc

Column to sort by. Must be one of: constraint_name, market_id, earliest_seen_utc, latest_seen_utc

Headers

x-api-keystring nullable

API key for authentication (header)

API key for authentication (header)

Response

Successful Response

dataset_metadataobject nullable