Expand description
Wire payloads for the Derive WebSocket JSON-RPC transport.
The transport reuses the crate::http::models::JsonRpcRequest /
crate::http::models::JsonRpcResponse envelope; this module covers only
the params payloads and the inbound notification frame.
Modules§
- methods
- JSON-RPC method names exchanged on the Derive WebSocket transport.
Structs§
- Derive
Orderbook Data - Order book snapshot pushed on
orderbook.{instrument_name}.{group}.{depth}. - Derive
Orderbook Level - Price level in a Derive order book snapshot.
- Derive
Orderbook Msg - Channel-tagged order book update.
- Derive
Orders Subscription Data - Private
{subaccount_id}.orderssubscription payload. - Derive
Ticker Msg - Channel-tagged ticker update.
- Derive
Trades Msg - Channel-tagged public trades update.
- Derive
Trades Subscription Data - Private
{subaccount_id}.tradessubscription payload. - WsLogin
Params - Params payload for
public/login. - WsSubscribe
Params - Params payload for
subscribe. - WsSubscribe
Result - Result payload returned by
subscribe. - WsSubscription
Frame - Inbound notification frame pushed by the venue on a subscribed channel.
- WsSubscription
Payload - Channel-tagged notification payload nested under
WsSubscriptionFrame::params. - WsUnsubscribe
Params - Params payload for
unsubscribe. - WsUnsubscribe
Result - Result payload returned by
unsubscribe.
Enums§
- Derive
Public WsData - Typed public market data update parsed from a Derive subscription frame.
- Derive
Ticker Data - Ticker payload shape pushed by the Derive ticker channels.
- Derive
WsChannel - Derive WebSocket subscription channel topic.
- Derive
WsFrame - Inbound frame discriminated by whether it carries an
id(response to a client request) or amethod(server-initiated notification). - WsLogin
Result - Result payload returned by
public/login. - WsRequest
Params - Method-specific params accepted by the WebSocket JSON-RPC request path.
Functions§
- balances_
channel - Formats the topic for the private
{subaccount_id}.balanceschannel. - orderbook_
channel - Formats the topic for
orderbook.{instrument_name}.{group}.{depth}. - orders_
channel - Formats the topic for the private
{subaccount_id}.orderschannel. - private_
trades_ channel - Formats the topic for the private
{subaccount_id}.tradeschannel. - ticker_
channel - Formats the topic for the public
ticker_slim.{instrument_name}.{interval}channel. - trades_
channel - Formats the topic for
trades.{instrument_type}.{currency}.