binance-connector-ruby 1.5.2 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,13 +4,13 @@ module Binance
4
4
  class Spot
5
5
  # Mining endpoints
6
6
  # The endpoints below allow to interact with Binance Pool.
7
- # @see https://binance-docs.github.io/apidocs/spot/en/#mining-endpoints
7
+ # @see https://developers.binance.com/docs/mining/Introduction
8
8
  module Mining
9
9
  # Acquiring Algorithm (MARKET_DATA)
10
10
  #
11
11
  # GET /sapi/v1/mining/pub/algoList
12
12
  #
13
- # @see https://binance-docs.github.io/apidocs/spot/en/#acquiring-algorithm-market_data
13
+ # @see https://developers.binance.com/docs/mining/rest-api/Acquiring-Algorithm
14
14
  def mining_algo_list
15
15
  @session.limit_request(path: '/sapi/v1/mining/pub/algoList')
16
16
  end
@@ -19,7 +19,7 @@ module Binance
19
19
  #
20
20
  # GET /sapi/v1/mining/pub/coinList
21
21
  #
22
- # @see https://binance-docs.github.io/apidocs/spot/en/#acquiring-coinname-market_data
22
+ # @see https://developers.binance.com/docs/mining/rest-api/Acquiring-CoinName
23
23
  def mining_coin_list
24
24
  @session.limit_request(path: '/sapi/v1/mining/pub/coinList')
25
25
  end
@@ -33,7 +33,7 @@ module Binance
33
33
  # @param workerName [String]
34
34
  # @param kwargs [Hash]
35
35
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
36
- # @see https://binance-docs.github.io/apidocs/spot/en/#request-for-detail-miner-list-user_data
36
+ # @see https://developers.binance.com/docs/mining/rest-api/Request-for-Detail-Miner-List
37
37
  def mining_worker(algo:, userName:, workerName:, **kwargs)
38
38
  Binance::Utils::Validation.require_param('algo', algo)
39
39
  Binance::Utils::Validation.require_param('userName', userName)
@@ -58,7 +58,7 @@ module Binance
58
58
  # @option kwargs [String] :sortColumn
59
59
  # @option kwargs [String] :workerStatus
60
60
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
61
- # @see https://binance-docs.github.io/apidocs/spot/en/#request-for-miner-list-user_data
61
+ # @see https://developers.binance.com/docs/mining/rest-api/Request-for-Miner-List
62
62
  def mining_worker_list(algo:, userName:, **kwargs)
63
63
  Binance::Utils::Validation.require_param('algo', algo)
64
64
  Binance::Utils::Validation.require_param('userName', userName)
@@ -82,7 +82,7 @@ module Binance
82
82
  # @option kwargs [Integer] :pageIndex
83
83
  # @option kwargs [Integer] :pageSize
84
84
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
85
- # @see https://binance-docs.github.io/apidocs/spot/en/#earnings-list-user_data
85
+ # @see https://developers.binance.com/docs/mining/rest-api/Earnings-List
86
86
  def mining_revenue_list(algo:, userName:, **kwargs)
87
87
  Binance::Utils::Validation.require_param('algo', algo)
88
88
  Binance::Utils::Validation.require_param('userName', userName)
@@ -101,7 +101,7 @@ module Binance
101
101
  # @param userName [String]
102
102
  # @param kwargs [Hash]
103
103
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
104
- # @see https://binance-docs.github.io/apidocs/spot/en/#statistic-list-user_data
104
+ # @see https://developers.binance.com/docs/mining/rest-api/Statistic-List
105
105
  def mining_statistics_list(algo:, userName:, **kwargs)
106
106
  Binance::Utils::Validation.require_param('algo', algo)
107
107
  Binance::Utils::Validation.require_param('userName', userName)
@@ -120,7 +120,7 @@ module Binance
120
120
  # @param userName [String]
121
121
  # @param kwargs [Hash]
122
122
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
123
- # @see https://binance-docs.github.io/apidocs/spot/en/#account-list-user_data
123
+ # @see https://developers.binance.com/docs/mining/rest-api/Account-List
124
124
  def mining_account_list(algo:, userName:, **kwargs)
125
125
  Binance::Utils::Validation.require_param('algo', algo)
126
126
  Binance::Utils::Validation.require_param('userName', userName)
@@ -144,7 +144,7 @@ module Binance
144
144
  # @option kwargs [Integer] :pageIndex Page number, empty default first page, starting from 1
145
145
  # @option kwargs [Integer] :pageSize Number of pages, minimum 10, maximum 200
146
146
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
147
- # @see https://binance-docs.github.io/apidocs/spot/en/#extra-bonus-list-user_data
147
+ # @see https://developers.binance.com/docs/mining/rest-api/Extra-Bonus-List
148
148
  def mining_extra_bonus(algo:, userName:, **kwargs)
149
149
  Binance::Utils::Validation.require_param('algo', algo)
150
150
  Binance::Utils::Validation.require_param('userName', userName)
@@ -163,7 +163,7 @@ module Binance
163
163
  # @option kwargs [Integer] :pageIndex Page number, empty default first page, starting from 1
164
164
  # @option kwargs [Integer] :pageSize Number of pages, minimum 10, maximum 200
165
165
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
166
- # @see https://binance-docs.github.io/apidocs/spot/en/#hashrate-resale-list-user_data
166
+ # @see https://developers.binance.com/docs/mining/rest-api/Hashrate-Resale-List
167
167
  def mining_resale_list(**kwargs)
168
168
  @session.sign_request(:get, '/sapi/v1/mining/hash-transfer/config/details/list', params: kwargs)
169
169
  end
@@ -178,7 +178,7 @@ module Binance
178
178
  # @option kwargs [Integer] :pageIndex Page number, empty default first page, starting from 1
179
179
  # @option kwargs [Integer] :pageSize Number of pages, minimum 10, maximum 200
180
180
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
181
- # @see https://binance-docs.github.io/apidocs/spot/en/#hashrate-resale-detail-user_data
181
+ # @see https://developers.binance.com/docs/mining/rest-api/Hashrate-Resale-Detail
182
182
  def mining_resale_detail(configId:, userName:, **kwargs)
183
183
  Binance::Utils::Validation.require_param('configId', configId)
184
184
  Binance::Utils::Validation.require_param('userName', userName)
@@ -201,7 +201,7 @@ module Binance
201
201
  # @param hashRate [Integer] Resale hashrate h/s must be transferred (BTC is greater than 500000000000 ETH is greater than 500000)
202
202
  # @param kwargs [Hash]
203
203
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
204
- # @see https://binance-docs.github.io/apidocs/spot/en/#hashrate-resale-request-user_data
204
+ # @see https://developers.binance.com/docs/mining/rest-api/Hashrate-Resale-Request
205
205
  def mining_resale_request(userName:, algo:, startDate:, endDate:, toPoolUser:, hashRate:, **kwargs)
206
206
  Binance::Utils::Validation.require_param('userName', userName)
207
207
  Binance::Utils::Validation.require_param('algo', algo)
@@ -228,7 +228,7 @@ module Binance
228
228
  # @param userName [String] Mining Account
229
229
  # @param kwargs [Hash]
230
230
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
231
- # @see https://binance-docs.github.io/apidocs/spot/en/#cancel-hashrate-resale-configuration-user_data
231
+ # @see https://developers.binance.com/docs/mining/rest-api/Cancel-hashrate-resale-configuration
232
232
  def mining_resale_cancel(configId:, userName:, **kwargs)
233
233
  Binance::Utils::Validation.require_param('userName', userName)
234
234
  Binance::Utils::Validation.require_param('configId', configId)
@@ -3,7 +3,7 @@
3
3
  module Binance
4
4
  class Spot
5
5
  # all wallet endpoints
6
- # @see https://binance-docs.github.io/apidocs/spot/en/#wallet-endpoints
6
+ # @see https://developers.binance.com/docs/simple_earn/Introduction
7
7
  module SimpleEarn
8
8
  # Get Simple Earn Flexible Product List (USER_DATA)
9
9
  #
@@ -14,7 +14,7 @@ module Binance
14
14
  # @option kwargs [Integer] :current Currently querying page. Start from 1. Default:1
15
15
  # @option kwargs [Integer] :size Default:10, Max:100
16
16
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
17
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-simple-earn-flexible-product-list-user_data
17
+ # @see https://developers.binance.com/docs/simple_earn/account/Get-Simple-Earn-Flexible-Product-List
18
18
  def flexible_product_list(**kwargs)
19
19
  @session.sign_request(:get, '/sapi/v1/simple-earn/flexible/list', params: kwargs)
20
20
  end
@@ -28,7 +28,7 @@ module Binance
28
28
  # @option kwargs [Integer] :current Currently querying page. Start from 1. Default:1
29
29
  # @option kwargs [Integer] :size Default:10, Max:100
30
30
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
31
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-simple-earn-locked-product-list-user_data
31
+ # @see https://developers.binance.com/docs/simple_earn/account/Get-Simple-Earn-Locked-Product-List
32
32
  def locked_product_list(**kwargs)
33
33
  @session.sign_request(:get, '/sapi/v1/simple-earn/locked/list', params: kwargs)
34
34
  end
@@ -43,7 +43,7 @@ module Binance
43
43
  # @option kwargs [Boolean] :autoSubscribe true or false, default true
44
44
  # @option kwargs [String] :sourceAccount SPOT,FUND,ALL, default SPOT
45
45
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
46
- # @see https://binance-docs.github.io/apidocs/spot/en/#subscribe-flexible-product-trade
46
+ # @see https://developers.binance.com/docs/simple_earn/earn/Subscribe-Flexible-Product
47
47
  def flexible_subscribe(productId:, amount:, **kwargs)
48
48
  Binance::Utils::Validation.require_param('productId', productId)
49
49
  Binance::Utils::Validation.require_param('amount', amount)
@@ -64,7 +64,7 @@ module Binance
64
64
  # @option kwargs [Boolean] :autoSubscribe true or false, default true
65
65
  # @option kwargs [String] :sourceAccount SPOT,FUND,ALL, default SPOT
66
66
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
67
- # @see https://binance-docs.github.io/apidocs/spot/en/#subscribe-locked-product-trade
67
+ # @see https://developers.binance.com/docs/simple_earn/earn/Subscribe-Locked-Product
68
68
  def locked_subscribe(projectId:, amount:, **kwargs)
69
69
  Binance::Utils::Validation.require_param('projectId', projectId)
70
70
  Binance::Utils::Validation.require_param('amount', amount)
@@ -85,7 +85,7 @@ module Binance
85
85
  # @option kwargs [Float] :amount if redeemAll is false, amount is mandatory
86
86
  # @option kwargs [String] :destAccount SPOT,FUND,ALL, default SPOT
87
87
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
88
- # @see https://binance-docs.github.io/apidocs/spot/en/#redeem-flexible-product-trade
88
+ # @see https://developers.binance.com/docs/simple_earn/earn/Redeem-Flexible-Product
89
89
  def flexible_redeem_product(productId:, **kwargs)
90
90
  Binance::Utils::Validation.require_param('productId', productId)
91
91
 
@@ -101,7 +101,7 @@ module Binance
101
101
  # @param positionId [String]
102
102
  # @param kwargs [Hash]
103
103
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
104
- # @see https://binance-docs.github.io/apidocs/spot/en/#redeem-locked-product-trade
104
+ # @see https://developers.binance.com/docs/simple_earn/earn/Redeem-Locked-Product
105
105
  def locked_redeem_product(positionId:, **kwargs)
106
106
  Binance::Utils::Validation.require_param('positionId', positionId)
107
107
 
@@ -120,7 +120,7 @@ module Binance
120
120
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
121
121
  # @option kwargs [Integer] :size Default:10, Max:100
122
122
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
123
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-flexible-product-position-user_data
123
+ # @see https://developers.binance.com/docs/simple_earn/account/Get-Flexible-Product-Position
124
124
  def flexible_product_position(**kwargs)
125
125
  @session.sign_request(:get, '/sapi/v1/simple-earn/flexible/position', params: kwargs)
126
126
  end
@@ -136,7 +136,7 @@ module Binance
136
136
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
137
137
  # @option kwargs [Integer] :size Default:10, Max:100
138
138
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
139
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-locked-product-position-user_data
139
+ # @see https://developers.binance.com/docs/simple_earn/account/Get-Locked-Product-Position
140
140
  def locked_product_position(**kwargs)
141
141
  @session.sign_request(:get, '/sapi/v1/simple-earn/locked/position', params: kwargs)
142
142
  end
@@ -147,7 +147,7 @@ module Binance
147
147
  #
148
148
  # @param kwargs [Hash]
149
149
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
150
- # @see https://binance-docs.github.io/apidocs/spot/en/#simple-account-user_data
150
+ # @see https://developers.binance.com/docs/simple_earn/account/Simple-Account
151
151
  def simple_earn_account(**kwargs)
152
152
  @session.sign_request(:get, '/sapi/v1/simple-earn/account', params: kwargs)
153
153
  end
@@ -165,7 +165,7 @@ module Binance
165
165
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
166
166
  # @option kwargs [Integer] :size Default:10, Max:100
167
167
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
168
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-flexible-subscription-record-user_data
168
+ # @see https://developers.binance.com/docs/simple_earn/history/Get-Flexible-Subscription-Record
169
169
  def flexible_subscription_record(**kwargs)
170
170
  @session.sign_request(:get, '/sapi/v1/simple-earn/flexible/history/subscriptionRecord', params: kwargs)
171
171
  end
@@ -182,7 +182,7 @@ module Binance
182
182
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
183
183
  # @option kwargs [Integer] :size Default:10, Max:100
184
184
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
185
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-locked-subscription-record-user_data
185
+ # @see https://developers.binance.com/docs/simple_earn/history/Get-Locked-Subscription-Record
186
186
  def locked_subscription_record(**kwargs)
187
187
  @session.sign_request(:get, '/sapi/v1/simple-earn/locked/history/subscriptionRecord', params: kwargs)
188
188
  end
@@ -200,7 +200,7 @@ module Binance
200
200
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
201
201
  # @option kwargs [Integer] :size Default:10, Max:100
202
202
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
203
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-flexible-redemption-record-user_data
203
+ # @see https://developers.binance.com/docs/simple_earn/history/Get-Flexible-Redemption-Record
204
204
  def flexible_redemption_record(**kwargs)
205
205
  @session.sign_request(:get, '/sapi/v1/simple-earn/flexible/history/redemptionRecord', params: kwargs)
206
206
  end
@@ -218,7 +218,7 @@ module Binance
218
218
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
219
219
  # @option kwargs [Integer] :size Default:10, Max:100
220
220
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
221
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-locked-redemption-record-user_data
221
+ # @see https://developers.binance.com/docs/simple_earn/history/Get-Locked-Redemption-Record
222
222
  def locked_redemption_record(**kwargs)
223
223
  @session.sign_request(:get, '/sapi/v1/simple-earn/locked/history/redemptionRecord', params: kwargs)
224
224
  end
@@ -236,7 +236,7 @@ module Binance
236
236
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
237
237
  # @option kwargs [Integer] :size Default:10, Max:100
238
238
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
239
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-flexible-rewards-history-user_data
239
+ # @see https://developers.binance.com/docs/simple_earn/history/Get-Flexible-Rewards-History
240
240
  def flexible_rewards_history(type:, **kwargs)
241
241
  Binance::Utils::Validation.require_param('type', type)
242
242
 
@@ -255,7 +255,7 @@ module Binance
255
255
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
256
256
  # @option kwargs [Integer] :size Default:10, Max:100
257
257
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
258
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-locked-rewards-history-user_data
258
+ # @see https://developers.binance.com/docs/simple_earn/history/Get-Locked-Rewards-History
259
259
  def locked_rewards_history(**kwargs)
260
260
  @session.sign_request(:get, '/sapi/v1/simple-earn/locked/history/rewardsRecord', params: kwargs)
261
261
  end
@@ -268,7 +268,7 @@ module Binance
268
268
  # @param autoSubscribe [Boolean] true or false
269
269
  # @param kwargs [Hash]
270
270
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
271
- # @see https://binance-docs.github.io/apidocs/spot/en/#set-flexible-auto-subscribe-user_data
271
+ # @see https://developers.binance.com/docs/simple_earn/earn/Set-Flexible-Auto-Subscribe
272
272
  def flexible_auto_subscribe(productId:, autoSubscribe:, **kwargs)
273
273
  Binance::Utils::Validation.require_param('productId', productId)
274
274
  Binance::Utils::Validation.require_param('autoSubscribe', autoSubscribe)
@@ -287,7 +287,7 @@ module Binance
287
287
  # @param autoSubscribe [Boolean] true or false
288
288
  # @param kwargs [Hash]
289
289
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
290
- # @see https://binance-docs.github.io/apidocs/spot/en/#set-locked-auto-subscribe-user_data
290
+ # @see https://developers.binance.com/docs/simple_earn/earn/Set-Locked-Auto-Subscribe
291
291
  def locked_auto_subscribe(positionId:, autoSubscribe:, **kwargs)
292
292
  Binance::Utils::Validation.require_param('positionId', positionId)
293
293
  Binance::Utils::Validation.require_param('autoSubscribe', autoSubscribe)
@@ -305,7 +305,7 @@ module Binance
305
305
  # @param productId [String]
306
306
  # @param kwargs [Hash]
307
307
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
308
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-flexible-personal-left-quota-user_data
308
+ # @see https://developers.binance.com/docs/simple_earn/account/Get-Flexible-Personal-Left-Quota
309
309
  def flexible_personal_left_quota(productId:, **kwargs)
310
310
  Binance::Utils::Validation.require_param('productId', productId)
311
311
 
@@ -319,7 +319,7 @@ module Binance
319
319
  # @param projectId [String]
320
320
  # @param kwargs [Hash]
321
321
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
322
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-locked-personal-left-quota-user_data
322
+ # @see https://developers.binance.com/docs/simple_earn/account/Get-Locked-Personal-Left-Quota
323
323
  def locked_personal_left_quota(projectId:, **kwargs)
324
324
  Binance::Utils::Validation.require_param('projectId', projectId)
325
325
 
@@ -334,7 +334,7 @@ module Binance
334
334
  # @param amount [Float]
335
335
  # @param kwargs [Hash]
336
336
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
337
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-flexible-subscription-preview-user_data
337
+ # @see https://developers.binance.com/docs/simple_earn/earn/Get-Flexible-Subscription-Preview
338
338
  def flexible_subscription_preview(productId:, amount:, **kwargs)
339
339
  Binance::Utils::Validation.require_param('productId', productId)
340
340
  Binance::Utils::Validation.require_param('amount', amount)
@@ -354,7 +354,7 @@ module Binance
354
354
  # @param kwargs [Hash]
355
355
  # @option kwargs [Boolean] :autoSubscribe true or false, default true
356
356
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
357
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-locked-subscription-preview-user_data
357
+ # @see https://developers.binance.com/docs/simple_earn/earn/Get-Locked-Subscription-Preview
358
358
  def locked_subscription_preview(projectId:, amount:, **kwargs)
359
359
  Binance::Utils::Validation.require_param('projectId', projectId)
360
360
  Binance::Utils::Validation.require_param('amount', amount)
@@ -376,7 +376,7 @@ module Binance
376
376
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
377
377
  # @option kwargs [Integer] :size Default:10, Max:100
378
378
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
379
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-rate-history-user_data
379
+ # @see https://developers.binance.com/docs/simple_earn/history/Get-Rate-History
380
380
  def rate_history(productId:, **kwargs)
381
381
  Binance::Utils::Validation.require_param('productId', productId)
382
382
 
@@ -394,7 +394,7 @@ module Binance
394
394
  # @option kwargs [Integer] :current Currently querying the page. Start from 1. Default:1
395
395
  # @option kwargs [Integer] :size Default:10, Max:100
396
396
  # @option kwargs [Integer] :recvWindow The value cannot be greater than 60000
397
- # @see https://binance-docs.github.io/apidocs/spot/en/#get-collateral-record-user_data
397
+ # @see https://developers.binance.com/docs/simple_earn/history/Get-Collateral-Record
398
398
  def collateral_record(**kwargs)
399
399
  @session.sign_request(:get, '/sapi/v1/simple-earn/flexible/history/collateralRecord', params: kwargs)
400
400
  end
@@ -3,7 +3,7 @@
3
3
  module Binance
4
4
  class Spot
5
5
  # User data stream endpoints
6
- # @see https://binance-docs.github.io/apidocs/spot/en/#user-data-streams
6
+ # @see https://developers.binance.com/docs/binance-spot-api-docs/user-data-stream
7
7
  module Stream
8
8
  # Create a ListenKey (USER_STREAM)
9
9
  #