API reference

Examples use {API_BASE_URL}.

Health and runtime

Method	Path	Auth	Notes
GET	/live	None	Process is running
GET	/ready	None	Service is ready to serve traffic
GET	/version	None	API version metadata
GET	/v1/runtime-config	None	Waitlist and feature flags

/metrics is not a public API endpoint.

Access

Method	Path	Auth	Notes
GET	/v1/access/self	JWT	Current identity and access state
GET	/v1/access/request	JWT	Current user's access request
POST	/v1/access/request	JWT	Submit or update an access request

Scalar market data

These routes are available in scalar mode. When waitlist access is enabled, they require an allowed JWT.

Method	Path	Notes
GET	/v1/markets	Scalar asset metadata
GET	/v1/bucket	Current and next bucket
GET	/v1/buckets	Historical buckets
GET	/v1/buckets/{asset_code}/{start_ts}	One bucket
GET	/v1/book?asset=NYCTMP1	Cached order book
GET	/v1/ticker?asset=NYCTMP1	Current mark, OI, and utilization
GET	/v1/oi-status	OI and close-only state

Scalar trading

Method	Path	Auth	Notes
POST	/v1/predict	JWT	Simple scalar prediction package
POST	/v1/orders	JWT + wallet signature	Direct signed scalar order
POST	/v1/orders/prepare	JWT	Prepare an agent-signed order
POST	/v1/orders/submit	JWT + agent signature	Submit prepared order
POST	/v1/leverage/prepare	JWT	Prepare leverage action
POST	/v1/leverage/submit	JWT + agent signature	Submit leverage action
POST	/v1/close	JWT + wallet signature	Reduce-only close
POST	/v1/agent/approve	JWT	Approve an agent wallet

/v1/close-all currently returns 501 Not Implemented. Build clients around explicit position reads and individual closes.

Binary markets

Binary routes are available in binary mode and are hidden in scalar mode. Send a JWT and expect allowlist checks.

Method	Path	Auth	Notes
GET	/v1/binary/status	JWT	Health, pause state, active asset
GET	/v1/binary/markets	JWT	Binary assets and phases
GET	/v1/binary/bucket	JWT	Current binary bucket
GET	/v1/binary/book?asset=GBETA	JWT	Best bid/ask snapshot
POST	/v1/binary/setup	JWT + signatures	Set binary leverage to 2
POST	/v1/binary/predict	JWT	Server-assisted binary entry
POST	/v1/binary/close	JWT	Reduce-only binary close

Binary diagnostic endpoints are not documented here as public trading APIs.

Outcome markets

Outcome routes require the outcome feature to be enabled. Check /v1/runtime-config before showing outcome flows; when outcomes are disabled, the outcome routes are unavailable.

When outcome writes are enabled, order and cancel prepare routes require JWT authentication, RIPBET allowlist access, and an active approved agent. If the API returns agent_not_approved, call POST /v1/agent/approve first, then retry the prepare request.

Method	Path	Auth	Notes
GET	/v1/outcomes/meta	None	Outcome registry, sides, expiry state
GET	/v1/outcomes/price-history	None	Recent price series for outcome coins
POST	/v1/outcomes/transfer/prepare	JWT	Prepare USDH transfer
POST	/v1/outcomes/transfer/submit	JWT + wallet signature	Submit prepared transfer
POST	/v1/outcomes/orders/prepare	JWT + approved agent	Prepare outcome order
POST	/v1/outcomes/orders/submit	JWT + agent signature	Submit prepared order
POST	/v1/outcomes/cancel/prepare	JWT + approved agent	Prepare cancel by cloid
POST	/v1/outcomes/cancel/submit	JWT + agent signature	Submit prepared cancel
GET	/v1/outcomes/orders/open/{address}	JWT	Open outcome orders
POST	/v1/outcomes/order-status	JWT	Lookup order status by oid or cloid

Account and history

Some address-scoped reads may accept an address in the path, but access policy is deployment and partner-contract dependent. Clients should be ready to send a JWT and handle 403.

Method	Path	Auth	Notes
GET	/v1/positions/{address}	JWT or deployment policy	Reconstructed positions
GET	/v1/account/{address}	JWT or deployment policy	Account summary
GET	/v1/fees/{address}	JWT or deployment policy	Effective fee rates
GET	/v1/trades/{address}	JWT or deployment policy	Fills
GET	/v1/orders/open/{address}	JWT or deployment policy	Open orders
GET	/v1/orders/history/{address}	JWT or deployment policy	Filled order history
GET	/v1/profile/{address}	JWT or deployment policy	Trader profile
PUT	/v1/profile	JWT	Update own profile
GET	/v1/stats/{address}	JWT when gated	Trading statistics
GET	/v1/pnl/calendar/{address}	JWT when gated	PnL calendar

Referrals and rewards

Method	Path	Auth	Notes
GET	/v1/referrals/resolve?code=...	None	Resolve a referral code
GET	/v1/referrals/code	JWT	User's codes
POST	/v1/referrals/code	JWT	Create or update a code
POST	/v1/referrals/intent	JWT	Set referral relationship
GET	/v1/referrals/tree	JWT	Referral tree and earnings
GET	/v1/referrals/payouts	JWT	Payout history
GET	/v1/rewards/{address}	None or gated by environment	Points and rewards

POST /v1/referrals is legacy. When the newer referral system is enabled it returns 410 Gone.

WebSocket and charts

Path	Notes
/v1/ws	Versioned WebSocket endpoint
/ws	Alias
/tv/config	TradingView UDF config
/tv/symbols	TradingView symbols
/tv/history	TradingView history
/tv/time	TradingView server time
/tv/search	TradingView symbol search
/tv-mark/*	Mark-price chart endpoints in binary mode

Excluded routes

Admin, analytics, whitelist, runtime-setting mutation, HIP-3 deployer action, referral admin, service metrics, and operator routes are intentionally excluded from public docs. If your integration needs one of those capabilities, treat it as a partner contract issue, not a public API assumption.

POST /v1/cancel and POST /v1/schedule-cancel are also excluded. They look like order endpoints, but they are not public user endpoints in the current API.