Skip to main content

Get Redeem Estimated Amount

info
  • Requires Earn permission on the API key.
  • This is a required prerequisite before placing a Redeem order. Pass the returned estRedeemAmount in doubleWinRedeemExtra when calling Place Order.

HTTP Request

GET/v5/earn/advance/get-redeem-est-amount-list

Request Parameters

ParameterRequiredTypeComments
categorytruestringProduct category. DoubleWin
positionIdstruestringComma-separated position IDs, max 5. e.g. 5001,5002

Response Parameters

ParameterTypeComments
listarrayObject
> successboolWhether the estimation succeeded for this position
> positionIdstringPosition ID
> estRedeemAmountstringEstimated redeem amount in investCoin
> estRedeemTimestringEstimated time to receive funds after redemption, Unix timestamp in ms
> slippageRatestringSlippage tolerance rate for this redemption, e.g. "0.05" = 5%

Request Example

GET /v5/earn/advance/get-redeem-est-amount-list?category=DoubleWin&positionIds=2847 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1672280218882
X-BAPI-RECV-WINDOW: 5000

Response Example

{
"retCode": 0,
"retMsg": "",
"result": {
"list": [
{
"success": false,
"positionId": "2847",
"estRedeemAmount": "0",
"estRedeemTime": "0",
"slippageRate": "0.9"
}
]
},
"retExtInfo": {},
"time": 1775107977370
}