Synthetic Books

Create or join a Synthetic Book definition

Creates an account-owned ten-minute lease for a canonical weighted book and returns the synthetic_id to subscribe to at wss://stream.kairos.trade with provider/topic synthetic.

Uses the caller's existing Kairos credential triple; no separate Synthetic Books credential, scope, or account allowlist is required. The full API-key triple also satisfies the mutation gate automatically.

Equivalent canonical definitions share a data-plane materialization but receive distinct account-owned lease UUIDs. Maximum 15 legs, depth 50, 25 active leases per user, and 30 create requests/minute/user by default.

post/v1/synthetics

Request

  • Base URL
    https://execution.kairos.trade
  • Auth
    API key in header X-Client-Id and API key in header X-Api-Key and API key in header X-Api-Secret

Request body

output_mode'bbo' | 'aggregated_l2' | 'decomposed_l2' required
depthinteger required
classification'arbitrary_basket' | 'relative_value' | 'exact_equivalence' | 'complement' | 'partition' | 'implication' | 'range' | 'guaranteed_payout'

Reviewed economic metadata; Kairos does not infer it from the formula.

Example request

{
  "legs": [
    {
      "venue": "polymarket",
      "weight": "-1"
    }
  ],
  "depth": 50
}

Response

Lease created and canonical synthetic id returned.

synthetic_idstring required
subscription_idstring uuid required

Opaque account-owned public lease id. This is not the materializer's private numeric handle.

createdboolean required

True when this request created the canonical materialization; false when it joined an equivalent one.

fees_updatedboolean required
sources_subscribedinteger required
expires_at_msinteger required
ttl_msinteger required

Example response

{
  "synthetic_id": "syn_0123456789abcdef",
  "ttl_ms": 600000
}

Changes

No recorded changes to this operation across all 1 revision of this API.