{
  "opencollection": "1.0.0",
  "info": {
    "name": "Deribit Account Management WebSocket Only API",
    "version": "2.1.1"
  },
  "items": [
    {
      "info": {
        "name": "WebSocket Only",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GET /private/logout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/logout",
            "params": [
              {
                "name": "invalidate_token",
                "value": "",
                "type": "query",
                "description": "<b>Token Invalidation:</b> By default, all tokens created during the current session are invalidated when you call this method. You can control this behavior using this parameter: <ul><li><b>invalidate_token=true</b> (default): All session tokens are invalidated, requiring re-authentication for new connections</li><li><b>invalidate_token=false</b>: Tokens remain valid, allowing you to reconnect using the same authentication</li></ul>"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Gracefully terminate the current WebSocket connection and optionally invalidate all tokens associated with the session.\n\nThis method provides a clean way to close WebSocket connections while preserving active orders when [**Cancel On Disconnect (COD)**](https://docs.deribit.com/api-reference/session-management/private-enable_cancel_on_disconnect) is enabled.\n\n**Use Cases:**\n\n- **Clean Shutdown:** Properly close WebSocket connections during application shutdown or restart\n- **Order Preservation:*"
        },
        {
          "info": {
            "name": "GET /public/set_heartbeat",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/public/set_heartbeat",
            "params": [
              {
                "name": "interval",
                "value": "",
                "type": "query",
                "description": "The heartbeat interval in seconds, but not less than 10"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Signals the WebSocket connection to send and request heartbeats. Heartbeats can be used to detect stale connections.\n\nWhen heartbeats have been set up, the API server will send `heartbeat` messages and `test_request` messages. Your software should respond to `test_request` messages by sending a `/api/v2/public/test` request. If your software fails to do so, the API server will immediately close the connection. If your account is configured to cancel on disconnect, any orders opened over the conn"
        },
        {
          "info": {
            "name": "GET /public/disable_heartbeat",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/public/disable_heartbeat",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Stop sending heartbeat messages. This method takes no parameters.\n\n**WebSocket Only:** This method is designed exclusively for WebSocket connections. Attempting to use it via REST/HTTP will result in an error response.\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fdisable_heartbeat)\n\n"
        },
        {
          "info": {
            "name": "GET /public/subscribe",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/public/subscribe",
            "params": [
              {
                "name": "channels",
                "value": "",
                "type": "query",
                "description": "A list of channels to subscribe to. See [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications) for all available channels."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Subscribe to one or more channels. This is the same method as `/private/subscribe`, but it can only be used for 'public' channels.\n\nFor a complete list of available subscription channels and their notification formats, see [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications).\n\n**Note - This method has distinct API rate limiting requirements:** Sustained rate: ~3.3 requests/second. For more information, see [Rate Limits](https://docs.deribit.com/articles/rate-limits)"
        },
        {
          "info": {
            "name": "GET /public/unsubscribe",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/public/unsubscribe",
            "params": [
              {
                "name": "channels",
                "value": "",
                "type": "query",
                "description": "A list of channels to unsubscribe from. Only successfully unsubscribed channels will be returned in the result. See [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications) for all available channels."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unsubscribe from one or more channels. The response contains only the channels that were successfully unsubscribed in this request.\n\nFor a complete list of available subscription channels and their notification formats, see [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications).\n\n**Note:** The `result` field in the response contains only the channels that were successfully processed and unsubscribed from this specific request. It does not include all previously subscr"
        },
        {
          "info": {
            "name": "GET /public/unsubscribe_all",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/public/unsubscribe_all",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unsubscribe from all the channels subscribed so far. This method takes no parameters.\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Funsubscribe_all)\n\n"
        },
        {
          "info": {
            "name": "GET /private/subscribe",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/subscribe",
            "params": [
              {
                "name": "channels",
                "value": "",
                "type": "query",
                "description": "A list of channels to subscribe to. See [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications) for all available channels."
              },
              {
                "name": "label",
                "value": "",
                "type": "query",
                "description": "Optional label which will be added to notifications of private channels (max 16 characters)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Subscribe to one or more channels. The name of the channel determines what information will be provided, and in what form.\n\nFor a complete list of available subscription channels and their notification formats, see [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications).\n\n**Note - This method has distinct API rate limiting requirements:** Sustained rate: ~3.3 requests/second. For more information, see [Rate Limits](https://docs.deribit.com/articles/rate-limits).\n\n**📖 "
        },
        {
          "info": {
            "name": "GET /private/unsubscribe",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/unsubscribe",
            "params": [
              {
                "name": "channels",
                "value": "",
                "type": "query",
                "description": "A list of channels to unsubscribe from. Only successfully unsubscribed channels will be returned in the result. See [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications) for all available channels."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unsubscribe from one or more channels. The response contains only the channels that were successfully unsubscribed in this request.\n\nFor a complete list of available subscription channels and their notification formats, see [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications).\n\n**Note:** The `result` field in the response contains only the channels that were successfully processed and unsubscribed from this specific request. It does not include all previously subscr"
        },
        {
          "info": {
            "name": "GET /private/unsubscribe_all",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/unsubscribe_all",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unsubscribe from all the channels subscribed so far. This method takes no parameters.\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Funsubscribe_all)\n\n"
        },
        {
          "info": {
            "name": "GET /public/hello",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/public/hello",
            "params": [
              {
                "name": "client_name",
                "value": "",
                "type": "query",
                "description": "Client software name"
              },
              {
                "name": "client_version",
                "value": "",
                "type": "query",
                "description": "Client software version"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Method used to introduce the client software connected to Deribit platform over websocket. Provided data may have an impact on the maintained connection and will be collected for internal statistical purposes. In response, Deribit will also introduce itself.\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fhello)\n\n"
        }
      ]
    }
  ],
  "bundled": true
}