binance-ruby 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5117a0c7dae571de49bd3a511bffe4f6043846daab557b5d526d6f74e2c94194
-  data.tar.gz: ccd6524c8cff162b7a404d33b3b0a56ed8ef69ffdb431a2e227434fd11d27f7c
+  metadata.gz: 0b7da99e475f0f3f60fa01d00d831e90fe8ce2ba2abf34ae05c7ba0d6c682e2a
+  data.tar.gz: d3f695a63e1d2fb300a59c8cad8e5179ab672ee1e2fc6c8743a2258c1dccb5fe
 SHA512:
-  metadata.gz: 72812c2efb32fd74f1ae6e7853ae72ce3bcb8b72d6e86ab4444122e924a2750ae5b64e8ffb92fd9c7b306640438afd890ce27af2c891e2e1aec5d72cde160b5b
-  data.tar.gz: 6c30d301349b6469bc73c082ca5faeb0a6da86103eba5c41076a71dfe2a7cfc5f0fff3d30fb918c5b0db37648661288cd71359f309df63ba6db5d7a350178705
+  metadata.gz: 18b1e8698ccf252bd07ce9e553057b6eb34ed1f2c95c7e3cac14a86e6f9434bb9d5532ca8c37f465e32e8da3710ace0324c7d981126f295cc25951179b4ff506
+  data.tar.gz: 41c42ed5c5bbfd0cca8ed3a904b9b2bb0842a20e2492b1f40285fd0c7cb1cc850a36c0a30c411c29d32e5b166a6b0c5e40a6637cd8fffe42ab3199c183ab02c1

data/lib/binance/api/version.rb

@@ -1,5 +1,5 @@
 module Binance
   module Api
-    VERSION = "1.4.1"
+    VERSION = "1.5.0"
   end
 end

data/lib/binance/websocket.rb

@@ -3,7 +3,7 @@ module Binance
     class Error < StandardError; end
 
     def initialize(on_open: nil, on_close: nil)
-      wss_uri = ENV['BINANCE_TEST_NET_ENABLE'] ? "wss://testnet.binance.vision/stream" : "wss://stream.binance.com:9443/stream"
+      wss_uri = ENV['BINANCE_TEST_NET_ENABLE'] ? 'wss://testnet.binance.vision/stream' : 'wss://stream.binance.com:9443/stream'
 
       super wss_uri, nil, ping: 180
 
@@ -80,6 +80,101 @@ module Binance
       subscribe(symbols_fmt.map { |s| "#{s.downcase}@trade" })
     end
 
+    # stream name: <symbol>@depth OR <symbol>@depth@500ms OR <symbol>@depth@100ms
+    # {
+    #   "e": "depthUpdate", // Event type
+    #   "E": 1571889248277, // Event time
+    #   "T": 1571889248276, // Transaction time
+    #   "s": "BTCUSDT",
+    #   "U": 390497796,     // First update ID in event
+    #   "u": 390497878,     // Final update ID in event
+    #   "pu": 390497794,    // Final update Id in last stream(ie `u` in last stream)
+    #   "b": [              // Bids to be updated
+    #     [
+    #       "7403.89",      // Price Level to be updated
+    #       "0.002"         // Quantity
+    #     ],
+    #     [
+    #       "7403.90",
+    #       "3.906"
+    #     ],
+    #     [
+    #       "7404.00",
+    #       "1.428"
+    #     ],
+    #     [
+    #       "7404.85",
+    #       "5.239"
+    #     ],
+    #     [
+    #       "7405.43",
+    #       "2.562"
+    #     ],
+    #   ],
+    #   "a": [              // Asks to be updated
+    #     [
+    #       "7405.96",      // Price level to be
+    #       "3.340"         // Quantity
+    #     ],
+    #     [
+    #       "7406.63",
+    #       "4.525"
+    #     ],
+    #     [
+    #       "7407.08",
+    #       "2.475"
+    #     ],
+    #     [
+    #       "7407.15",
+    #       "4.800"
+    #     ],
+    #     [
+    #       "7407.20",
+    #       "0.175"
+    #     ],
+    #   ],
+    # ]
+
+    def partial_book_depth!(symbols, level, update_speed = nil, &on_receive)
+      symbols_fmt = symbols.is_a?(String) ? [symbols] : symbols
+      @book_depth_handler = on_receive
+      subscribe(symbols_fmt.map { |s| "#{s.downcase}@depth#{level}#{update_speed ? "@#{update_speed}ms" : ''}" })
+    end
+
+    # stream name: <symbol>@depth OR <symbol>@depth@500ms OR <symbol>@depth@100ms
+    # {
+    #   "e": "depthUpdate", // Event type
+    #   "E": 123456789,     // Event time
+    #   "T": 123456788,     // Transaction time
+    #   "s": "BTCUSDT",     // Symbol
+    #   "U": 157,           // First update ID in event
+    #   "u": 160,           // Final update ID in event
+    #   "pu": 149,          // Final update Id in last stream(ie `u` in last stream)
+    #   "b": [              // Bids to be updated
+    #     [
+    #       "0.0024",       // Price level to be updated
+    #       "10"            // Quantity
+    #     ]
+    #   ],
+    #   "a": [              // Asks to be updated
+    #     [
+    #       "0.0026",       // Price level to be updated
+    #       "100"          // Quantity
+    #     ]
+    #   ]
+    # }
+
+    def book_depth!(symbols, update_speed = nil, &on_receive)
+      symbols_fmt = symbols.is_a?(String) ? [symbols] : symbols
+      @book_depth_handler = on_receive
+      subscribe(symbols_fmt.map { |s| "#{s.downcase}@depth#{update_speed ? "@#{update_speed}ms" : ''}" })
+    end
+
+    def book_depth_unsubscribe!(symbols, update_speed = nil)
+      symbols_fmt = symbols.is_a?(String) ? [symbols] : symbols
+      unsubscribe(symbols_fmt.map { |s| "#{s.downcase}@depth#{update_speed ? "@#{update_speed}ms" : ''}" })
+    end
+
     private
 
     def process_data(data)
@@ -92,6 +187,8 @@ module Binance
         case json[:data][:e]&.to_sym
         when :kline
           @candlesticks_handler&.call(json[:stream], json[:data])
+        when :depthUpdate
+          @book_depth_handler&.call(json[:stream], json[:data])
         when :outboundAccountPosition
         when :balanceUpdate
         when :executionReport # order update
@@ -109,21 +206,21 @@ module Binance
 
     def subscribe(streams)
       send({
-        method: "SUBSCRIBE",
+        method: 'SUBSCRIBE',
         params: streams,
-        id: request_id,
+        id: request_id
       }.to_json)
     end
 
     # Terminating socket connection achieves the same result.
     # If you have a use-case for this, please create a GitHub issue.
     #
-    # def unsubscribe(streams)
-    #   send({
-    #     method: "UNSUBSCRIBE",
-    #     params: streams,
-    #     id: request_id,
-    #   }.to_json)
-    # end
+    def unsubscribe(streams)
+      send({
+        method: "UNSUBSCRIBE",
+        params: streams,
+        id: request_id,
+      }.to_json)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Jake Peterson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-05 00:00:00.000000000 Z
+date: 2025-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -237,5 +237,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: binance-ruby-1.4.1
+summary: binance-ruby-1.5.0
 test_files: []