binance-connector-ruby 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 528658559216256c1f8a39559437b3faf6e4b0e834fbca24f7d4c46a12c6b045
-  data.tar.gz: ea13e85275dd64c727b73144c92931b07694c85456beee884d8850cd177d5298
+  metadata.gz: 7facfdf6b9532826bcb09f079db1d45d927c7fa05f8431694729ff4268d4d336
+  data.tar.gz: 943f98d14fe1167239695f1134c40cc068ddaa4c63fe8545f40f2746e5de0264
 SHA512:
-  metadata.gz: bb20b597d4b9a95248a440a08a57b33765c095c9f529998bc91136ceaaded6ad0074f93980fb46694fa2a0e3aa7a6aa1c158ceffaf921381c645bd4db4fc2c0d
-  data.tar.gz: 40f14e2adda863fc0812e45ab56f137ee3f80f7f33565f30be2279a0bb1facec6a8117f68b52904fc7c979d728ed2098871165a987e91b0ddf6ff91391e9d2be
+  metadata.gz: bb5ac1a51601bef15a2adf1d588c941e125d0cc90bcc836660496c93da6aaf2a4755ecc8a50f8d759f1e0e7550f64c6944aa4c33e0fbae5f72f512c068aa6ef5
+  data.tar.gz: 1d25971c4d4857a14e00e818a1cfe9c2cf6c8b1b595aafb43a616be8abc2798e4b734e2d37b0b57557fe86fe5c2c809b78b47066ef32f06b9c631ecbaba530c0

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 1.1.0 - 2022-06-09
+
+### Add
+- Convert endpoint
+  - `GET /sapi/v1/convert/tradeFlow`
+- Margin Endpoint
+  - `GET /sapi/v1/margin/crossMarginData`
+  - `GET /sapi/v1/margin/isolatedMarginData`
+  - `GET /sapi/v1/margin/isolatedMarginTier`
+  - `GET /sapi/v1/margin/rateLimit/order`
+ - All Staking Endpoints
+
+### Update
+- Fixing rubocop warnnings
+
+## 1.0.3 - 2022-05-06
+- Update rake version
+
+## 1.0.2 - 2021-11-21
+
+### Update
+- Change README description and package settings
+
+## 1.0.1 - 2021-11-21
+
+### Update
+- Change package name
+
 ## 1.0.0 - 2021-11-18
 
 ### Added

data/README.md

@@ -1,6 +1,6 @@
 # Binance Connector Ruby
 
-[![Gem Version](https://badge.fury.io/rb/binance-connector.svg)](https://badge.fury.io/rb/binance-connector)
+[![Gem Version](https://badge.fury.io/rb/binance-connector-ruby.svg)](https://badge.fury.io/rb/binance-connector-ruby)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
@@ -23,7 +23,7 @@ This is a lightweight library that works as a connector to [Binance public API](
 	Add this line in the Gemfile.
 
 	```ruby
-	gem 'binance-connector'
+	gem 'binance-connector-ruby'
 	```
 
 	And then execute the bundler via CLI:
@@ -33,11 +33,13 @@ This is a lightweight library that works as a connector to [Binance public API](
   ```
 2. Install it with CLI:
   ```shell
-  gem install binance-connector
+  gem install binance-connector-ruby
   ```
+
 ## Documentation
 
-[https://www.rubydoc.info/gems/binance-connector](https://www.rubydoc.info/gems/binance-connector)
+[https://www.rubydoc.info/gems/binance-connector-ruby](https://www.rubydoc.info/gems/binance-connector-ruby)
+
 ## Restful APIs
 
 ```ruby

data/lib/binance/spot/convert.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Binance
+  class Spot
+    # Convert endpoints
+    # @see https://binance-docs.github.io/apidocs/spot/en/#convert-endpoints
+    module Convert
+      # Get Convert Trade History (USER_DATA)
+      #
+      # GET /sapi/v1/convert/tradeFlow
+      #
+      # @param startTime [Integer]
+      # @param endTime [Integer]
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :limit default 100, max 1000
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#convert-endpoints
+      def convert_trade_flow(startTime:, endTime:, **kwargs)
+        Binance::Utils::Validation.require_param('startTime', startTime)
+        Binance::Utils::Validation.require_param('endTime', endTime)
+
+        @session.sign_request(:get, '/sapi/v1/convert/tradeFlow', params: kwargs.merge(
+          startTime: startTime,
+          endTime: endTime
+        ))
+      end
+    end
+  end
+end

data/lib/binance/spot/margin.rb

@@ -671,6 +671,60 @@ module Binance
 
         @session.sign_request(:get, '/sapi/v1/margin/interestRateHistory', params: kwargs.merge(asset: asset))
       end
+
+      # Query Cross Margin Fee Data (USER_DATA)
+      #
+      # GET /sapi/v1/margin/crossMarginData
+      #
+      # @param kwargs [Hash]
+      # @option vipLevel [Integer] Default: user's vip level
+      # @option coin [String]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#query-cross-margin-fee-data-user_data
+      def get_cross_margin_data(**kwargs)
+        @session.sign_request(:get, '/sapi/v1/margin/crossMarginData', params: kwargs)
+      end
+
+      # Query Isolated Margin Fee Data (USER_DATA)
+      #
+      # GET /sapi/v1/margin/isolatedMarginData
+      #
+      # @param kwargs [Hash]
+      # @option vipLevel [Integer] Default: user's vip level
+      # @option symbol [String]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-fee-data-user_data
+      def get_isolated_margin_data(**kwargs)
+        @session.sign_request(:get, '/sapi/v1/margin/isolatedMarginData', params: kwargs)
+      end
+
+      # Query Isolated Margin Tier Data (USER_DATA)
+      #
+      # GET /sapi/v1/margin/isolatedMarginTier
+      #
+      # @param symbol [String]
+      # @param kwargs [Hash]
+      # @option tier [Integer]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-tier-data-user_data
+      def get_isolated_margin_tier(symbol:, **kwargs)
+        Binance::Utils::Validation.require_param('symbol', symbol)
+
+        @session.sign_request(:get, '/sapi/v1/margin/isolatedMarginTier', params: kwargs.merge(symbol: symbol))
+      end
+
+      # Query Current Margin Order Count Usage (TRADE)
+      #
+      # GET /sapi/v1/margin/rateLimit/order
+      #
+      # @param kwargs [Hash]
+      # @option isIsolated [String]
+      # @option symbol [String]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-fee-data-user_data
+      def get_margin_order_usage(**kwargs)
+        @session.sign_request(:get, '/sapi/v1/margin/rateLimit/order', params: kwargs)
+      end
     end
   end
 end

data/lib/binance/spot/staking.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Binance
+  class Spot
+    # all savings endpoints
+    # @see https://binance-docs.github.io/apidocs/spot/en/#savings-endpoints
+    module Staking
+      # Get Staking Product List(USER_DATA)
+      #
+      # GET /sapi/v1/staking/productList
+      #
+      # @param product [String] "STAKING" for Locked Staking, "F_DEFI" for flexible DeFi Staking, "L_DEFI" for locked DeFi Staking
+      # @param kwargs [Hash]
+      # @option kwargs [String] :asset
+      # @option kwargs [Integer] :current
+      # @option kwargs [Integer] :size
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#get-staking-product-list-user_data
+      def staking_product_list(product:, **kwargs)
+        Binance::Utils::Validation.require_param('product', product)
+
+        @session.sign_request(:get, '/sapi/v1/staking/productList', params: kwargs.merge(product: product))
+      end
+
+      # Purchase Staking Product(USER_DATA)
+      #
+      # POST /sapi/v1/staking/purchase
+      #
+      # @param product [String] "STAKING" for Locked Staking, "F_DEFI" for flexible DeFi Staking, "L_DEFI" for locked DeFi Staking
+      # @param productId [String]
+      # @param amount [Float]
+      # @param kwargs [Hash]
+      # @option kwargs [String] :renewable
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#purchase-staking-product-user_data
+      def staking_purchase(product:, productId:, amount:, **kwargs)
+        Binance::Utils::Validation.require_param('product', product)
+        Binance::Utils::Validation.require_param('productId', productId)
+        Binance::Utils::Validation.require_param('amount', amount)
+
+        @session.sign_request(:post, '/sapi/v1/staking/purchase', params: kwargs.merge(product: product, productId: productId, amount: amount))
+      end
+
+      # Redeem Staking Product(USER_DATA)
+      #
+      # POST /sapi/v1/staking/redeem
+      #
+      # @param product [String] "STAKING" for Locked Staking, "F_DEFI" for flexible DeFi Staking, "L_DEFI" for locked DeFi Staking
+      # @param productId [String]
+      # @param kwargs [Hash]
+      # @option kwargs [Float] :amount
+      # @option kwargs [String] :positionId
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#redeem-staking-product-user_data
+      def staking_redeem(product:, productId:, **kwargs)
+        Binance::Utils::Validation.require_param('product', product)
+        Binance::Utils::Validation.require_param('productId', productId)
+
+        @session.sign_request(:post, '/sapi/v1/staking/redeem', params: kwargs.merge(product: product, productId: productId))
+      end
+
+      # Get Staking Product Position(USER_DATA)
+      #
+      # GET /sapi/v1/staking/position
+      #
+      # @param product [String] "STAKING" for Locked Staking, "F_DEFI" for flexible DeFi Staking, "L_DEFI" for locked DeFi Staking
+      # @param kwargs [Hash]
+      # @option kwargs [String] :productId
+      # @option kwargs [String] :asset
+      # @option kwargs [Integer] :current
+      # @option kwargs [Integer] :size
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#get-staking-product-list-user_data
+      def staking_position(product:, **kwargs)
+        Binance::Utils::Validation.require_param('product', product)
+
+        @session.sign_request(:get, '/sapi/v1/staking/position', params: kwargs.merge(product: product))
+      end
+
+      # Get Staking History(USER_DATA)
+      #
+      # GET /sapi/v1/staking/stakingRecord
+      #
+      # @param product [String] "STAKING" for Locked Staking, "F_DEFI" for flexible DeFi Staking, "L_DEFI" for locked DeFi Staking
+      # @param txnType [String] "SUBSCRIPTION", "REDEMPTION", "INTEREST"
+      # @param kwargs [Hash]
+      # @option kwargs [String] :asset
+      # @option kwargs [Integer] :startTime
+      # @option kwargs [Integer] :endTime
+      # @option kwargs [Integer] :current
+      # @option kwargs [Integer] :size
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#get-staking-history-user_data
+      def staking_history(product:, txnType:, **kwargs)
+        Binance::Utils::Validation.require_param('product', product)
+        Binance::Utils::Validation.require_param('txnType', txnType)
+
+        @session.sign_request(:get, '/sapi/v1/staking/stakingRecord', params: kwargs.merge(product: product, txnType: txnType))
+      end
+
+      # Set Auto Staking(USER_DATA)
+      #
+      # POST /sapi/v1/staking/setAutoStaking
+      #
+      # @param product [String] "STAKING" for Locked Staking, "F_DEFI" for flexible DeFi Staking, "L_DEFI" for locked DeFi Staking
+      # @param positionId [String]
+      # @param renewable [String]  true or false
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#set-auto-staking-user_data
+      def staking_set_auto(product:, positionId:, renewable:, **kwargs)
+        Binance::Utils::Validation.require_param('product', product)
+        Binance::Utils::Validation.require_param('positionId', positionId)
+        Binance::Utils::Validation.require_param('renewable', renewable)
+
+        @session.sign_request(:post, '/sapi/v1/staking/setAutoStaking', params: kwargs.merge(product: product, positionId: positionId, renewable: renewable))
+      end
+
+      # Get Personal Left Quota of Staking Product(USER_DATA)
+      #
+      # GET /sapi/v1/staking/personalLeftQuota
+      #
+      # @param product [String] "STAKING" for Locked Staking, "F_DEFI" for flexible DeFi Staking, "L_DEFI" for locked DeFi Staking
+      # @param productId [String]
+      # @param kwargs [Hash]
+      # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
+      # @see https://binance-docs.github.io/apidocs/spot/en/#get-staking-history-user_data
+      def staking_personal_quota_remain(product:, productId:, **kwargs)
+        Binance::Utils::Validation.require_param('product', product)
+        Binance::Utils::Validation.require_param('productId', productId)
+
+        @session.sign_request(:get, '/sapi/v1/staking/personalLeftQuota', params: kwargs.merge(product: product, productId: productId))
+      end
+    end
+  end
+end

data/lib/binance/spot.rb

@@ -8,6 +8,7 @@ require 'binance/error'
 require 'binance/spot/blvt'
 require 'binance/spot/bswap'
 require 'binance/spot/c2c'
+require 'binance/spot/convert'
 require 'binance/spot/fiat'
 require 'binance/spot/futures'
 require 'binance/spot/loan'
@@ -15,6 +16,7 @@ require 'binance/spot/margin'
 require 'binance/spot/market'
 require 'binance/spot/mining'
 require 'binance/spot/savings'
+require 'binance/spot/staking'
 require 'binance/spot/stream'
 require 'binance/spot/subaccount'
 require 'binance/spot/trade'
@@ -26,6 +28,7 @@ module Binance
   # - Blvt
   # - Bswap
   # - C2C
+  # - Convert
   # - Fiat
   # - Futures
   # - Loan
@@ -42,6 +45,7 @@ module Binance
     include Binance::Spot::Blvt
     include Binance::Spot::Bswap
     include Binance::Spot::C2C
+    include Binance::Spot::Convert
     include Binance::Spot::Fiat
     include Binance::Spot::Futures
     include Binance::Spot::Loan
@@ -49,6 +53,7 @@ module Binance
     include Binance::Spot::Market
     include Binance::Spot::Mining
     include Binance::Spot::Savings
+    include Binance::Spot::Staking
     include Binance::Spot::Stream
     include Binance::Spot::Subaccount
     include Binance::Spot::Trade

data/lib/binance/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binance-connector-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Binance
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,7 @@ files:
 - lib/binance/spot/blvt.rb
 - lib/binance/spot/bswap.rb
 - lib/binance/spot/c2c.rb
+- lib/binance/spot/convert.rb
 - lib/binance/spot/fiat.rb
 - lib/binance/spot/futures.rb
 - lib/binance/spot/loan.rb
@@ -118,6 +119,7 @@ files:
 - lib/binance/spot/market.rb
 - lib/binance/spot/mining.rb
 - lib/binance/spot/savings.rb
+- lib/binance/spot/staking.rb
 - lib/binance/spot/stream.rb
 - lib/binance/spot/subaccount.rb
 - lib/binance/spot/trade.rb
@@ -135,9 +137,7 @@ homepage: https://github.com/binance/binance-connector-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/binance/binance-connector-ruby
-  documentation_uri: https://binance-docs.github.io/apidocs/spot/en/
-  source_code_uri: https://github.com/binance/binance-connector-ruby
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: