Skip to main content
GET
List match clusters
Return a paginated list of production match clusters for one configured association. Each list entry uses the same exchange-keyed cluster shape as GET /match/{contractID}.
string
required
One Kalshi series ID or Polymarket tag ID. It must resolve to exactly one configured association; a tag shared by multiple series is ambiguous.
string
Filter clusters by open, closed, or settling. Omit it to include all states. A cluster is settling when its linked contracts include both open and closed outcomes.
string
default:"close_time"
Sort by close_time or open_time. The cluster uses the latest timestamp among its linked contracts. Null timestamps sort last.
string
default:"desc"
desc puts later timestamps first; asc puts earlier timestamps first. Equal timestamps use a stable contract-ID tie-break.
integer
default:"25"
Results per page, from 1 to 100.
string
Cursor returned in the previous page’s pagination.next_cursor. Keep the other query parameters unchanged when continuing.
boolean
default:"false"
Include exchange resolution rules in contract metadata. Omit or set false for a smaller response.
pagination.next_cursor is omitted on the final page. The page is charged against the daily unique-cluster quota atomically. If all new clusters on the requested page would exceed the remaining allowance, the request returns 429 and charges none of that page. Repeated clusters remain free.

Authorizations

X-API-Key
string
header
required

Query Parameters

scope_id
string
required

A series ID or tag ID that resolves to exactly one configured association.

status
enum<string>

Cluster lifecycle state. Omit to include all.

Available options:
open,
closed,
settling
sort_by
enum<string>
default:close_time
Available options:
close_time,
open_time
order
enum<string>
default:desc

Descending returns later timestamps first. Null timestamps sort last.

Available options:
asc,
desc
limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string
include_rules
boolean
default:false

Response

Page of match clusters.

scope_id
string
required
status
enum<string>
required
Available options:
all,
open,
closed,
settling
sort_by
enum<string>
required
Available options:
close_time,
open_time
order
enum<string>
required
Available options:
asc,
desc
clusters
object[]
required
pagination
object
required