Websocket API

The Deribit Websocket API can be used for all of the HTTP RPC endpoints. On top of this, the Websocket adds support for CoD (Cancel on Disconnect) and notification.

WebSocket address is wss://www.deribit.com/ws/api/v1/ and test WebSocket server address is wss://test.deribit.com/ws/api/v1/. Before using the Websocket API, you'll need to enable it via the Deribit API Console (go to Account > API tab > API Console tab).

All websocket messages, are JSON encoded objects. This is true for user-generated messages and server-generated messages.

RPC Message structure

Messages sent by the user consist of the following fields:

The server will respond with:

Consult RPC Endpoints to see which endpoints are available.

example

RPC Request:

{
    "id": 42,
    "action": "`/api/v1/private/account`",
    "arguments": {"ext": true},
    "sig": "19EPj2jMRW46e.1328811339209.i5g0KXArbtnYDRuHkn9PYRAQ2xGzP4qM5KXcMSG3Wcw="
}

RPC Response:

{
    "id": 42,
    "success": true,
    "testnet": false,
    "message": "",
    "result": {...},
    "usIn": 1328811339209183,
    "usOut": 1328811339209783
}

Notification Message structure

To receive event notifications, send a subscribe RPC call.

The following event channels can be subscribed to:

• order_book, notifies of order book changes
• trade, trade notifications
• my_trade, trade notifications, filtered for user trades.
• user_order, notifies of opened, changed or filled user orders.
• index, notifies of index value at frequent intervals.
• portfolio, notifies of portfolio changes.
• announcement, notifies of index value at frequent intervals.

Keep-alive

The Deribit Websocket provides two mechanisms for keep-alive and to prevent stale connections, one initiated by the client, and one initiated by the server.

To use the client-initiated mechanism, send {"action": "/api/v1/public/ping"} over the websocket connection. Within a millisecond (plus network delay),the server will respond with {"result":"pong"}. If you do not receive a response, you should treat the connection as dead, and reconnect.

To use the server-initiated mechanism, send {"action": "/api/v1/public/setheartbeat", "arguments": {"interval": 60}} over the websocket connection. After 60 seconds, the server will send two messages: {"message":"heartbeat"} and {"message":"test_request"}. If you do not receive a heartbeat message within 60 seconds, you should treat the connection as dead. When you receive a test_request message, you should respond by any websocket message, ping was specifically designed for this purpose. If you do not respond within 60 seconds (the heartbeat interval), the server will treat your connection as stale, and close it. While these examples used a heartbeat of 60 seconds, heartbeats as fast as 10 seconds are permitted.

Rate Limits

Current rate limit is 200 (order) client messages per second with bursts to 300. If you need higher rate limits please contact support.

Endpoints

The following endpoints are available. To use an endpoint, specify it in the action field. Endpoint starting with /api/v1/private/ require a signature in the sig field. Check RPC authentication for details on how to compute this signature.