v2

latestOpenAPI 3.1.02026-07-312954143.9 KB
Constraints

List Contingencies

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

Returns all rows and columns from the contingencies table where market_id matches an item in the comma-separated isos list and contingency_name contains the search term. When sort_order is not specified and there is a search term, results are sorted by relevance (shorter contingency_names first). When sort_order is not specified and there is no search term, results are sorted by latest_seen_utc descending (most recently seen first), then market_id ascending, then contingency_name ascending for consistent ordering.

Args: params: Query parameters (isos, search, active_after, limit, sort_column, sort_order)

get/constraints/contingencies

Query parameters

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 contingency_name

Optional search term to filter by contingency_name

sort_column'contingency_name' | 'market_id' | 'earliest_seen_utc' | 'latest_seen_utc' nullable

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

Column to sort by. Must be one of: contingency_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

gs_entity_idstring required
contingency_namestring required
market_idstring nullable required
earliest_seen_utcstring date-time nullable required
latest_seen_utcstring date-time nullable required
available_datasetsstring[] nullable required
gs_created_at_utcstring date-time required
gs_updated_at_utcstring date-time required