Skip to main content
POST
/
ws
/
depthBooksPerps
Subscribe: Perps Depth Book
curl --request POST \
  --url wss://api.ondoperps.xyz/ws/depthBooksPerps \
  --header 'Content-Type: application/json' \
  --data '
{
  "op": "subscribe",
  "channel": "depthBooksPerps"
}
'
{
  "type": "update",
  "channel": "depthBooksPerps",
  "data": [
    {
      "market": "AAPL-USD.P",
      "time": "2025-03-05T14:30:00Z",
      "asks": [
        {
          "price": "227.60",
          "size": "80.0"
        },
        {
          "price": "227.70",
          "size": "150.0"
        }
      ],
      "bids": [
        {
          "price": "227.40",
          "size": "100.0"
        },
        {
          "price": "227.30",
          "size": "250.0"
        }
      ]
    }
  ]
}

Body

application/json
op
enum<string>
required

Operation type

Available options:
ping,
login,
subscribe,
unsubscribe,
sendMessage
channel
enum<string>

Channel to subscribe/unsubscribe

Available options:
topOfBooksPerps,
depthBooksPerps,
tradesPerps,
ordersPerps,
fillsPerps,
cancelAllOrdersAfterPerps,
positionsPerps,
liquidationPerps,
liquidationAnnouncementsPerps,
marginTransfersPerps,
balancePerps,
ordersSummariesPerps,
fundingRatesPerps,
markPricesPerps,
fundingPaymentsPerps,
kLinePerps,
deposits,
withdrawals,
chat
markets
string[]

Filter by market(s). Required for kLine (exactly one). Optional for most channels.

args
object

Authentication arguments. Use either JWT (token) or API key (key + time + sign).

numPastTrades
integer

Number of historical trades to receive on subscribe (trades channels only)

resolution
enum<string>

Kline resolution (required for kLine channels)

Available options:
1,
5,
15,
1H,
4H,
1D,
1W
timeout_seconds
integer

Dead man's switch timeout (required for cancelAllOrdersAfter channels)

depthLevels
string

Price grouping level for depth book (depthBooks channels only)

limit
integer

Max depth levels to return; 0 for unlimited (depthBooks channels only)

message
string

Chat message text (sendMessage only)

context
object

Optional context for chat (market, page, etc.)

Response

200 - application/json

Channel update for depthBooksPerps

type
enum<string>
Available options:
update
channel
enum<string>
Available options:
depthBooksPerps
data
object[]