API Simple Earn endpoints

Parameters:
NameTypeDescription
superclass*
Source

Methods

getCollateralRecord(optionsopt)

Get Collateral Record (USER_DATA)

GET /sapi/v1/simple-earn/flexible/history/collateralRecord

https://developers.binance.com/docs/simple_earn/history/Get-Collateral-Record

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
productIdstring<optional>
startTimenumber<optional>
endTimenumber<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getFlexiblePersonalLeftQuota(productId, optionsopt)

Get Flexible Personal Left Quota (USER_DATA)

GET /sapi/v1/simple-earn/flexible/personalLeftQuota

https://developers.binance.com/docs/simple_earn/account/Get-Flexible-Personal-Left-Quota

Parameters:
NameTypeAttributesDescription
productIdstring
optionsobject<optional>
Properties
NameTypeAttributesDescription
recvWindownumber<optional>
Source

getFlexibleProductList(optionsopt)

Get Simple Earn Flexible Product List (USER_DATA)

GET /sapi/v1/simple-earn/flexible/list

https://developers.binance.com/docs/simple_earn/account/Get-Simple-Earn-Flexible-Product-List

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
assetstring<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getFlexibleProductPosition(optionsopt)

Get Flexible Product Position (USER_DATA)

GET /sapi/v1/simple-earn/flexible/position

https://developers.binance.com/docs/simple_earn/account/Get-Flexible-Product-Position

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
assetstring<optional>
productIdstring<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getFlexibleRedemptionRecord(optionsopt)

Get Flexible Redemption Record (USER_DATA)

GET /sapi/v1/simple-earn/flexible/history/redemptionRecord

https://developers.binance.com/docs/simple_earn/history/Get-Flexible-Redemption-Record

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
productIdstring<optional>
redeemIdstring<optional>
assetstring<optional>
startTimenumber<optional>
endTimenumber<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getFlexibleRewardsRecord(type, optionsopt)

Get Flexible Rewards History (USER_DATA)

GET /sapi/v1/simple-earn/flexible/history/rewardsRecord

https://developers.binance.com/docs/simple_earn/history/Get-Flexible-Rewards-History

Parameters:
NameTypeAttributesDescription
typestring
optionsobject<optional>
Properties
NameTypeAttributesDescription
productIdstring<optional>
assetstring<optional>
startTimenumber<optional>
endTimenumber<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getFlexibleSubscriptionPreview(productId, amount, optionsopt)

Get Flexible Subscription Preview (USER_DATA)

GET /sapi/v1/simple-earn/flexible/subscriptionPreview

https://developers.binance.com/docs/simple_earn/earn/Get-Flexible-Subscription-Preview

Parameters:
NameTypeAttributesDescription
productIdstring
amountnumber
optionsobject<optional>
Properties
NameTypeAttributesDescription
recvWindownumber<optional>
Source

getFlexibleSubscriptionRecord(optionsopt)

Get Flexible Subscription Record (USER_DATA)

GET /sapi/v1/simple-earn/flexible/history/subscriptionRecord

https://developers.binance.com/docs/simple_earn/history/Get-Flexible-Subscription-Record

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
productIdstring<optional>
purchaseIdstring<optional>
assetstring<optional>
startTimenumber<optional>
endTimenumber<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getLockedPersonalLeftQuota(projectId, optionsopt)

Get Locked Personal Left Quota (USER_DATA)

GET /sapi/v1/simple-earn/locked/personalLeftQuota

https://developers.binance.com/docs/simple_earn/account/Get-Locked-Personal-Left-Quota

Parameters:
NameTypeAttributesDescription
projectIdstring
optionsobject<optional>
Properties
NameTypeAttributesDescription
recvWindownumber<optional>
Source

getLockedProductList(optionsopt)

Get Simple Earn Locked Product List (USER_DATA)

GET /sapi/v1/simple-earn/locked/list

https://developers.binance.com/docs/simple_earn/account/Get-Simple-Earn-Locked-Product-List

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
assetstring<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getLockedProductPosition(optionsopt)

Get Locked Product Position (USER_DATA)

GET /sapi/v1/simple-earn/locked/position

https://developers.binance.com/docs/simple_earn/account/Get-Locked-Product-Position

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
assetstring<optional>
positionIdstring<optional>
projectIdstring<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getLockedRedemptionRecord(optionsopt)

Get Locked Redemption Record (USER_DATA)

GET /sapi/v1/simple-earn/locked/history/redemptionRecord

https://developers.binance.com/docs/simple_earn/history/Get-Locked-Redemption-Record

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
positionIdstring<optional>
redeemIdstring<optional>
assetstring<optional>
startTimenumber<optional>
endTimenumber<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getLockedRewardsRecord(optionsopt)

Get Locked Rewards History (USER_DATA)

GET /sapi/v1/simple-earn/locked/history/rewardsRecord

https://developers.binance.com/docs/simple_earn/history/Get-Locked-Rewards-History

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
positionIdstring<optional>
assetstring<optional>
startTimenumber<optional>
endTimenumber<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getLockedSubscriptionPreview(projectId, amount, optionsopt)

Get Locked Subscription Preview (USER_DATA)

GET /sapi/v1/simple-earn/locked/subscriptionPreview

https://developers.binance.com/docs/simple_earn/earn/Get-Locked-Subscription-Preview

Parameters:
NameTypeAttributesDescription
projectIdstring
amountnumber
optionsobject<optional>
Properties
NameTypeAttributesDescription
autoSubscribeboolean<optional>
recvWindownumber<optional>
Source

getLockedSubscriptionRecord(optionsopt)

Get Locked Subscription Record (USER_DATA)

GET /sapi/v1/simple-earn/locked/history/subscriptionRecord

https://developers.binance.com/docs/simple_earn/history/Get-Locked-Subscription-Record

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
purchaseIdstring<optional>
assetstring<optional>
startTimenumber<optional>
endTimenumber<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getRateHistory(productId, optionsopt)

Get Rate History (USER_DATA)

GET /sapi/v1/simple-earn/flexible/history/rateHistory

https://developers.binance.com/docs/simple_earn/history/Get-Rate-History

Parameters:
NameTypeAttributesDescription
productIdstring
optionsobject<optional>
Properties
NameTypeAttributesDescription
startTimenumber<optional>
endTimenumber<optional>
currentnumber<optional>
sizenumber<optional>
recvWindownumber<optional>
Source

getSimpleAccount(optionsopt)

Get Simple Account (USER_DATA)

GET /sapi/v1/simple-earn/account

https://developers.binance.com/docs/simple_earn/account/Simple-Account

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDescription
recvWindownumber<optional>
Source

redeemFlexibleProduct(productId, optionsopt)

Redeem Flexible Product (TRADE)

POST /sapi/v1/simple-earn/flexible/redeem

https://developers.binance.com/docs/simple_earn/earn/Redeem-Flexible-Product

Parameters:
NameTypeAttributesDescription
productIdstring
optionsobject<optional>
Properties
NameTypeAttributesDescription
redeemAllboolean<optional>

// true or false, default to false

amountnumber<optional>

// if redeemAll is false, amount is mandatory

destAccountstring<optional>
recvWindownumber<optional>
Source

redeemLockedProduct(positionId, optionsopt)

Redeem Locked Product (TRADE)

POST /sapi/v1/simple-earn/locked/redeem

https://developers.binance.com/docs/simple_earn/earn/Redeem-Locked-Product

Parameters:
NameTypeAttributesDescription
positionIdstring
optionsobject<optional>
Properties
NameTypeAttributesDescription
recvWindownumber<optional>
Source

setFlexibleAutoSubscribe(productId, autoSubscribe, optionsopt)

Set Flexible Auto Subscribe (USER_DATA)

POST /sapi/v1/simple-earn/flexible/setAutoSubscribe

https://developers.binance.com/docs/simple_earn/earn/Set-Flexible-Auto-Subscribe

Parameters:
NameTypeAttributesDescription
productIdstring
autoSubscribeboolean
optionsobject<optional>
Properties
NameTypeAttributesDescription
recvWindownumber<optional>
Source

setLockedAutoSubscribe(positionId, autoSubscribe, optionsopt)

Set Locked Auto Subscribe (USER_DATA)

POST /sapi/v1/simple-earn/locked/setAutoSubscribe

https://developers.binance.com/docs/simple_earn/earn/Set-Locked-Auto-Subscribe

Parameters:
NameTypeAttributesDescription
positionIdstring
autoSubscribeboolean
optionsobject<optional>
Properties
NameTypeAttributesDescription
recvWindownumber<optional>
Source

subscribeFlexibleProduct(productId, amount, optionsopt)

Subscribe Flexible Product (TRADE)

POST /sapi/v1/simple-earn/flexible/subscribe

https://developers.binance.com/docs/simple_earn/earn/Subscribe-Flexible-Product

Parameters:
NameTypeAttributesDescription
productIdstring
amountnumber
optionsobject<optional>
Properties
NameTypeAttributesDescription
autoSubscribeboolean<optional>
sourceAccountstring<optional>
recvWindownumber<optional>
Source

subscribeLockedProduct(projectId, amount, optionsopt)

Subscribe Locked Product (TRADE)

POST /sapi/v1/simple-earn/locked/subscribe

https://developers.binance.com/docs/simple_earn/earn/Subscribe-Locked-Product

Parameters:
NameTypeAttributesDescription
projectIdstring
amountnumber
optionsobject<optional>
Properties
NameTypeAttributesDescription
autoSubscribeboolean<optional>
sourceAccountstring<optional>
recvWindownumber<optional>
Source