Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.joyride.exchange/llms.txt

Use this file to discover all available pages before exploring further.

​
Status

Use the WebSocket Reference tab for generated channel and message reference. This page remains the protocol guide and highlights the runtime behavior that matters most when integrating.

​
Transport

  • Protocol: raw WebSocket
  • Endpoint: wss://joyride.exchange/api/v1
  • Message envelope: JSON-RPC 2.0
  • Trading: WebSocket only
  • Market-data subscriptions: WebSocket only

​
Request shape

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "private/buy",
  "params": {}
}

​
Success response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}

​
Subscription notification

{
  "jsonrpc": "2.0",
  "method": "subscription",
  "params": {
    "channel": "book.SOL_USDC-28FEB26-150-C.10",
    "data": {}
  }
}

​
Core methods

​
Authentication

  • public/get_nonce
  • public/auth

​
Trading

  • private/buy
  • private/sell
  • private/cancel
  • private/cancel_all

​
Queries

  • public/get_instruments
  • public/get_market_config
  • private/get_open_orders
  • private/get_account

​
Subscriptions

  • public/subscribe
  • public/unsubscribe

​
Channel patterns

ChannelAuthDescription
book.{instrument_id}.{depth}noBook snapshots and updates
trades.{instrument_id}noPublic trade feed
tickers.{instrument_id}noBest bid/ask, spread, mid, and spot price for one instrument
spot.{asset}noReal-time spot price updates for one asset
candle.{asset}.{timeframe}noLive candle relay from price-history
user.ordersyesOrder status updates for the authenticated user
user.tradesyesTrade notifications for the authenticated user
socialyesSocial feed snapshot and live activity events
leaderboardyesLive leaderboard snapshots
settlementyesSettlement timing updates and per-user settlement results
logsnoGateway log stream for dashboards and debugging

​
Authenticated push events

Some server notifications are sent to authenticated sessions without an explicit public/subscribe:
  • instruments when a new round is bootstrapped
  • settlement_complete when a settlement round finishes

​
Common application errors

CodeMeaning
1001Not authenticated
1002Insufficient balance
1003Order not found
1004Instrument not found
1005Invalid price
1006Invalid size
1007Rate limit exceeded
1008Order already cancelled or filled
1009Market closed or instrument expired
1010Authentication failed
1015Trading window not yet open
1016Trading window closed
When the competition window gate is active, 1015/1016 apply to order-creating methods including private/close_position (it places a close order internally), while private/cancel and private/cancel_all remain available.

​
Reference split

  • WebSocket Reference tab: generated reference from asyncapi.yaml
  • This page: conceptual guide and notable protocol behavior