Endpoints
The complete Draft v0.1 method/path/auth/purpose catalog, cross-linked to detailed reference pages.
Draft v0.1 — design contract, not yet a live service
This documentation set defines a proposed Time Seventeen protocol for review and implementation planning. https://api.t17.capital is the approved and reserved REST origin, but neither that origin nor any documented endpoint is claimed to be live. The WebSocket origin remains unspecified. Credentials, chain IDs, contract addresses, rate limits, and SLAs remain unapproved; IDs, prices, and timestamps shown throughout are illustrative, not real production data.
Every route below is documented in full on its owning reference page. This page is the audit anchor: a route’s method, path, and auth classification here MUST match every other occurrence of that route across this documentation set.
All paths are relative to:
https://api.t17.capital/v1Auth classification legend: Public (no identity required), API key (canonical request signature), API key + order signature (canonical request signature plus a per-order EIP-712 signature).
Index catalog and methodology — see Indexes
| Method & path | Auth | Purpose |
|---|---|---|
GET /indexes | Public | Discover indexes by family, status, tag, or constituent market |
GET /indexes/{index_id} | Public | Current index definition and active version |
GET /indexes/{index_id}/versions | Public | Immutable version history |
GET /indexes/{index_id}/versions/{version_id} | Public | Methodology/configuration snapshot |
GET /indexes/{index_id}/versions/{version_id}/constituents | Public | Point-in-time constituents, mappings, and weights |
GET /methodologies/{methodology_id}/versions/{version} | Public | Calculation and governance method |
Index prices — see Prices
| Method & path | Auth | Purpose |
|---|---|---|
GET /indexes/{index_id}/price | Public | Latest published index level |
GET /indexes/{index_id}/prices | Public | Raw or sampled observation history |
GET /indexes/{index_id}/candles | Public | Time-bucketed OHLC-like index levels |
GET /indexes/{index_id}/prices/{observation_id} | Public | Auditable observation with inputs and correction chain |
Events, markets, and prices — see Markets and Prices
| Method & path | Auth | Purpose |
|---|---|---|
GET /events | Public | Normalized event discovery |
GET /events/{event_id} | Public | Normalized event detail and source mappings |
GET /markets | Public | Tradable market discovery |
GET /markets/{market_id} | Public | Market detail: outcomes, rules, schedule, status, venue metadata |
GET /markets/{market_id}/price | Public | Latest normalized price view |
GET /markets/{market_id}/prices | Public | Historical bid/ask/mid/mark/last observations |
GET /markets/{market_id}/candles | Public | Aggregated market-price history |
GET /markets/{market_id}/orderbook | Public | Sequenced depth snapshot |
GET /markets/{market_id}/trades | Public | Public trade tape, if permitted for the market |
Market ratings — see Ratings
| Method & path | Auth | Purpose |
|---|---|---|
GET /markets/{market_id}/rating | Public | Current Market Rating |
GET /markets/{market_id}/ratings | Public | Market Rating history |
GET /market-rating-methodologies/{methodology_id}/versions/{version} | Public | Rating methodology version |
Severity assessments — see Severity
| Method & path | Auth | Purpose |
|---|---|---|
GET /events/{event_id}/severity | Public | Current Severity Assessment for an event |
GET /events/{event_id}/severity-history | Public | Severity Assessment history for an event |
GET /severity-indexes/{index_id}/value | Public | Current Severity Index value |
GET /severity-indexes/{index_id}/values | Public | Severity Index value history |
GET /severity-methodologies/{methodology_id}/versions/{version} | Public | Severity methodology version |
API key management — see Authentication
| Method & path | Auth | Purpose |
|---|---|---|
POST /account/api-keys | API key (owner session) | Create a scoped key for an environment |
GET /account/api-keys | API key | List keys (secret never re-shown) |
POST /account/api-keys/{key_id}/rotate | API key | Rotate a key’s secret |
POST /account/api-keys/{key_id}/revoke | API key | Revoke a key |
GET /account/api-keys/{key_id}/audit-log | API key | Key usage/audit trail |
Orders — see Orders
| Method & path | Auth | Purpose |
|---|---|---|
POST /orders | API key + order signature | Place a single order |
POST /orders/batch | API key + order signature | Place multiple orders, item-addressable results |
GET /orders | API key | List orders |
GET /orders/{order_id} | API key | Order detail |
POST /orders/{order_id}/cancel | API key | Cancel an order |
POST /orders/{order_id}/amend | API key + order signature | Amend/replace an order |
POST /orders/cancel-all | API key | Cancel-all / kill-switch |
Fills — see Fills
| Method & path | Auth | Purpose |
|---|---|---|
GET /fills | API key | List fills |
GET /fills/{fill_id} | API key | Fill detail |
Positions and balances — see Positions
| Method & path | Auth | Purpose |
|---|---|---|
GET /positions | API key | List positions |
GET /positions/{market_id} | API key | Position detail for a market |
GET /balances | API key | Account balances |
Settlement — see Settlement
| Method & path | Auth | Purpose |
|---|---|---|
GET /settlements | API key | List settlement records |
GET /settlements/{settlement_id} | API key | Settlement detail |
POST /settlements/{settlement_id}/redeem | API key + order signature | Design placeholder only — redemption command, not a live endpoint |
WebSocket — see WebSocket
wss://YOUR_APPROVED_STREAM_HOST/v1/wsPublic topics: index.price, index.status, index.rebalance, market.ticker, market.trade, market.orderbook, market.rating, event.severity, severity_index.value.
Private topics: account.order, account.fill, account.position, account.balance, account.settlement, account.risk.
Where to go next
- Conventions for the shared envelope, pagination, and error rules every route above follows.
- Errors for the structured error model.