binance-connector-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7facfdf6b9532826bcb09f079db1d45d927c7fa05f8431694729ff4268d4d336
-  data.tar.gz: 943f98d14fe1167239695f1134c40cc068ddaa4c63fe8545f40f2746e5de0264
+  metadata.gz: 1b029d14cae7ec52f77a9f61775eba15eb33027f47983f2184e49731c5de746a
+  data.tar.gz: 5ecb20e8b7544668b2e4306a5f70548b9e3ce92696f9111b4e4ba4f88b7e4fa4
 SHA512:
-  metadata.gz: bb5ac1a51601bef15a2adf1d588c941e125d0cc90bcc836660496c93da6aaf2a4755ecc8a50f8d759f1e0e7550f64c6944aa4c33e0fbae5f72f512c068aa6ef5
-  data.tar.gz: 1d25971c4d4857a14e00e818a1cfe9c2cf6c8b1b595aafb43a616be8abc2798e4b734e2d37b0b57557fe86fe5c2c809b78b47066ef32f06b9c631ecbaba530c0
+  metadata.gz: 1b779f8bf2a01f165f68748c37385d3a4bf79e9e887a82f5d23c08b111b697cb2280c60c9cfe4609b5c061218f008c4b58dd81e7457e26a7f76dfbafc7f1226e
+  data.tar.gz: 25e0a750c7db5fb5dd26889548d26aa3a3c1e96b0a13ab21898623a79c69393f1df025a4f7b0c3ea6d6ad893d197544d3e24145be6b0a1e335af28dd42a9d19b

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 1.2.0 - 2022-07-15
+
+### Add
+- Sub account endpoints
+  - `POST /sapi/v1/sub-account/subAccountApi/ipRestriction` to support master account enable and disable IP restriction for a sub-account API Key
+  - `POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList` to support master account add IP list for a sub-account API Key
+  - `GET /sapi/v1/account/apiRestrictions/ipRestriction` to support master account query IP restriction for a sub-account API Key
+  - `DELETE /sapi/v1/account/apiRestrictions/ipRestriction/ipList` to support master account delete IP list for a sub-account API Key
+- Market endpoint
+  - `GET /api/v3/ticker`
+- Trade endpoint
+  - `POST /api/v3/order/cancelReplace`
+- Websocket methods
+  - `<symbol>@ticker_<window_size>`
+  - `!ticker_<window-size>@arr`
+
+
 ## 1.1.0 - 2022-06-09
 
 ### Add

data/lib/binance/error.rb

@@ -25,4 +25,11 @@ module Binance
       )
     end
   end
+
+  # Error when Multi parameters are not allowed to send together
+  class DuplicatedParametersError < Error
+    def initialize(*kwargs)
+      super("Parameters #{kwargs} should not be sent to server together.")
+    end
+  end
 end

data/lib/binance/spot/market.rb

@@ -215,6 +215,32 @@ module Binance
           params: { symbol: symbol }
         )
       end
+
+      # Symbol Order Book Ticker
+      #
+      # Best price/qty on the order book for a symbol or symbols.
+      #
+      # GET /api/v3/ticker/bookTicker
+      #
+      # @param symbol [String] the symbol
+      # @see https://binance-docs.github.io/apidocs/spot/en/#symbol-order-book-ticker
+      def ticker(symbol: nil, symbols: nil, windowSize: '1d')
+        raise Binance::DuplicatedParametersError.new('symbol', 'symbols') unless symbols.nil? || symbol.nil?
+
+        params = { symbol: symbol.upcase } if symbol
+
+        if symbols
+          symbols = symbols.map { |s| "\"#{s}\"" }.join(',')
+          params = { symbols: "\[#{symbols}\]".upcase }
+        end
+
+        params[:windowSize] = windowSize
+
+        @session.public_request(
+          path: '/api/v3/ticker',
+          params: params
+        )
+      end
     end
   end
 end

data/lib/binance/spot/subaccount.rb

@@ -548,6 +548,87 @@ module Binance
           amount: amount
         ))
       end
+
+      # Enable or Disable IP Restriction for a Sub-account API Key (For Master Account)
+      #
+      # POST /sapi/v1/sub-account/subAccountApi/ipRestriction
+      #
+      # @param email  [String]
+      # @param subAccountApiKey [String]
+      # @param ipRestrict [Boolean]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#enable-or-disable-ip-restriction-for-a-sub-account-api-key-for-master-account
+      def sub_account_toggle_ip_restriction(email:, subAccountApiKey:, ipRestrict:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+        Binance::Utils::Validation.require_param('subAccountApiKey', subAccountApiKey)
+        Binance::Utils::Validation.require_param('ipRestrict', ipRestrict)
+
+        @session.sign_request(:post, '/sapi/v1/sub-account/subAccountApi/ipRestriction', params: kwargs.merge(
+          email: email,
+          subAccountApiKey: subAccountApiKey,
+          ipRestrict: ipRestrict
+        ))
+      end
+
+      # Add IP List for a Sub-account API Key (For Master Account)
+      #
+      # POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList
+      #
+      # @param email  [String]
+      # @param subAccountApiKey [String]
+      # @param ipAddress [String]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#add-ip-list-for-a-sub-account-api-key-for-master-account
+      def sub_account_add_ip_list(email:, subAccountApiKey:, ipAddress:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+        Binance::Utils::Validation.require_param('subAccountApiKey', subAccountApiKey)
+        Binance::Utils::Validation.require_param('ipAddress', ipAddress)
+
+        @session.sign_request(:post, '/sapi/v1/sub-account/subAccountApi/ipRestriction/ipList', params: kwargs.merge(
+          email: email,
+          subAccountApiKey: subAccountApiKey,
+          ipAddress: ipAddress
+        ))
+      end
+
+      # Get IP Restriction for a Sub-account API Key (For Master Account)
+      #
+      # GET /sapi/v1/sub-account/subAccountApi/ipRestriction
+      #
+      # @param email  [String]
+      # @param subAccountApiKey [String]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#get-ip-restriction-for-a-sub-account-api-key-for-master-account
+      def sub_account_ip_list(email:, subAccountApiKey:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+        Binance::Utils::Validation.require_param('subAccountApiKey', subAccountApiKey)
+
+        @session.sign_request(:get, '/sapi/v1/sub-account/subAccountApi/ipRestriction', params: kwargs.merge(
+          email: email,
+          subAccountApiKey: subAccountApiKey
+        ))
+      end
+
+      # Delete IP List For a Sub-account API Key (For Master Account)
+      #
+      # DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList
+      #
+      # @param email  [String]
+      # @param subAccountApiKey [String]
+      # @param ipAddress [String]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#get-ip-restriction-for-a-sub-account-api-key-for-master-account
+      def sub_account_delete_ip_list(email:, subAccountApiKey:, ipAddress:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+        Binance::Utils::Validation.require_param('subAccountApiKey', subAccountApiKey)
+        Binance::Utils::Validation.require_param('ipAddress', ipAddress)
+
+        @session.sign_request(:delete, '/sapi/v1/sub-account/subAccountApi/ipRestriction/ipList', params: kwargs.merge(
+          email: email,
+          subAccountApiKey: subAccountApiKey,
+          ipAddress: ipAddress
+        ))
+      end
     end
   end
 end

data/lib/binance/spot/trade.rb

@@ -289,6 +289,44 @@ module Binance
       def get_order_rate_limit(**kwargs)
         @session.sign_request(:get, '/api/v3/rateLimit/order', params: kwargs)
       end
+
+      # Cancel an Existing Order and Send a New Order (TRADE)
+      #
+      # POST /api/v3/order/cancelReplace
+      #
+      # @param symbol [String] the symbol
+      # @param side [String]
+      # @param type [String]
+      # @param cancelReplaceMode [String] STOP_ON_FAILURE or ALLOW_FAILURE
+      # @param kwargs [Hash]
+      # @option kwargs [String] :timeInForce
+      # @option kwargs [Float] :quantity
+      # @option kwargs [Float] :quoteOrderQty
+      # @option kwargs [Float] :price
+      # @option kwargs [String] :cancelNewClientOrderId
+      # @option kwargs [String] :cancelOrigClientOrderId
+      # @option kwargs [Integer] :cancelOrderId
+      # @option kwargs [String] :newClientOrderId
+      # @option kwargs [Float] :stopPrice
+      # @option kwargs [Integer] :trailingDelta
+      # @option kwargs [Float] :icebergQty
+      # @option kwargs [String] :newOrderRespType
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#cancel-an-existing-order-and-send-a-new-order-trade
+      def cancel_replace(symbol:, side:, type:, cancelReplaceMode:, **kwargs)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+        Binance::Utils::Validation.require_param('side', side)
+        Binance::Utils::Validation.require_param('type', type)
+        Binance::Utils::Validation.require_param('cancelReplaceMode', cancelReplaceMode)
+
+        @session.sign_request(:post, '/api/v3/order/cancelReplace',
+                              params: kwargs.merge(
+                                symbol: symbol,
+                                side: side,
+                                type: type,
+                                cancelReplaceMode: cancelReplaceMode
+                              ))
+      end
     end
   end
 end

data/lib/binance/spot/websocket.rb

@@ -126,6 +126,30 @@ module Binance
         create_connection(url, callbacks)
       end
 
+      # Individual Symbol Rolling Window Statistics Streams
+      # Rolling window ticker statistics for a single symbol, computed over multiple windows.
+      # Stream Name: <symbol>@ticker_<window_size>
+      # Window Sizes: 1h,4h
+      # Update Speed:  1000ms
+      #
+      # @see https://binance-docs.github.io/apidocs/spot/en/#individual-symbol-rolling-window-statistics-streams
+      def rolling_window_ticker(symbol:, windowSize:, callbacks:)
+        url = "#{@base_url}/ws/#{symbol.downcase}@ticker_#{windowSize}"
+        create_connection(url, callbacks)
+      end
+
+      # All Market Rolling Window Statistics Streams
+      # Rolling window ticker statistics for all market symbols, computed over multiple windows. Note that only tickers that have changed will be present in the array.
+      # Stream Name: !ticker_<window-size>@arr
+      # Window Sizes: 1h, 4h
+      # Update Speed:  1000ms
+      #
+      # @see https://binance-docs.github.io/apidocs/spot/en/#all-market-rolling-window-statistics-streams
+      def rolling_window_ticker_all_symbols(windowSize:, callbacks:)
+        url = "#{@base_url}/ws/!ticker_#{windowSize}@arr"
+        create_connection(url, callbacks)
+      end
+
       # Subscribe to a stream manually
       # subscribe(stream: "btcusdt@miniTicker") or
       # subscribe(stream: ["btcusdt@miniTicker", "ethusdt@miniTicker"])

data/lib/binance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Binance
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance-connector-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Binance
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler