quicknode-hyperliquid-sdk 0.1.9

Hyperliquid SDK for Rust - Simple, performant trading client. HyperCore, HyperEVM, WebSocket and gRPC streams.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

// Order book streaming service for grpc.
//
// Provides L2 (aggregated price levels) and L4 (individual orders) order book
// data via gRPC server-streaming RPCs. The order book state is maintained
// in-memory by the OrderBookProcessor, which consumes BookDiffs and
// OrderStatuses from the existing grpc multiplexer pipeline.

syntax = "proto3";
package hyperliquid;

option go_package = "github.com/quiknode-labs/raptor/hyperliquid-sdk/go/hyperliquid/proto";

// Service for streaming real-time order book data.
// L2 provides aggregated price levels (px, total_sz, order_count).
// L4 provides individual order details (user, trigger info, timestamps).
service OrderBookStreaming {
  // Subscribe to L2 aggregated book updates for a coin.
  // Sends a full L2 snapshot after each block is processed.
  rpc StreamL2Book (L2BookRequest) returns (stream L2BookUpdate);

  // Subscribe to L4 full order book for a coin.
  // Sends an initial L4 snapshot, then incremental diffs per block.
  rpc StreamL4Book (L4BookRequest) returns (stream L4BookUpdate);
}

// Request parameters for L2 book streaming.
message L2BookRequest {
  string coin = 1;
  uint32 n_levels = 2;
  optional uint32 n_sig_figs = 3;
  optional uint64 mantissa = 4;
}

// An L2 book update: full snapshot of aggregated price levels at a point in time.
message L2BookUpdate {
  string coin = 1;
  uint64 time = 2;
  uint64 block_number = 3;
  repeated L2Level bids = 4;
  repeated L2Level asks = 5;
}

// A single aggregated price level.
message L2Level {
  string px = 1;
  string sz = 2;
  uint32 n = 3;
}

// Request parameters for L4 book streaming.
message L4BookRequest {
  string coin = 1;
}

// An L4 book update: either a full snapshot or an incremental diff.
message L4BookUpdate {
  oneof update {
    L4BookSnapshot snapshot = 1;
    L4BookDiff diff = 2;
  }
}

// Full L4 order book snapshot for a single coin.
message L4BookSnapshot {
  string coin = 1;
  uint64 time = 2;
  uint64 height = 3;
  repeated L4Order bids = 4;
  repeated L4Order asks = 5;
}

// Incremental L4 book diff: raw order statuses and book diffs for one block.
message L4BookDiff {
  uint64 time = 1;
  uint64 height = 2;
  string data = 3;
}

// A single L4 order with full details.
message L4Order {
  string user = 1;
  string coin = 2;
  string side = 3;
  string limit_px = 4;
  string sz = 5;
  uint64 oid = 6;
  uint64 timestamp = 7;
  string trigger_condition = 8;
  bool is_trigger = 9;
  string trigger_px = 10;
  bool is_position_tpsl = 11;
  bool reduce_only = 12;
  string order_type = 13;
  optional string tif = 14;
  optional string cloid = 15;
}