Skip to main content

Get Coupon List

info
  • Authentication required.
  • Rate Limit: 10 req/s (UID)

Query the user's interest-rate coupons (interestCards) and Dual Assets reward cards (awardCards, e.g. trial funds / zero-cost vouchers) for the given product category.

Returned cards include all states: InUse, NotUse, Expired, and AlreadyUsed.

To apply a coupon when placing an order, pass its awardId and specCode in the interestCard field of the corresponding place-order request:

HTTP Request

GET/v5/earn/coupons

Request Parameters

ParameterRequiredTypeComments
categorytruestringProduct category: FlexibleSaving, DualAssets

Response Parameters

ParameterTypeComments
interestCardsarrayInterest-rate coupon list
> awardIdintegerCoupon unique ID
> specCodestringCoupon spec code
> coinstringCoin name, e.g. USDT, BTC
> apystringBonus APY rate as a decimal string, e.g. "0.03" = 3%
> durationintegerCoupon validity period (days)
> claimedAtintegerClaim time (Unix seconds)
> expireAtintegerExpiry time (Unix seconds)
> usedAtintegerUse time (Unix seconds); 0 if not yet used
> statusstringCoupon status. InUse: currently in use, NotUse: claimed but not yet used, Expired: expired without being used, AlreadyUsed: used and settled
> currentPnlstringBonus interest accrued so far
> limitPnlstringBonus interest cap
> positionEffectiveAmountstringEffective principal amount for the bonus calculation
> productIdintegerLinked product ID; populated for InUse / AlreadyUsed, 0 otherwise
> categorystringProduct category the coupon applies to: FlexibleSaving, DualAssets
awardCardsarrayDual Assets reward card list (trial fund / zero-cost voucher)
> awardIdintegerReward card unique ID
> specCodestringReward card spec code
> claimedAtintegerClaim time (Unix seconds)
> usedAtintegerUse time (Unix seconds); 0 if not yet used
> expireAtintegerExpiry time (Unix seconds)
> statusstringCard status. Same semantics as interestCards > status
> amountstringTrial / zero-cost voucher amount
> limitPnlPercentagestringPnL percentage cap, e.g. "0.23" = 23%
> baseCoinstringBase coin name
> quoteCoinstringQuote coin name
> directionintegerDual Assets direction: 1 = BuyLow, 2 = SellHigh
> categorystringProduct category the card applies to: FlexibleSaving, DualAssets

Request Example

GET /v5/earn/coupons?category=FlexibleSaving HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1759983699446
X-BAPI-RECV-WINDOW: 5000

Response Example

{
"retCode": 0,
"retMsg": "OK",
"result": {
"interestCards": [
{
"awardId": 1001,
"specCode": "FS_APY_3PCT_30D",
"coin": "USDT",
"apy": "0.03",
"duration": 30,
"claimedAt": 1759900800,
"expireAt": 1762492800,
"usedAt": 0,
"status": "NotUse",
"currentPnl": "0",
"limitPnl": "100",
"positionEffectiveAmount": "0",
"productId": 0,
"category": "FlexibleSaving"
}
],
"awardCards": []
},
"retExtInfo": {},
"time": 1759983699446
}