Flexible & Locked

Endpoint

Get Collateral Record (USER_DATA)

Get Collateral Record

GET

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

https://api.binance.com

Get Collateral Record (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Collateral Record (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Get Collateral Record (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Collateral Record (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

productId

string

Example: 1

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

current

integer · int64 · min: 1

Currently querying page.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Collateral Record (USER_DATA) › Responses

200

Get Collateral Record

object[]

amount

string

Example: 100.00000000

productId

string

Example: BUSD001

asset

string

Example: USDT

createTime

integer · int64

Example: 1575018510000

type

string

Example: REPAY

productName

string

Example: USDT

orderId

integer · int64

Example: 26055

total

string

Example: 1

Get Flexible Personal Left Quota (USER_DATA)

Get Flexible Personal Left Quota

GET

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

https://api.binance.com

Get Flexible Personal Left Quota (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Flexible Personal Left Quota (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Flexible Personal Left Quota (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Flexible Personal Left Quota (USER_DATA) › Query Parameters

productId

string · required

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Flexible Personal Left Quota (USER_DATA) › Responses

200

Get Flexible Personal Left Quota

leftPersonalQuota

string

Example: 1000

Get Flexible Product Position (USER_DATA)

Get Flexible Product Position

GET

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

https://api.binance.com

Get Flexible Product Position (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Flexible Product Position (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Flexible Product Position (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Flexible Product Position (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

asset

string

Example: USDC

productId

string

Example: 1

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Flexible Product Position (USER_DATA) › Responses

200

Get Flexible Product Position

object[]

totalAmount

string

Example: 75.46000000

object

0-5BTC

number · float

Example: 0.05

5-10BTC

number · float

Example: 0.03

latestAnnualPercentageRate

string

Example: 0.02599895

yesterdayAirdropPercentageRate

string

Example: 0.02599895

asset

string

Example: USDT

airDropAsset

string

Example: BETH

canRedeem

boolean

Example: true

collateralAmount

string

Example: 232.23123213

productId

string

Example: USDT001

yesterdayRealTimeRewards

string

Example: 0.10293829

cumulativeBonusRewards

string

Example: 0.22759183

cumulativeRealTimeRewards

string

Example: 0.22759183

cumulativeTotalRewards

string

Example: 0.45459183

autoSubscribe

boolean

Example: true

total

integer · int64

Example: 1

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

curl --request GET \
  --url 'https://api.binance.com/sapi/v1/simple-earn/flexible/position?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "rows": [
    {
      "totalAmount": "75.46000000",
      "tierAnnualPercentageRate": {
        "0-5BTC": 0.05,
        "5-10BTC": 0.03
      },
      "latestAnnualPercentageRate": "0.02599895",
      "yesterdayAirdropPercentageRate": "0.02599895",
      "asset": "USDT",
      "airDropAsset": "BETH",
      "canRedeem": true,
      "collateralAmount": "232.23123213",
      "productId": "USDT001",
      "yesterdayRealTimeRewards": "0.10293829",
      "cumulativeBonusRewards": "0.22759183",
      "cumulativeRealTimeRewards": "0.22759183",
      "cumulativeTotalRewards": "0.45459183",
      "autoSubscribe": true
    }
  ],
  "total": 1
}

json

application/json

Get Flexible Redemption Record (USER_DATA)

Get Flexible Redemption Record

GET

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

https://api.binance.com

Get Flexible Redemption Record (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Flexible Redemption Record (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Flexible Redemption Record (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Flexible Redemption Record (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

productId

string

Example: 1

redeemId

string

Example: 1

asset

string

Example: USDC

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Flexible Redemption Record (USER_DATA) › Responses

200

Get Flexible Redemption Record

object[]

amount

string

Example: 10.54000000

asset

string

Example: USDT

time

integer · int64

Example: 1577257222000

projectId

string

Example: USDT001

redeemId

integer · int64

Example: 40607

destAccount

string

Example: SPOT

status

string

Example: PAID

total

integer · int64

Example: 1

Get Flexible Rewards History (USER_DATA)

Get Flexible Rewards History

GET

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

https://api.binance.com

Get Flexible Rewards History (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Flexible Rewards History (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Flexible Rewards History (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Flexible Rewards History (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

productId

string

Example: 1

asset

string

Example: USDC

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

type

string · enum

BONUS - Bonus tiered APR, REALTIME - Real-time APR, REWARDS - Historical rewards, ALL - All types. Default: ALL

Enum values:

BONUS

REALTIME

REWARDS

ALL

Example: ALL

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Flexible Rewards History (USER_DATA) › Responses

200

Get Flexible Rewards History

object[]

asset

string

Example: BUSD

rewards

string

Example: 0.00006408

projectId

string

Example: USDT001

type

string

Example: BONUS

time

integer · int64

Example: 1577233578000

total

integer · int64

Example: 2

Get Flexible Subscription Preview (USER_DATA)

Get Flexible Subscription Preview

GET

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

https://api.binance.com

Get Flexible Subscription Preview (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Flexible Subscription Preview (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Flexible Subscription Preview (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Flexible Subscription Preview (USER_DATA) › Query Parameters

productId

string · required

Example: 1

amount

number · float · required

Example: 1.0

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Flexible Subscription Preview (USER_DATA) › Responses

200

Get Flexible Subscription Preview

totalAmount

string

Example: 1232.32230982

rewardAsset

string

Example: BUSD

airDropAsset

string

Example: BETH

estDailyBonusRewards

string

Example: 0.22759183

estDailyRealTimeRewards

string

Example: 0.22759183

estDailyAirdropRewards

string

Example: 0.22759183

Get Flexible Subscription Record (USER_DATA)

Get Flexible Subscription Record

GET

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

https://api.binance.com

Get Flexible Subscription Record (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Flexible Subscription Record (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Flexible Subscription Record (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Flexible Subscription Record (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

productId

string

Example: 1

purchaseId

string

Example: 1

asset

string

Example: USDC

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Flexible Subscription Record (USER_DATA) › Responses

200

Get Flexible Subscription Record

object[]

amount

string

Example: 100.00000000

asset

string

Example: USDT

time

integer · int64

Example: 1575018510000

purchaseId

integer · int64

Example: 26055

productId

string

Example: USDT001

type

string

Example: AUTO

sourceAccount

string

Example: SPOT

amtFromSpot

string

Example: 30

amtFromFunding

string

Example: 70

status

string

Example: SUCCESS

total

integer · int64

Example: 1

Get Locked Personal Left Quota (USER_DATA)

Get Locked Personal Left Quota

GET

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

https://api.binance.com

Get Locked Personal Left Quota (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Locked Personal Left Quota (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Locked Personal Left Quota (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Locked Personal Left Quota (USER_DATA) › Query Parameters

projectId

string · required

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Locked Personal Left Quota (USER_DATA) › Responses

200

Get Locked Personal Left Quota

leftPersonalQuota

string

Example: 1000

Get Locked Product Position (USER_DATA)

Get Locked Product Position

GET

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

https://api.binance.com

Get Locked Product Position (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Locked Product Position (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Locked Product Position (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Locked Product Position (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

asset

string

Example: USDC

positionId

string

Example: 1

projectId

string

Example: 1

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Locked Product Position (USER_DATA) › Responses

200

Get Locked Product Position

object[]

positionId

integer · int64

Example: 123123

parentPositionId

integer · int64

Example: 123122

projectId

string

Example: Axs*90

asset

string

Example: AXS

amount

string

Example: 122.09202928

purchaseTime

integer · int64

Example: 1646182276000

duration

string

Example: 60

accrualDays

string

Example: 4

rewardAsset

string

Example: AXS

APY

string

Example: 0.2032

rewardAmt

string

Example: 5.17181528

extraRewardAsset

string

Example: BNB

extraRewardAPR

string

Example: 0.0203

estExtraRewardAmt

string

Example: 5.17181528

boostRewardAsset

string

Example: AXS

boostApr

string

Example: 0.0121

totalBoostRewardAmt

string

Example: 3.98201829

nextPay

string

Example: 1.29295383

nextPayDate

integer · int64

Example: 1646697600000

payPeriod

string

Example: 1

redeemAmountEarly

string

Example: 2802.24068892

rewardsEndDate

integer · int64

Example: 1651449600000

deliverDate

integer · int64

Example: 1651536000000

redeemPeriod

string

Example: 1

redeemingAmt

string

Example: 232.2323

redeemTo

string

Example: FLEXIBLE

partialAmtDeliverDate

integer · int64

Example: 1651536000000

canRedeemEarly

boolean

Example: true

canFastRedemption

boolean

Example: true

autoSubscribe

boolean

Example: true

type

string

Example: AUTO

status

string

Example: HOLDING

canReStake

boolean

Example: true

total

integer · int64

Example: 1

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

curl --request GET \
  --url 'https://api.binance.com/sapi/v1/simple-earn/locked/position?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "rows": [
    {
      "positionId": 123123,
      "parentPositionId": 123122,
      "projectId": "Axs*90",
      "asset": "AXS",
      "amount": "122.09202928",
      "purchaseTime": 1646182276000,
      "duration": "60",
      "accrualDays": "4",
      "rewardAsset": "AXS",
      "APY": "0.2032",
      "rewardAmt": "5.17181528",
      "extraRewardAsset": "BNB",
      "extraRewardAPR": "0.0203",
      "estExtraRewardAmt": "5.17181528",
      "boostRewardAsset": "AXS",
      "boostApr": "0.0121",
      "totalBoostRewardAmt": "3.98201829",
      "nextPay": "1.29295383",
      "nextPayDate": 1646697600000,
      "payPeriod": "1",
      "redeemAmountEarly": "2802.24068892",
      "rewardsEndDate": 1651449600000,
      "deliverDate": 1651536000000,
      "redeemPeriod": "1",
      "redeemingAmt": "232.2323",
      "redeemTo": "FLEXIBLE",
      "partialAmtDeliverDate": 1651536000000,
      "canRedeemEarly": true,
      "canFastRedemption": true,
      "autoSubscribe": true,
      "type": "AUTO",
      "status": "HOLDING",
      "canReStake": true
    }
  ],
  "total": 1
}

json

application/json

Get Locked Redemption Record (USER_DATA)

Get Locked Redemption Record

GET

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

https://api.binance.com

Get Locked Redemption Record (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Locked Redemption Record (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Locked Redemption Record (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Locked Redemption Record (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

positionId

string

Example: 1

redeemId

string

Example: 1

asset

string

Example: USDC

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Locked Redemption Record (USER_DATA) › Responses

200

Get Locked Redemption Record

object[]

positionId

integer · int64

Example: 123123

redeemId

integer · int64

Example: 40607

time

integer · int64

Example: 1575018510000

asset

string

Example: BNB

lockPeriod

string

Example: 30

amount

string

Example: 21312.23223

originalAmount

string

Example: 21312.23223

type

string

Example: MATURE

deliverDate

integer · int64

Example: 1575018510000

lossAmount

string

Example: 0.00001232

isComplete

boolean

Example: true

rewardAsset

string

Example: AXS

rewardAmt

string

Example: 5.17181528

extraRewardAsset

string

Example: BNB

estExtraRewardAmt

string

Example: 5.17181528

status

string

Example: PAID

total

integer · int64

Example: 1

Get Locked Rewards History (USER_DATA)

Get Locked Rewards History

GET

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

https://api.binance.com

Get Locked Rewards History (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Locked Rewards History (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Locked Rewards History (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Locked Rewards History (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

positionId

string

Example: 1

asset

string

Example: USDC

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Locked Rewards History (USER_DATA) › Responses

200

Get Locked Rewards History

object[]

positionId

integer · int64

Example: 123123

time

integer · int64

Example: 1575018510000

asset

string

Example: BNB

lockPeriod

string

Example: 30

amount

string

Example: 21312.23223

type

string

Example: Locked Rewards

total

integer · int64

Example: 1

Get Locked Subscription Preview (USER_DATA)

Get Locked Subscription Preview

GET

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

https://api.binance.com

Get Locked Subscription Preview (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Locked Subscription Preview (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Locked Subscription Preview (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Locked Subscription Preview (USER_DATA) › Query Parameters

projectId

string · required

Example: 1

amount

number · float · required

Example: 1.0

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

autoSubscribe

boolean

default true.

Example: true

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Locked Subscription Preview (USER_DATA) › Responses

200

Get Locked Subscription Preview

object

rewardAsset

string

Example: AXS

totalRewardAmt

string

Example: 5.17181528

extraRewardAsset

string

Example: BNB

estTotalExtraRewardAmt

string

Example: 5.17181528

boostRewardAsset

string

Example: AXS

estDailyRewardAmt

string

Example: 1.20928901

nextPay

string

Example: 1.29295383

nextPayDate

integer · int64

Example: 1646697600000

valueDate

integer · int64

Example: 1646697600000

rewardsEndDate

integer · int64

Example: 1651449600000

deliverDate

integer · int64

Example: 1651536000000

nextSubscriptionDate

integer · int64

Example: 1651536000000

Get Locked Subscription Record (USER_DATA)

Get Locked Subscription Record

GET

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

https://api.binance.com

Get Locked Subscription Record (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Locked Subscription Record (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Locked Subscription Record (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Locked Subscription Record (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

purchaseId

string

Example: 1

asset

string

Example: USDC

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Locked Subscription Record (USER_DATA) › Responses

200

Get Locked Subscription Record

object[]

positionId

integer · int64

Example: 123123

purchaseId

string

Example: 26055

projectId

string

Example: Axs*90

time

integer · int64

Example: 1575018510000

asset

string

Example: BNB

amount

string

Example: 21312.23223

lockPeriod

string

Example: 30

type

string

Example: AUTO

sourceAccount

string

Example: SPOT

amtFromSpot

string

Example: 30

amtFromFunding

string

Example: 70

status

string

Example: SUCCESS

total

integer · int64

Example: 1

Get Rate History (USER_DATA)

Get Rate History

GET

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

https://api.binance.com

Get Rate History (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Rate History (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Rate History (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Rate History (USER_DATA) › Query Parameters

productId

string · required

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

aprPeriod

string · enum

Enum values:

DAY

YEAR

Example: DAY

Default: DAY

startTime

integer · int64

Example: 1623319461670

endTime

integer · int64

Example: 1641782889000

current

integer · int64 · min: 1

Currently querying page

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Rate History (USER_DATA) › Responses

200

Get Rate History

object[]

productId

string

Example: BUSD001

asset

string

Example: BUSD

annualPercentageRate

string

Example: 0.00006408

time

integer · int64

Example: 1577233578000

total

string

Example: 1

Get Simple Earn Flexible Product List (USER_DATA)

Get available Simple Earn flexible product list

GET

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

https://api.binance.com

Get Simple Earn Flexible Product List (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Simple Earn Flexible Product List (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Simple Earn Flexible Product List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Simple Earn Flexible Product List (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

asset

string

Example: USDC

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Simple Earn Flexible Product List (USER_DATA) › Responses

200

Get Simple Earn Flexible Product List

object[]

asset

string

Example: BTC

latestAnnualPercentageRate

string

Example: 0.05000000

object

0-5BTC

number · float

Example: 0.05

5-10BTC

number · float

Example: 0.03

airDropPercentageRate

string

Example: 0.05000000

canPurchase

boolean

Example: true

canRedeem

boolean

Example: true

isSoldOut

boolean

Example: true

hot

boolean

Example: true

minPurchaseAmount

string

Example: 0.01000000

productId

string

Example: BTC001

subscriptionStartTime

integer · int64

Example: 1646182276000

status

string

Example: PURCHASING

total

integer · int64

Example: 1

Get Simple Earn Locked Product List (USER_DATA)

Get Simple Earn Locked Product List

GET

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

https://api.binance.com

Get Simple Earn Locked Product List (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Get Simple Earn Locked Product List (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Get Simple Earn Locked Product List (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Get Simple Earn Locked Product List (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

asset

string

Example: USDC

current

integer · int64 · min: 1

Currently querying page. Starts from 1.

Example: 1

Default: 1

size

integer · int64 · max: 100

Number of results per page.

Example: 10

Default: 10

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Get Simple Earn Locked Product List (USER_DATA) › Responses

200

Get Simple Earn Locked Product List

object[]

projectId

string

Example: Axs*90

object

asset

string

Example: AXS

rewardAsset

string

Example: AXS

duration

integer · int64

Example: 90

renewable

boolean

Example: true

isSoldOut

boolean

Example: true

apr

string

Example: 1.2069

status

string

Example: CREATED

subscriptionStartTime

integer · int64

Example: 1646182276000

extraRewardAsset

string

Example: BNB

extraRewardAPR

string

Example: 0.23

boostRewardAsset

string

Example: AXS

boostApr

string

Example: 0.0121

boostEndTime

integer · int64

Example: 1646182276000

object

totalPersonalQuota

string

Example: 2

minimum

string

Example: 0.001

total

integer · int64

Example: 1

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

curl --request GET \
  --url 'https://api.binance.com/sapi/v1/simple-earn/locked/list?timestamp=%3Cnumber%3E' \
  --header 'X-MBX-APIKEY: <string>'

Example Responses

{
  "rows": [
    {
      "projectId": "Axs*90",
      "detail": {
        "asset": "AXS",
        "rewardAsset": "AXS",
        "duration": 90,
        "renewable": true,
        "isSoldOut": true,
        "apr": "1.2069",
        "status": "CREATED",
        "subscriptionStartTime": 1646182276000,
        "extraRewardAsset": "BNB",
        "extraRewardAPR": "0.23",
        "boostRewardAsset": "AXS",
        "boostApr": "0.0121",
        "boostEndTime": 1646182276000
      },
      "quota": {
        "totalPersonalQuota": "2",
        "minimum": "0.001"
      }
    }
  ],
  "total": 1
}

json

application/json

Redeem Flexible Product (TRADE)

Redeem Flexible Product

POST

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

https://api.binance.com

Redeem Flexible Product (TRADE) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Redeem Flexible Product (TRADE) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Redeem Flexible Product (TRADE) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Redeem Flexible Product (TRADE) › Request Body

productId

string · required

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

redeemAll

boolean

Example: false

Default: false

amount

number · float

if redeemAll is false, amount is mandatory

Example: 1.0

destAccount

string · enum

Enum values:

SPOT

FUND

Example: SPOT

Default: SPOT

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Redeem Flexible Product (TRADE) › Responses

200

Redeem Flexible Product

redeemId

integer · int64

Example: 40607

success

boolean

Example: true

Redeem Locked Product (TRADE)

Redeem Locked Product

POST

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

https://api.binance.com

Redeem Locked Product (TRADE) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Redeem Locked Product (TRADE) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

Redeem Locked Product (TRADE) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Redeem Locked Product (TRADE) › Request Body

positionId

string · required

Locked product position ID

Example: 1

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Redeem Locked Product (TRADE) › Responses

200

Redeem Locked Product

redeemId

integer · int64

Example: 40607

success

boolean

Example: true

Set Flexible Auto Subscribe

POST

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

https://api.binance.com

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

productId

string · required

Example: 1

autoSubscribe

boolean · required

Example: true

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

200

Set Flexible Auto Subscribe

success

boolean

Example: true

Set locked auto subscribe

POST

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

https://api.binance.com

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

positionId

string · required

Example: 1

autoSubscribe

boolean · required

Example: true

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

200

Set Locked Auto Subscribe

success

boolean

Example: true

Set Locked Product Redeem Option (USER_DATA)

Set redeem option for Locked product

POST

/sapi/v1/simple-earn/locked/setRedeemOption

https://api.binance.com

Set Locked Product Redeem Option (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Set Locked Product Redeem Option (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight50

Set Locked Product Redeem Option (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Set Locked Product Redeem Option (USER_DATA) › Request Body

positionId

string · required

Example: 1

redeemTo

string · enum · required

Enum values:

SPOT

FLEXIBLE

Example: SPOT

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

Set Locked Product Redeem Option (USER_DATA) › Responses

200

Set Locked Product Redeem Option

success

boolean

Example: true

Simple Account (USER_DATA)

Simple Account query

GET

/sapi/v1/simple-earn/account

https://api.binance.com

Simple Account (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Simple Account (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight150

Simple Account (USER_DATA) › Headers

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

Simple Account (USER_DATA) › Query Parameters

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

recvWindow

integer · int64 · max: 60000

The value cannot be greater than 60000 (ms)

Example: 5000

Simple Account (USER_DATA) › Responses

200

Simple Account

totalAmountInBTC

string

Example: 0.01067982

totalAmountInUSDT

string

Example: 77.13289230

totalFlexibleAmountInBTC

string

Example: 0.00000000

totalFlexibleAmountInUSDT

string

Example: 0.00000000

totalLockedInBTC

string

Example: 0.01067982

totalLockedInUSDT

string

Example: 77.13289230

Subscribe Flexible Product

POST

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

https://api.binance.com

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

productId

string · required

Example: 1

amount

number · float · required

Example: 1.0

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

autoSubscribe

boolean

Example: true

Default: true

sourceAccount

string · enum

Enum values:

SPOT

FUND

ALL

Example: SPOT

Default: SPOT

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

200

Subscribe Flexible Product

purchaseId

integer · int64

Example: 40607

success

boolean

Example: true

Subscribe Locked Product

POST

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

https://api.binance.com

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight1

X-MBX-APIKEY

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

projectId

string · required

Example: 1

amount

number · float · required

Example: 1.0

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

autoSubscribe

boolean

Example: false

Default: false

sourceAccount

string · enum

Enum values:

SPOT

FUND

ALL

Example: SPOT

Default: SPOT

redeemTo

string · enum

Enum values:

SPOT

FLEXIBLE

Example: SPOT

Default: SPOT

recvWindow

integer · int64 · max: 60000

Request validity window in milliseconds.

Example: 5000

200

Subscribe Locked Product

purchaseId

integer · int64

Example: 40607

positionId

string

Example: 12345

success

boolean

Example: true