Quickstart

This page shows the shortest safe path for a client integration. It does not cover local deployment or operator setup.

1. Check enabled features

curl -s "{API_BASE_URL}/v1/runtime-config"

Example response:

{
  "waitlist_enabled": true,
  "outcomes_enabled": true,
  "outcomes_ws_enabled": true
}

If waitlist_enabled is true, protected routes require a valid JWT and allowlist access. Runtime config exposes waitlist and outcome feature flags. Probe scalar and binary market endpoints before showing those market families.

2. Read the market clock

For scalar temperature markets:

curl -s "{API_BASE_URL}/v1/markets"
curl -s "{API_BASE_URL}/v1/bucket"

For binary markets:

curl -s "{API_BASE_URL}/v1/binary/markets" \
  -H "Authorization: Bearer $JWT"

curl -s "{API_BASE_URL}/v1/binary/bucket" \
  -H "Authorization: Bearer $JWT"

For outcome markets:

curl -s "{API_BASE_URL}/v1/outcomes/meta"

Connect to:

wss://{HOST}/v1/ws

Then subscribe:

{
  "type": "subscribe",
  "channels": ["book", "trades", "activeAssetCtx"],
  "coins": ["NYCTMP1", "NYCTMP2"]
}

For outcome markets, use outcome coins returned by /v1/outcomes/meta:

{
  "type": "subscribe",
  "channels": ["outcomePrices", "outcomeBook", "outcomeTrades"],
  "coins": ["#36010"]
}

4. Authenticate before trading

Send the JWT in the Authorization header:

Authorization: Bearer <jwt>

Trading routes also require a wallet signature or an approved agent wallet, depending on the flow. See Authentication and Trading overview.

5. Place a first trade

Choose the workflow that matches the market:

Market	Entry flow
Scalar temperature	`/v1/predict`, `/v1/orders`, or the agent order prepare/submit flow
Binary	`/v1/binary/setup`, then `/v1/binary/predict`
Outcome	`/v1/outcomes/orders/prepare`, sign, then `/v1/outcomes/orders/submit`

Check /v1/runtime-config before showing outcome flows. When outcomes are disabled, outcome routes are unavailable. When outcome writes are enabled, prepare routes require JWT authentication, RIPBET allowlist access, and an active approved agent; call POST /v1/agent/approve before retrying prepare if the API returns agent_not_approved.

Do not assume all flows are enabled in every environment. Check /v1/runtime-config, watch route responses, and fail closed in your client when a market is hidden or unavailable.

6. Know the non-happy path

Before you ship an integration, read: