binance-connector-ruby 1.6.0 → 1.7.0

data/lib/binance/spot/market.rb

@@ -9,13 +9,13 @@ module Binance
     # - trades
     # - orderbook
     # - etc
-    # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#market-data-endpoints
+    # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#market-data-endpoints
     module Market
       # Test Connectivity
       #
       # GET /api/v3/ping
       #
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#test-connectivity
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#test-connectivity
       def ping
         @session.public_request(path: '/api/v3/ping')
       end
@@ -24,7 +24,7 @@ module Binance
       #
       # GET /api/v3/time
       #
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#check-server-time
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#check-server-time
       def time
         @session.public_request(path: '/api/v3/time')
       end
@@ -36,7 +36,9 @@ module Binance
       # @option kwargs [string] :symbol
       # @option kwargs [string] :symbols
       # @option kwargs [string] :permissions
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#exchange-information
+      # @option kwargs [Boolean] :feature Controls whether the content of the permissionSets field is populated or not. Defaults to true
+      # @option kwargs [string] :symbolStatus Filters symbols that have this tradingStatus. Valid values: TRADING, HALT, BREAK. Cannot be used in combination with symbols or symbol.
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#exchange-information
       def exchange_info(symbol: nil, symbols: nil, permissions: nil)
         if symbols.is_a?(Array)
           symbols = symbols.map { |v| "%22#{v}%22" }.join(',')
@@ -59,7 +61,7 @@ module Binance
       # @param symbol [String] the symbol
       # @param kwargs [Hash]
       # @option kwargs [Integer] :limit Default 100; max 1000. Valid limits:[5, 10, 20, 50, 100, 500, 1000, 5000]
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#order-book
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#order-book
       def depth(symbol:, **kwargs)
         Binance::Utils::Validation.require_param('symbol', symbol)
 
@@ -76,7 +78,7 @@ module Binance
       # @param symbol [String] the symbol
       # @param kwargs [Hash]
       # @option kwargs [Integer] :limit  Default 500; max 1000.
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#recent-trades-list
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#recent-trades-list
       def trades(symbol:, **kwargs)
         Binance::Utils::Validation.require_param('symbol', symbol)
 
@@ -96,7 +98,7 @@ module Binance
       # @param kwargs [Hash]
       # @option kwargs [Integer] :limit Default 500; max 1000.
       # @option kwargs [Integer] :fromId Trade id to fetch from. Default gets most recent trades.
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#old-trade-lookup
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#old-trade-lookup
       def historical_trades(symbol:, **kwargs)
         Binance::Utils::Validation.require_param('symbol', symbol)
 
@@ -118,7 +120,7 @@ module Binance
       # @option kwargs [Integer] :endTime Timestamp in ms to get aggregate trades until INCLUSIVE.
       # @option kwargs [Integer] :fromId Trade id to fetch from. Default gets most recent trades.
       # @option kwargs [Integer] :limit Default 500; max 1000.
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#compressedaggregate-trades-list
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#compressedaggregate-trades-list
       def agg_trades(symbol:, **kwargs)
         Binance::Utils::Validation.require_param('symbol', symbol)
 
@@ -140,8 +142,9 @@ module Binance
       # @param kwargs [Hash]
       # @option kwargs [Integer] :startTime Timestamp in ms to get aggregate trades from INCLUSIVE.
       # @option kwargs [Integer] :endTime Timestamp in ms to get aggregate trades until INCLUSIVE.
+      # @option kwargs [String] :timeZone Default: 0 (UTC)
       # @option kwargs [Integer] :limit Default 500; max 1000.
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#klinecandlestick-data
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#klinecandlestick-data
       def klines(symbol:, interval:, **kwargs)
         Binance::Utils::Validation.require_param('symbol', symbol)
         Binance::Utils::Validation.require_param('interval', interval)
@@ -155,6 +158,33 @@ module Binance
         )
       end
 
+      # UIKlines
+      #
+      # uiKlines return modified kline data, optimized for presentation of candlestick charts
+      #
+      # GET /api/v3/uiKlines
+      #
+      # @param symbol [String] the symbol
+      # @param interval [String] interval
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :startTime
+      # @option kwargs [Integer] :endTime
+      # @option kwargs [String] :timeZone Default: 0 (UTC)
+      # @option kwargs [Integer] :limit Default 500; max 1000.
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#uiklines
+      def ui_klines(symbol:, interval:, **kwargs)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+        Binance::Utils::Validation.require_param('interval', interval)
+
+        @session.public_request(
+          path: '/api/v3/uiKlines',
+          params: kwargs.merge(
+            symbol: symbol,
+            interval: interval
+          )
+        )
+      end
+
       # Current Average Price
       #
       # Current average price for a symbol.
@@ -162,7 +192,7 @@ module Binance
       # GET /api/v3/avgPrice
       #
       # @param symbol [String] the symbol
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#current-average-price
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#current-average-price
       def avg_price(symbol:)
         Binance::Utils::Validation.require_param('symbol', symbol)
 
@@ -179,7 +209,7 @@ module Binance
       # GET /api/v3/ticker/24hr
       #
       # @param symbol [String] the symbol
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#24hr-ticker-price-change-statistics
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#24hr-ticker-price-change-statistics
       def ticker_24hr(symbol: nil)
         @session.public_request(
           path: '/api/v3/ticker/24hr',
@@ -187,6 +217,35 @@ module Binance
         )
       end
 
+      # Trading Day Ticker
+      #
+      # Price change statistics for a trading day.
+      #
+      # GET /api/v3/ticker/tradingDay
+      #
+      # @param kwargs [Hash]
+      # @option kwargs [string] :symbol Either symbol or symbols must be provided
+      # @option kwargs [string] :symbols
+      # @option kwargs [String] :timeZone Default: 0 (UTC)
+      # @option kwargs [String] :type Supported values: FULL or MINI. Default: FULL
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#trading-day-ticker
+      def ticker_trading_day(symbol: nil, symbols: nil, **kwargs)
+        raise Binance::DuplicatedParametersError.new('symbol', 'symbols') unless symbols.nil? || symbol.nil?
+
+        if symbols
+          symbols = symbols.map { |s| "\"#{s}\"" }.join(',')
+          symbols = { symbols: "\[#{symbols}\]".upcase }
+        end
+
+        @session.public_request(
+          path: '/api/v3/ticker/tradingDay',
+          params: kwargs.merge(
+            symbol: symbol,
+            symbols: symbols
+          )
+        )
+      end
+
       # Symbol Price Ticker
       #
       # Latest price for a symbol or symbols.
@@ -194,7 +253,7 @@ module Binance
       # GET /api/v3/ticker/price
       #
       # @param symbol [String] the symbol
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#symbol-price-ticker
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#symbol-price-ticker
       def ticker_price(symbol: nil)
         @session.public_request(
           path: '/api/v3/ticker/price',
@@ -209,7 +268,7 @@ module Binance
       # GET /api/v3/ticker/bookTicker
       #
       # @param symbol [String] the symbol
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#symbol-order-book-ticker
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#symbol-order-book-ticker
       def book_ticker(symbol: nil)
         @session.public_request(
           path: '/api/v3/ticker/bookTicker',
@@ -224,7 +283,7 @@ module Binance
       # GET /api/v3/ticker/bookTicker
       #
       # @param symbol [String] the symbol
-      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api#symbol-order-book-ticker
+      # @see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#symbol-order-book-ticker
       def ticker(symbol: nil, symbols: nil, windowSize: '1d')
         raise Binance::DuplicatedParametersError.new('symbol', 'symbols') unless symbols.nil? || symbol.nil?
 

data/lib/binance/spot/simple_earn.rb

@@ -63,6 +63,7 @@ module Binance
       # @param kwargs [Hash]
       # @option kwargs [Boolean] :autoSubscribe true or false, default true
       # @option kwargs [String] :sourceAccount SPOT,FUND,ALL, default SPOT
+      # @option kwargs [String] :redeemTo SPOT,FLEXIBLE, default FLEXIBLE
       # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
       # @see https://developers.binance.com/docs/simple_earn/earn/Subscribe-Locked-Product
       def locked_subscribe(projectId:, amount:, **kwargs)
@@ -365,6 +366,25 @@ module Binance
         ))
       end
 
+      # Set Locked Product Redeem Option (USER_DATA)
+      #
+      # POST /sapi/v1/simple-earn/locked/setRedeemOption
+      #
+      # @param positionId [String]
+      # @param redeemTo [String] SPOT or FLEXIBLE
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://developers.binance.com/docs/simple_earn/earn/Set-Locked-Redeem-Option
+      def locked_redeem_option(positionId:, redeemTo:, **kwargs)
+        Binance::Utils::Validation.require_param('positionId', positionId)
+        Binance::Utils::Validation.require_param('redeemTo', redeemTo)
+
+        @session.sign_request(:post, '/sapi/v1/simple-earn/locked/setRedeemOption', params: kwargs.merge(
+          positionId: positionId,
+          redeemTo: redeemTo
+        ))
+      end
+
       # Get Rate History (USER_DATA)
       #
       # GET /sapi/v1/simple-earn/flexible/history/rateHistory

data/lib/binance/spot/subaccount.rb

@@ -124,6 +124,20 @@ module Binance
         @session.sign_request(:get, '/sapi/v3/sub-account/assets', params: kwargs.merge(email: email))
       end
 
+      # Query Sub-account Assets (For Master Account)(USER_DATA)
+      #
+      # GET /sapi/v4/sub-account/assets
+      #
+      # @param email [String]
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://developers.binance.com/docs/sub_account/asset-management/Query-Sub-account-Assets-V4
+      def get_sub_account_assets_v4(email:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+
+        @session.sign_request(:get, '/sapi/v4/sub-account/assets', params: kwargs.merge(email: email))
+      end
+
       # Query Sub-account Spot Assets Summary (For Master Account)
       #
       # GET /sapi/v1/sub-account/spotSummary
@@ -214,6 +228,22 @@ module Binance
         ))
       end
 
+      # Enable Options for Sub-account(For Master Account)(USER_DATA)
+      #
+      # POST /sapi/v1/sub-account/eoptions/enable
+      #
+      # @param email [String] Sub user email
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://developers.binance.com/docs/sub_account/account-management/Enable-Options-for-Sub-account
+      def sub_account_enable_options(email:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+
+        @session.sign_request(:post, '/sapi/v1/sub-account/eoptions/enable', params: kwargs.merge(
+          email: email
+        ))
+      end
+
       # Get Detail on Sub-account's Margin Account (For Master Account)
       #
       # GET /sapi/v1/sub-account/margin/account
@@ -313,6 +343,22 @@ module Binance
         ))
       end
 
+      # Query Sub-account Transaction Statistics(For Master Account)(USER_DATA)
+      #
+      # GET /sapi/v1/sub-account/transaction-statistics
+      #
+      # @param email [String] Sub user email
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://developers.binance.com/docs/sub_account/account-management/Query-Sub-account-Transaction-Statistics
+      def sub_account_transaction_statistics(email:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+
+        @session.sign_request(:get, '/sapi/v1/sub-account/transaction-statistics', params: kwargs.merge(
+          email: email
+        ))
+      end
+
       # Futures Transfer for Sub-account(For Master Account)
       #
       # POST /sapi/v1/sub-account/futures/transfer
@@ -526,6 +572,34 @@ module Binance
         @session.sign_request(:get, '/sapi/v1/managed-subaccount/asset', params: kwargs.merge(email: email))
       end
 
+      # Query Managed Sub-account Margin Asset Details(For Investor Master Account)(USER_DATA)
+      #
+      # GET /sapi/v1/managed-subaccount/marginAsset
+      #
+      # @param email [String]
+      # @param kwargs [Hash]
+      # @option kwargs [String] :accountType No input or input "MARGIN" to get Cross Margin account details. Input "ISOLATED_MARGIN" to get Isolated Margin account details.
+      # @see https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-account-Margin-Asset-Details
+      def sub_account_margin_asset_details(email:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+
+        @session.sign_request(:get, '/sapi/v1/managed-subaccount/marginAsset', params: kwargs.merge(email: email))
+      end
+
+      # Query Managed Sub-account Futures Asset Details(For Investor Master Account)(USER_DATA)
+      #
+      # GET /sapi/v1/managed-subaccount/fetch-future-asset
+      #
+      # @param email [String]
+      # @param kwargs [Hash]
+      # @option kwargs [String] :accountType No input or input "USDT_FUTURE" to get UM Futures account details. Input "COIN_FUTURE" to get CM Futures account details.
+      # @see https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-account-Futures-Asset-Details
+      def sub_account_futures_asset_details(email:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+
+        @session.sign_request(:get, '/sapi/v1/managed-subaccount/fetch-future-asset', params: kwargs.merge(email: email))
+      end
+
       # Withdrawl assets from the managed sub-account (For Investor Master Account)
       #
       # POST /sapi/v1/managed-subaccount/withdraw
@@ -549,6 +623,105 @@ module Binance
         ))
       end
 
+      # Query Managed Sub Account Transfer Log(For Trading Team Master Account)(USER_DATA)
+      #
+      # GET /sapi/v1/managed-subaccount/queryTransLogForTradeParent
+      #
+      # @param email [String] Managed Sub Account Email
+      # @param startTime [Integer]
+      # @param endTime [Integer]
+      # @param page [Integer]
+      # @param limit [Integer] Limit (Max: 500)
+      # @param kwargs [Hash]
+      # @option kwargs [String] :transfers Transfer Direction (FROM/TO)
+      # @option kwargs [String] :transferFunctionAccountType Transfer function account type (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE)
+      # @see https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-Account-Transfer-Log-Trading-Team-Master
+      def sub_account_transfer_log(email:, startTime:, endTime:, page:, limit:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+        Binance::Utils::Validation.require_param('startTime', startTime)
+        Binance::Utils::Validation.require_param('endTime', endTime)
+        Binance::Utils::Validation.require_param('page', page)
+        Binance::Utils::Validation.require_param('limit', limit)
+
+        @session.sign_request(:get, '/sapi/v1/managed-subaccount/queryTransLogForTradeParent', params: kwargs.merge(
+          email: email,
+          startTime: startTime,
+          endTime: endTime,
+          page: page,
+          limit: limit
+        ))
+      end
+
+      # Query Managed Sub Account Transfer Log (For Trading Team Sub Account)(USER_DATA)
+      #
+      # GET /sapi/v1/managed-subaccount/query-trans-log
+      #
+      # @param startTime [Integer]
+      # @param endTime [Integer]
+      # @param page [Integer]
+      # @param limit [Integer] Limit (Max: 500)
+      # @param kwargs [Hash]
+      # @option kwargs [String] :transfers Transfer Direction (FROM/TO)
+      # @option kwargs [String] :transferFunctionAccountType Transfer function account type (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE)
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-Account-Transfer-Log-Trading-Team-Sub
+      def sub_account_transfer_log_sub_account(startTime:, endTime:, page:, limit:, **kwargs)
+        Binance::Utils::Validation.require_param('startTime', startTime)
+        Binance::Utils::Validation.require_param('endTime', endTime)
+        Binance::Utils::Validation.require_param('page', page)
+        Binance::Utils::Validation.require_param('limit', limit)
+
+        @session.sign_request(:get, '/sapi/v1/managed-subaccount/query-trans-log', params: kwargs.merge(
+          startTime: startTime,
+          endTime: endTime,
+          page: page,
+          limit: limit
+        ))
+      end
+
+      # Query Managed Sub Account Transfer Log (For Investor Master Account)(USER_DATA)
+      #
+      # GET /sapi/v1/managed-subaccount/queryTransLogForInvestor
+      #
+      # @param email [String] Managed Sub Account Email
+      # @param startTime [Integer]
+      # @param endTime [Integer]
+      # @param page [Integer]
+      # @param limit [Integer] Limit (Max: 500)
+      # @param kwargs [Hash]
+      # @option kwargs [String] :transfers Transfer Direction (FROM/TO)
+      # @option kwargs [String] :transferFunctionAccountType Transfer function account type (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE)
+      # @see https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-Account-Transfer-Log-Investor
+      def sub_account_transfer_log_investor(email:, startTime:, endTime:, page:, limit:, **kwargs)
+        Binance::Utils::Validation.require_param('email', email)
+        Binance::Utils::Validation.require_param('startTime', startTime)
+        Binance::Utils::Validation.require_param('endTime', endTime)
+        Binance::Utils::Validation.require_param('page', page)
+        Binance::Utils::Validation.require_param('limit', limit)
+
+        @session.sign_request(:get, '/sapi/v1/managed-subaccount/queryTransLogForInvestor', params: kwargs.merge(
+          email: email,
+          startTime: startTime,
+          endTime: endTime,
+          page: page,
+          limit: limit
+        ))
+      end
+
+      # Query Managed Sub-account List (For Investor)(USER_DATA)
+      #
+      # GET /sapi/v1/managed-subaccount/info
+      #
+      # @param kwargs [Hash]
+      # @option kwargs [String] :email Status Managed sub-account email
+      # @option kwargs [Integer] :page Default: 1
+      # @option kwargs [Integer] :limit Default: 10, Max: 20
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-account-List
+      def sub_account_list(**kwargs)
+        @session.sign_request(:get, '/sapi/v1/managed-subaccount/info', params: kwargs)
+      end
+
       # Enable or Disable IP Restriction for a Sub-account API Key (For Master Account)
       #
       # POST /sapi/v2/sub-account/subAccountApi/ipRestriction