Module: Staking

API staking endpoints

Source: restful/staking.js, line 5

Methods

stakingHistory(product, txnType, optionsopt)

Get Staking History (USER_DATA)

GET /sapi/v1/staking/stakingRecord

https://binance-docs.github.io/apidocs/spot/en/#get-staking-history-user_data

Parameters:

Name Type Attributes Description

product

string

STAKING - for Locked Staking, * F_DEFI - for flexible DeFi Staking, * L_DEFI - for locked DeFi Staking

txnType

string

SUBSCRIPTION, REDEMPTION, INTEREST

options

object

Properties

Name	Type	Attributes	Description
`asset`	string	<optional>
`startTime`	number	<optional>
`endTime`	number	<optional>
`current`	number	<optional>	Currently querying the page. Start from 1. Default:1
`size`	number	<optional>	Default:10, Max:100
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/staking.js, line 132

stakingProductList(product, optionsopt)

Get Staking Product List (USER_DATA)

GET /sapi/v1/staking/productList

https://binance-docs.github.io/apidocs/spot/en/#get-staking-product-list-user_data

Parameters:

Name Type Attributes Description

product

string

STAKING - for Locked Staking, * F_DEFI - for flexible DeFi Staking, * L_DEFI - for locked DeFi Staking

options

object

Properties

Name	Type	Attributes	Description
`asset`	string	<optional>
`current`	number	<optional>	Currently querying page. Start from 1. Default:1
`size`	number	<optional>	Default:10, Max:100
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/staking.js, line 25

stakingProductPosition(product, optionsopt)

Get Staking Product Position (USER_DATA)

GET /sapi/v1/staking/position

https://binance-docs.github.io/apidocs/spot/en/#get-staking-product-position-user_data

Parameters:

Name Type Attributes Description

product

string

STAKING - for Locked Staking, * F_DEFI - for flexible DeFi Staking, * L_DEFI - for locked DeFi Staking

options

object

Properties

Name	Type	Attributes	Description
`productId`	string	<optional>
`asset`	string	<optional>
`current`	number	<optional>	Currently querying the page. Start from 1. Default:1
`size`	number	<optional>	Default:10, Max:100
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/staking.js, line 104

stakingProductQuota(product, productId, optionsopt)

Get Personal Left Quota of Staking Product (USER_DATA)

GET /sapi/v1/staking/personalLeftQuota

https://binance-docs.github.io/apidocs/spot/en/#get-personal-left-quota-of-staking-product-user_data

Parameters:

Name Type Attributes Description

product

string

STAKING - for Locked Staking, * F_DEFI - for flexible DeFi Staking, * L_DEFI - for locked DeFi Staking

productId string

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/staking.js, line 182

stakingPurchaseProduct(product, productId, amount, optionsopt)

Purchase Staking Product (USER_DATA)

POST /sapi/v1/staking/purchase

https://binance-docs.github.io/apidocs/spot/en/#purchase-staking-product-user_data

Parameters:

Name Type Attributes Description

product

string

STAKING - for Locked Staking, * F_DEFI - for flexible DeFi Staking, * L_DEFI - for locked DeFi Staking

productId string

amount number

options

object

Properties

Name	Type	Attributes	Description
`renewable`	string	<optional>	true or false, default false. Active if product is `STAKING` or `L_DEFI`
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/staking.js, line 50

stakingRedeemProduct(product, productId, optionsopt)

Redeem Staking Product (USER_DATA)

POST /sapi/v1/staking/redeem

https://binance-docs.github.io/apidocs/spot/en/#redeem-staking-product-user_data

Parameters:

Name Type Attributes Description

product

string

STAKING - for Locked Staking, * F_DEFI - for flexible DeFi Staking, * L_DEFI - for locked DeFi Staking

productId string

options

object

Properties

Name	Type	Attributes	Description
`positionId`	string	<optional>	Mandatory if product is `STAKING` or `L_DEFI`
`amount`	number	<optional>	Mandatory if product is `F_DEFI`
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/staking.js, line 77

stakingSetAutoStaking(product, positionId, renewable, optionsopt)

Set Auto Staking (USER_DATA)

POST /sapi/v1/staking/setAutoStaking

https://binance-docs.github.io/apidocs/spot/en/#set-auto-staking-user_data

Parameters:

Name Type Attributes Description

product

string

STAKING - for Locked Staking, * L_DEFI - for locked DeFi Staking

positionId string

renewable

string

true or false

options

object

Properties

Name	Type	Attributes	Description
`recvWindow`	number	<optional>	The value cannot be greater than 60000

Source: restful/staking.js, line 157