StakingApi: Staking operations
| StakingApi | R Documentation |
Staking operations
Description
binanceRapi.Staking
Format
An R6Class generator object
Methods
SapiV1StakingPersonalLeftQuotaGet Get Personal Left Quota of Staking Product (USER_DATA) Weight(IP): 1
-
@param product character
-
@param product.id character
-
@param timestamp integer
-
@param signature character
-
@param recv.window integer
-
@returnType list( inline_response_200_100 )
status code : 200 | Quota.
return type : array[InlineResponse200100]
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1StakingPositionGet Get Staking Product Position (USER_DATA) Weight(IP): 1
-
@param product character
-
@param timestamp integer
-
@param signature character
-
@param product.id character
-
@param asset character
-
@param current integer
-
@param size integer
-
@param recv.window integer
-
@returnType list( inline_response_200_98 )
status code : 200 | Position.
return type : array[InlineResponse20098]
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1StakingProductListGet Get Staking Product List (USER_DATA) Get available Staking product list. Weight(IP): 1
-
@param product character
-
@param timestamp integer
-
@param signature character
-
@param asset character
-
@param current integer
-
@param size integer
-
@param recv.window integer
-
@returnType list( inline_response_200_95 )
status code : 200 | Product list.
return type : array[InlineResponse20095]
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1StakingPurchasePost Purchase Staking Product (USER_DATA) Weight(IP): 1
-
@param product character
-
@param product.id character
-
@param amount numeric
-
@param timestamp integer
-
@param signature character
-
@param renewable character
-
@param recv.window integer
-
@returnType InlineResponse20096
status code : 200 | Position Id.
return type : InlineResponse20096
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1StakingRedeemPost Redeem Staking Product (USER_DATA) Redeem Staking product. Locked staking and Locked DeFI staking belong to early redemption, redeeming in advance will result in loss of interest that you have earned. Weight(IP): 1
-
@param product character
-
@param product.id character
-
@param timestamp integer
-
@param signature character
-
@param position.id character
-
@param amount numeric
-
@param recv.window integer
-
@returnType InlineResponse20097
status code : 200 | Success.
return type : InlineResponse20097
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1StakingSetAutoStakingPost Set Auto Staking (USER_DATA) Set auto staking on Locked Staking or Locked DeFi Staking Weight(IP): 1
-
@param product character
-
@param position.id character
-
@param renewable character
-
@param timestamp integer
-
@param signature character
-
@param recv.window integer
-
@returnType InlineResponse20097
status code : 200 | Success.
return type : InlineResponse20097
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
SapiV1StakingStakingRecordGet Get Staking History (USER_DATA) Weight(IP): 1
-
@param product character
-
@param txn.type character
-
@param timestamp integer
-
@param signature character
-
@param asset character
-
@param start.time integer
-
@param end.time integer
-
@param current integer
-
@param size integer
-
@param recv.window integer
-
@returnType list( inline_response_200_99 )
status code : 200 | Staking History.
return type : array[InlineResponse20099]
response headers :
status code : 400 | Bad Request
return type : Error
response headers :
status code : 401 | Unauthorized Request
return type : Error
response headers :
Public fields
apiClientHandles the client-server communication.
Methods
Public methods
Method new()
Usage
StakingApi$new(apiClient)
Method SapiV1StakingPersonalLeftQuotaGet()
Usage
StakingApi$SapiV1StakingPersonalLeftQuotaGet( product, product.id, timestamp, signature, recv.window = NULL, ... )
Method SapiV1StakingPersonalLeftQuotaGetWithHttpInfo()
Usage
StakingApi$SapiV1StakingPersonalLeftQuotaGetWithHttpInfo( product, product.id, timestamp, signature, recv.window = NULL, ... )
Method SapiV1StakingPositionGet()
Usage
StakingApi$SapiV1StakingPositionGet( product, timestamp, signature, product.id = NULL, asset = NULL, current = NULL, size = NULL, recv.window = NULL, ... )
Method SapiV1StakingPositionGetWithHttpInfo()
Usage
StakingApi$SapiV1StakingPositionGetWithHttpInfo( product, timestamp, signature, product.id = NULL, asset = NULL, current = NULL, size = NULL, recv.window = NULL, ... )
Method SapiV1StakingProductListGet()
Usage
StakingApi$SapiV1StakingProductListGet( product, timestamp, signature, asset = NULL, current = NULL, size = NULL, recv.window = NULL, ... )
Method SapiV1StakingProductListGetWithHttpInfo()
Usage
StakingApi$SapiV1StakingProductListGetWithHttpInfo( product, timestamp, signature, asset = NULL, current = NULL, size = NULL, recv.window = NULL, ... )
Method SapiV1StakingPurchasePost()
Usage
StakingApi$SapiV1StakingPurchasePost( product, product.id, amount, timestamp, signature, renewable = NULL, recv.window = NULL, ... )
Method SapiV1StakingPurchasePostWithHttpInfo()
Usage
StakingApi$SapiV1StakingPurchasePostWithHttpInfo( product, product.id, amount, timestamp, signature, renewable = NULL, recv.window = NULL, ... )
Method SapiV1StakingRedeemPost()
Usage
StakingApi$SapiV1StakingRedeemPost( product, product.id, timestamp, signature, position.id = NULL, amount = NULL, recv.window = NULL, ... )
Method SapiV1StakingRedeemPostWithHttpInfo()
Usage
StakingApi$SapiV1StakingRedeemPostWithHttpInfo( product, product.id, timestamp, signature, position.id = NULL, amount = NULL, recv.window = NULL, ... )
Method SapiV1StakingSetAutoStakingPost()
Usage
StakingApi$SapiV1StakingSetAutoStakingPost( product, position.id, renewable, timestamp, signature, recv.window = NULL, ... )
Method SapiV1StakingSetAutoStakingPostWithHttpInfo()
Usage
StakingApi$SapiV1StakingSetAutoStakingPostWithHttpInfo( product, position.id, renewable, timestamp, signature, recv.window = NULL, ... )
Method SapiV1StakingStakingRecordGet()
Usage
StakingApi$SapiV1StakingStakingRecordGet( product, txn.type, timestamp, signature, asset = NULL, start.time = NULL, end.time = NULL, current = NULL, size = NULL, recv.window = NULL, ... )
Method SapiV1StakingStakingRecordGetWithHttpInfo()
Usage
StakingApi$SapiV1StakingStakingRecordGetWithHttpInfo( product, txn.type, timestamp, signature, asset = NULL, start.time = NULL, end.time = NULL, current = NULL, size = NULL, recv.window = NULL, ... )
Method clone()
The objects of this class are cloneable with this method.
Usage
StakingApi$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
## Not run: #################### SapiV1StakingPersonalLeftQuotaGet #################### library(binanceRapi) var.product <- 'product_example' # character | * `STAKING` - for Locked Staking * `F_DEFI` - for flexible DeFi Staking * `L_DEFI` - for locked DeFi Staking var.product.id <- 'product.id_example' # character | var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Get Personal Left Quota of Staking Product (USER_DATA) api.instance <- StakingApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1StakingPersonalLeftQuotaGet(var.product, var.product.id, var.timestamp, var.signature, recv.window=var.recv.window) #################### SapiV1StakingPositionGet #################### library(binanceRapi) var.product <- 'product_example' # character | * `STAKING` - for Locked Staking * `F_DEFI` - for flexible DeFi Staking * `L_DEFI` - for locked DeFi Staking var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.product.id <- 'product.id_example' # character | var.asset <- 'BNB' # character | var.current <- 1 # integer | Current querying page. Start from 1. Default:1 var.size <- 100 # integer | Default:10 Max:100 var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Get Staking Product Position (USER_DATA) api.instance <- StakingApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1StakingPositionGet(var.product, var.timestamp, var.signature, product.id=var.product.id, asset=var.asset, current=var.current, size=var.size, recv.window=var.recv.window) #################### SapiV1StakingProductListGet #################### library(binanceRapi) var.product <- 'product_example' # character | * `STAKING` - for Locked Staking * `F_DEFI` - for flexible DeFi Staking * `L_DEFI` - for locked DeFi Staking var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.asset <- 'BNB' # character | var.current <- 1 # integer | Current querying page. Start from 1. Default:1 var.size <- 100 # integer | Default:10 Max:100 var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Get Staking Product List (USER_DATA) api.instance <- StakingApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1StakingProductListGet(var.product, var.timestamp, var.signature, asset=var.asset, current=var.current, size=var.size, recv.window=var.recv.window) #################### SapiV1StakingPurchasePost #################### library(binanceRapi) var.product <- 'product_example' # character | * `STAKING` - for Locked Staking * `F_DEFI` - for flexible DeFi Staking * `L_DEFI` - for locked DeFi Staking var.product.id <- 'product.id_example' # character | var.amount <- 1.01 # numeric | var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.renewable <- 'renewable_example' # character | true or false, default false. Active if product is `STAKING` or `L_DEFI` var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Purchase Staking Product (USER_DATA) api.instance <- StakingApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1StakingPurchasePost(var.product, var.product.id, var.amount, var.timestamp, var.signature, renewable=var.renewable, recv.window=var.recv.window) #################### SapiV1StakingRedeemPost #################### library(binanceRapi) var.product <- 'product_example' # character | * `STAKING` - for Locked Staking * `F_DEFI` - for flexible DeFi Staking * `L_DEFI` - for locked DeFi Staking var.product.id <- 'product.id_example' # character | var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.position.id <- 'position.id_example' # character | Mandatory if product is `STAKING` or `L_DEFI` var.amount <- 3.4 # numeric | Mandatory if product is `F_DEFI` var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Redeem Staking Product (USER_DATA) api.instance <- StakingApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1StakingRedeemPost(var.product, var.product.id, var.timestamp, var.signature, position.id=var.position.id, amount=var.amount, recv.window=var.recv.window) #################### SapiV1StakingSetAutoStakingPost #################### library(binanceRapi) var.product <- 'product_example' # character | * `STAKING` - for Locked Staking * `L_DEFI` - for locked DeFi Staking var.position.id <- 'position.id_example' # character | var.renewable <- 'renewable_example' # character | true or false var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Set Auto Staking (USER_DATA) api.instance <- StakingApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1StakingSetAutoStakingPost(var.product, var.position.id, var.renewable, var.timestamp, var.signature, recv.window=var.recv.window) #################### SapiV1StakingStakingRecordGet #################### library(binanceRapi) var.product <- 'product_example' # character | * `STAKING` - for Locked Staking * `F_DEFI` - for flexible DeFi Staking * `L_DEFI` - for locked DeFi Staking var.txn.type <- 'txn.type_example' # character | `SUBSCRIPTION`, `REDEMPTION`, `INTEREST` var.timestamp <- 56 # integer | UTC timestamp in ms var.signature <- 'signature_example' # character | Signature var.asset <- 'BNB' # character | var.start.time <- 56 # integer | UTC timestamp in ms var.end.time <- 56 # integer | UTC timestamp in ms var.current <- 1 # integer | Current querying page. Start from 1. Default:1 var.size <- 100 # integer | Default:10 Max:100 var.recv.window <- 5000 # integer | The value cannot be greater than 60000 #Get Staking History (USER_DATA) api.instance <- StakingApi$new() #Configure API key authorization: ApiKeyAuth api.instance$apiClient$apiKeys['X-MBX-APIKEY'] <- 'TODO_YOUR_API_KEY'; result <- api.instance$SapiV1StakingStakingRecordGet(var.product, var.txn.type, var.timestamp, var.signature, asset=var.asset, start.time=var.start.time, end.time=var.end.time, current=var.current, size=var.size, recv.window=var.recv.window) ## End(Not run)
