Skip to main content
Returns details of a specific rate chain by rate ID or chain ID. The ID can be either a chain ID directly, or a rate ID that references a chain in its description.

​
Path Parameters

​
id
string
required
The rate ID or chain ID

​
Response

​
chain_id
string
Unique chain identifier
​
name
string
Human-readable chain name
​
description
string
Chain description
​
roll_lead_days
integer
Days before expiration to start rolling
​
roll_window_days
integer
Duration of roll transition period
​
roll_schedule_type
string
Roll schedule type: linear_blend, step_change, custom
​
total_contracts
integer
Total number of contracts in chain
​
active_contracts
integer
Number of currently active contracts
​
contracts
array
List of contracts in the chain
​
contract_id
string
Contract identifier
​
market_id
string
Market ID
​
contract_symbol
string
Contract symbol/ticker
​
start_date
datetime
Contract start date
​
end_date
datetime
Contract end date
​
is_active
boolean
Whether contract is currently active

​
Example Response

{
  "chain_id": "pres-2024-2028",
  "name": "Presidential 2024-2028",
  "description": "Rolling presidential election contracts",
  "roll_lead_days": 7,
  "roll_window_days": 14,
  "roll_schedule_type": "linear_blend",
  "total_contracts": 4,
  "active_contracts": 2,
  "contracts": [
    {
      "contract_id": "contract_001",
      "market_id": "KXPRESPARTY-2028-D",
      "contract_symbol": "PRES-2028-D",
      "start_date": "2024-01-01T00:00:00Z",
      "end_date": "2025-01-01T00:00:00Z",
      "is_active": true
    },
    {
      "contract_id": "contract_002",
      "market_id": "KXPRESPARTY-2028-R",
      "contract_symbol": "PRES-2028-R",
      "start_date": "2025-01-01T00:00:00Z",
      "end_date": "2026-01-01T00:00:00Z",
      "is_active": false
    }
  ]
}