binance-connector-ruby 1.0.1

data/lib/binance/spot/market.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+module Binance
+  class Spot
+    # This module includes all spot public endpoints, including:
+    # - server time
+    # - kline
+    # - ticker
+    # - trades
+    # - orderbook
+    # - etc
+    # @see https://binance-docs.github.io/apidocs/spot/en/#market-data-endpoints
+    module Market
+      # Test Connectivity
+      #
+      # GET /api/v3/ping
+      #
+      # @see https://binance-docs.github.io/apidocs/spot/en/#test-connectivity
+      def ping
+        @session.public_request(path: '/api/v3/ping')
+      end
+
+      # Check Server Time
+      #
+      # GET /api/v3/time
+      #
+      # @see https://binance-docs.github.io/apidocs/spot/en/#check-server-time
+      def time
+        @session.public_request(path: '/api/v3/time')
+      end
+
+      # Exchange Information
+      #
+      # GET /api/v3/exchangeInfo
+      #
+      # @option kwargs [string] :symbol
+      # @option kwargs [string] :symbols
+      # @see https://binance-docs.github.io/apidocs/spot/en/#exchange-information
+      def exchange_info(symbol: nil, symbols: nil)
+        if symbols.is_a?(Array)
+          symbols = symbols.map { |v| "%22#{v}%22" }.join(',')
+          symbols = "%5B#{symbols}%5D"
+        end
+        @session.public_request(
+          path: '/api/v3/exchangeInfo',
+          params:
+            {
+              symbol: symbol,
+              symbols: symbols
+            }
+        )
+      end
+
+      # Order Book
+      #
+      # GET /api/v3/depth
+      #
+      # @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://binance-docs.github.io/apidocs/spot/en/#order-book
+      def depth(symbol:, **kwargs)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+
+        @session.public_request(
+          path: '/api/v3/depth',
+          params: kwargs.merge(symbol: symbol)
+        )
+      end
+
+      # Recent Trades List
+      #
+      # GET /api/v3/trades
+      #
+      # @param symbol [String] the symbol
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :limit  Default 500; max 1000.
+      # @see https://binance-docs.github.io/apidocs/spot/en/#recent-trades-list
+      def trades(symbol:, **kwargs)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+
+        @session.public_request(
+          path: '/api/v3/trades',
+          params: kwargs.merge(symbol: symbol)
+        )
+      end
+
+      # Old Trade Lookup
+      #
+      # X-MBX-APIKEY required
+      #
+      # GET /api/v3/historicalTrades
+      #
+      # @param symbol [String] the symbol
+      # @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://binance-docs.github.io/apidocs/spot/en/#old-trade-lookup-market_data
+      def historical_trades(symbol:, **kwargs)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+
+        @session.public_request(
+          path: '/api/v3/historicalTrades',
+          params: kwargs.merge(symbol: symbol)
+        )
+      end
+
+      # Compressed/Aggregate Trades List
+      #
+      # Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.
+      #
+      # GET /api/v3/aggTrades
+      #
+      # @param symbol [String] the symbol
+      # @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 [Integer] :fromId Trade id to fetch from. Default gets most recent trades.
+      # @option kwargs [Integer] :limit Default 500; max 1000.
+      # @see https://binance-docs.github.io/apidocs/spot/en/#compressed-aggregate-trades-list
+      def agg_trades(symbol:, **kwargs)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+
+        @session.public_request(
+          path: '/api/v3/aggTrades',
+          params: kwargs.merge(symbol: symbol)
+        )
+      end
+
+      # Kline/Candlestick Data
+      #
+      # Kline/candlestick bars for a symbol.
+      # Klines are uniquely identified by their open time.
+      #
+      # GET /api/v3/klines
+      #
+      # @param symbol [String] the symbol
+      # @param interval [String] interval
+      # @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 [Integer] :limit Default 500; max 1000.
+      # @see https://binance-docs.github.io/apidocs/spot/en/#kline-candlestick-data
+      def klines(symbol:, interval:, **kwargs)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+        Binance::Utils::Validation.require_param('interval', interval)
+
+        @session.public_request(
+          path: '/api/v3/klines',
+          params: kwargs.merge(
+            symbol: symbol,
+            interval: interval
+          )
+        )
+      end
+
+      # Current Average Price
+      #
+      # Current average price for a symbol.
+      #
+      # GET /api/v3/avgPrice
+      #
+      # @param symbol [String] the symbol
+      # @see https://binance-docs.github.io/apidocs/spot/en/#current-average-price
+      def avg_price(symbol:)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+
+        @session.public_request(
+          path: '/api/v3/avgPrice',
+          params: { symbol: symbol }
+        )
+      end
+
+      # 24hr Ticker Price Change Statistics
+      #
+      # 24 hour rolling window price change statistics. Careful when accessing this with no symbol.
+      #
+      # GET /api/v3/ticker/24hr
+      #
+      # @param symbol [String] the symbol
+      # @see https://binance-docs.github.io/apidocs/spot/en/#24hr-ticker-price-change-statistics
+      def ticker_24hr(symbol: nil)
+        @session.public_request(
+          path: '/api/v3/ticker/24hr',
+          params: { symbol: symbol }
+        )
+      end
+
+      # Symbol Price Ticker
+      #
+      # Latest price for a symbol or symbols.
+      #
+      # GET /api/v3/ticker/price
+      #
+      # @param symbol [String] the symbol
+      # @see https://binance-docs.github.io/apidocs/spot/en/#symbol-price-ticker
+      def ticker_price(symbol: nil)
+        @session.public_request(
+          path: '/api/v3/ticker/price',
+          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 book_ticker(symbol: nil)
+        @session.public_request(
+          path: '/api/v3/ticker/bookTicker',
+          params: { symbol: symbol }
+        )
+      end
+    end
+  end
+end

data/lib/binance/spot/mining.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+module Binance
+  class Spot
+    # Mining endpoints
+    # The endpoints below allow to interact with Binance Pool.
+    # @see https://binance-docs.github.io/apidocs/spot/en/#mining-endpoints
+    module Mining
+      # Acquiring Algorithm (MARKET_DATA)
+      #
+      # GET /sapi/v1/mining/pub/algoList
+      #
+      # @see https://binance-docs.github.io/apidocs/spot/en/#acquiring-algorithm-market_data
+      def mining_algo_list
+        @session.limit_request(path: '/sapi/v1/mining/pub/algoList')
+      end
+
+      # Acquiring CoinName (MARKET_DATA)
+      #
+      # GET /sapi/v1/mining/pub/coinList
+      #
+      # @see https://binance-docs.github.io/apidocs/spot/en/#acquiring-coinname-market_data
+      def mining_coin_list
+        @session.limit_request(path: '/sapi/v1/mining/pub/coinList')
+      end
+
+      # Request for Detail Miner List (USER_DATA)
+      #
+      # GET /sapi/v1/mining/worker/detail
+      #
+      # @param algo [String]
+      # @param userName [String]
+      # @param workerName [String]
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#request-for-detail-miner-list-user_data
+      def mining_worker(algo:, userName:, workerName:, **kwargs)
+        Binance::Utils::Validation.require_param('algo', algo)
+        Binance::Utils::Validation.require_param('userName', userName)
+        Binance::Utils::Validation.require_param('workerName', workerName)
+
+        @session.sign_request(:get, '/sapi/v1/mining/worker/detail', params: kwargs.merge(
+          algo: algo,
+          userName: userName,
+          workerName: workerName
+        ))
+      end
+
+      # Request for Miner List (USER_DATA)
+      #
+      # GET /sapi/v1/mining/worker/list
+      #
+      # @param algo [String]
+      # @param userName [String]
+      # @param kwargs [Hash]
+      # @option kwargs [String] :pageIndex
+      # @option kwargs [String] :sort
+      # @option kwargs [String] :sortColumn
+      # @option kwargs [String] :workerStatus
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#request-for-miner-list-user_data
+      def mining_worker_list(algo:, userName:, **kwargs)
+        Binance::Utils::Validation.require_param('algo', algo)
+        Binance::Utils::Validation.require_param('userName', userName)
+
+        @session.sign_request(:get, '/sapi/v1/mining/worker/list', params: kwargs.merge(
+          algo: algo,
+          userName: userName
+        ))
+      end
+
+      # Earnings List(USER_DATA)
+      #
+      # GET /sapi/v1/mining/payment/list
+      #
+      # @param algo [String]
+      # @param userName [String]
+      # @param kwargs [Hash]
+      # @option kwargs [String] :coin
+      # @option kwargs [Integer] :startDate
+      # @option kwargs [Integer] :endDate
+      # @option kwargs [Integer] :pageIndex
+      # @option kwargs [Integer] :pageSize
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#earnings-list-user_data
+      def mining_revenue_list(algo:, userName:, **kwargs)
+        Binance::Utils::Validation.require_param('algo', algo)
+        Binance::Utils::Validation.require_param('userName', userName)
+
+        @session.sign_request(:get, '/sapi/v1/mining/payment/list', params: kwargs.merge(
+          algo: algo,
+          userName: userName
+        ))
+      end
+
+      # Statistic List (USER_DATA)
+      #
+      # GET /sapi/v1/mining/statistics/user/status
+      #
+      # @param algo [String]
+      # @param userName [String]
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#statistic-list-user_data
+      def mining_statistics_list(algo:, userName:, **kwargs)
+        Binance::Utils::Validation.require_param('algo', algo)
+        Binance::Utils::Validation.require_param('userName', userName)
+
+        @session.sign_request(:get, '/sapi/v1/mining/statistics/user/status', params: kwargs.merge(
+          algo: algo,
+          userName: userName
+        ))
+      end
+
+      # Account List (USER_DATA)
+      #
+      # GET /sapi/v1/mining/statistics/user/list
+      #
+      # @param algo [String]
+      # @param userName [String]
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#account-list-user_data
+      def mining_account_list(algo:, userName:, **kwargs)
+        Binance::Utils::Validation.require_param('algo', algo)
+        Binance::Utils::Validation.require_param('userName', userName)
+
+        @session.sign_request(:get, '/sapi/v1/mining/statistics/user/list', params: kwargs.merge(
+          algo: algo,
+          userName: userName
+        ))
+      end
+
+      # Extra Bonus List (USER_DATA)
+      #
+      # GET /sapi/v1/mining/payment/other
+      #
+      # @param algo [String]
+      # @param userName [String]
+      # @param kwargs [Hash]
+      # @option kwargs [String] :coin
+      # @option kwargs [Integer] :startDate Search date, millisecond timestamp, while empty query all
+      # @option kwargs [Integer] :endDate Search date, millisecond timestamp, while empty query all
+      # @option kwargs [Integer] :pageIndex Page number, empty default first page, starting from 1
+      # @option kwargs [Integer] :pageSize Number of pages, minimum 10, maximum 200
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#extra-bonus-list-user_data
+      def mining_extra_bonus(algo:, userName:, **kwargs)
+        Binance::Utils::Validation.require_param('algo', algo)
+        Binance::Utils::Validation.require_param('userName', userName)
+
+        @session.sign_request(:get, '/sapi/v1/mining/payment/other', params: kwargs.merge(
+          algo: algo,
+          userName: userName
+        ))
+      end
+
+      # Hashrate Resale List (USER_DATA)
+      #
+      # GET /sapi/v1/mining/hash-transfer/config/details/list
+      #
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :pageIndex Page number, empty default first page, starting from 1
+      # @option kwargs [Integer] :pageSize Number of pages, minimum 10, maximum 200
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#hashrate-resale-list-user_data
+      def mining_resale_list(**kwargs)
+        @session.sign_request(:get, '/sapi/v1/mining/hash-transfer/config/details/list', params: kwargs)
+      end
+
+      # Hashrate Resale Detail (USER_DATA)
+      #
+      # GET /sapi/v1/mining/hash-transfer/profit/details
+      #
+      # @param configId [String] Mining ID
+      # @param userName [String] Mining Account
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :pageIndex Page number, empty default first page, starting from 1
+      # @option kwargs [Integer] :pageSize Number of pages, minimum 10, maximum 200
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#hashrate-resale-detail-user_data
+      def mining_resale_detail(configId:, userName:, **kwargs)
+        Binance::Utils::Validation.require_param('configId', configId)
+        Binance::Utils::Validation.require_param('userName', userName)
+
+        @session.sign_request(:get, '/sapi/v1/mining/hash-transfer/profit/details', params: kwargs.merge(
+          configId: configId,
+          userName: userName
+        ))
+      end
+
+      # Hashrate Resale Request (USER_DATA)
+      #
+      # POST /sapi/v1/mining/hash-transfer/config
+      #
+      # @param userName [String] Mining Account
+      # @param algo [String] Transfer algorithm(sha256)
+      # @param startDate [Integer] Resale End Time (Millisecond timestamp)
+      # @param endDate [Integer] Number of pages, minimum 10, maximum 200
+      # @param toPoolUser [Integer] Mining Account
+      # @param hashRate [Integer] Resale hashrate h/s must be transferred (BTC is greater than 500000000000 ETH is greater than 500000)
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#hashrate-resale-request-user_data
+      def mining_resale_request(userName:, algo:, startDate:, endDate:, toPoolUser:, hashRate:, **kwargs)
+        Binance::Utils::Validation.require_param('userName', userName)
+        Binance::Utils::Validation.require_param('algo', algo)
+        Binance::Utils::Validation.require_param('startDate', startDate)
+        Binance::Utils::Validation.require_param('endDate', endDate)
+        Binance::Utils::Validation.require_param('toPoolUser', toPoolUser)
+        Binance::Utils::Validation.require_param('hashRate', hashRate)
+
+        @session.sign_request(:post, '/sapi/v1/mining/hash-transfer/config', params: kwargs.merge(
+          userName: userName,
+          algo: algo,
+          startDate: startDate,
+          endDate: endDate,
+          toPoolUser: toPoolUser,
+          hashRate: hashRate
+        ))
+      end
+
+      # Cancel hashrate resale configuration(USER_DATA)
+      #
+      # POST /sapi/v1/mining/hash-transfer/config/cancel
+      #
+      # @param configId [String] Mining ID
+      # @param userName [String] Mining Account
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#cancel-hashrate-resale-configuration-user_data
+      def mining_resale_cancel(configId:, userName:, **kwargs)
+        Binance::Utils::Validation.require_param('userName', userName)
+        Binance::Utils::Validation.require_param('configId', configId)
+
+        @session.sign_request(:post, '/sapi/v1/mining/hash-transfer/config/cancel', params: kwargs.merge(
+          configId: configId,
+          userName: userName
+        ))
+      end
+    end
+  end
+end