ZenWebsocket.Examples.DeribitAdapter (ZenWebsocket v0.1.4)

Simplified Deribit WebSocket API adapter.

Uses DeribitRpc for all RPC operations and provides 5 essential functions for Deribit integration.

Summary

Types

t()

Functions

authenticate(adapter)

Authenticate with Deribit using client credentials.

connect(opts \\ [])

Connect to Deribit WebSocket API.

send_request(deribit_adapter, method, params \\ %{})

Send a request to Deribit API using any supported method.

subscribe(adapter, channels)

Subscribe to Deribit channels.

unsubscribe(adapter, channels)

Unsubscribe from Deribit channels.

Types

t()

@type t() :: %ZenWebsocket.Examples.DeribitAdapter{
  authenticated: boolean(),
  client: ZenWebsocket.Client.t() | nil,
  client_id: String.t() | nil,
  client_secret: String.t() | nil,
  subscriptions: MapSet.t()
}

Functions

authenticate(adapter)

@spec authenticate(t()) :: {:ok, t()} | {:error, term()}

Authenticate with Deribit using client credentials.

connect(opts \\ [])

@spec connect(keyword()) :: {:ok, t()} | {:error, term()}

Connect to Deribit WebSocket API.

Options:

:client_id - Client ID for authentication
:client_secret - Client secret for authentication
:url - WebSocket URL (defaults to test.deribit.com)
:handler - Message handler function
:heartbeat_interval - Heartbeat interval in seconds (default: 30)

send_request(deribit_adapter, method, params \\ %{})

@spec send_request(t(), String.t(), map()) :: {:ok, term()} | {:error, term()}

Send a request to Deribit API using any supported method.

unsubscribe(adapter, channels)

@spec unsubscribe(t(), [String.t()]) :: {:ok, t()} | {:error, term()}

Unsubscribe from Deribit channels.