Bitget APIBitget API
UTAClassic
Legacy Doc
  • Overview
  • API Documentation
  • WebSocket
  • Agent Hub
  • SDK
  • Changelog
Copied to clipboard
Earn
    On-chain Earn API
      Get Elite ProductgetGet Elite Subscribe InfogetElite SubscribepostGet Elite Subscribe ResultgetGet Redeem InfogetElite RedeempostGet Elite AssetsgetGet Elite Recordsget
    Cash+
      Get Cash+ Subscribe InfogetCash+ SubscribepostGet Cash+ Subscribe ResultgetGet Cash+ Redeem InfogetCash+ RedeempostGet Cash+ Redeem ResultgetGet Cash+ PositionsgetGet Cash+ History Ordersget
    Savings
      Get Savings Product ListgetSavings AccountgetSavings AssetsgetSavings RecordsgetSavings Subscription DetailgetSubscribe SavingspostSavings Subscription ResultgetRedeem SavingspostSavings Redemption Resultsget
    SharkFin
      Get Sharkfin ProductsgetSharkFin AccountgetSharkFin AssetsgetSharkFin RecordsgetSharkFin Subscription DetailgetSubscribe SharkFinpostSharkFin Subscription Resultget
Earn
Earn

On-chain Earn API

On-chain Earn API


Get Elite Product

GET
https://api.bitget.com
/api/v3/earn/elite-product

Rate limit: 5/sec/UID

Permission: UTA mgt. (read)

Query On-Chain Selected Product List

Get Elite Product › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object[]
productId
​string

Product ID

coin
​string

Coin name

minApr
​string

Minimum APR, in percentage format, e.g. 1.50 means 1.5%

maxApr
​string

Maximum APR, in percentage format, e.g. 1.50 means 1.5%

​object[]

List of subscription coins

subscriptionCoin
​string

Subscription coin

precision
​string

Subscription precision, positive integer. 1 means 1 decimal place

feeRate
​string

Fee rate

exchangeRate
​string

Exchange rate, in decimal format

sellOut
​string

Whether sold out: YES Sold out; NO Not sold out

GET/api/v3/earn/elite-product
curl https://api.bitget.com/api/v3/earn/elite-product
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1774530922891, "data": [ { "productId": "1216935633797513220", "coin": "BGUSD", "minApr": "4.00", "maxApr": "4.00", "subscriptionCoinList": [ { "subscriptionCoin": "USDC", "precision": "8", "feeRate": "0", "exchangeRate": "1" }, { "subscriptionCoin": "USDT", "precision": "8", "feeRate": "0", "exchangeRate": "0.99963927" } ], "sellOut": "NO" }, { "productId": "1216935633797513219", "coin": "BGBTC", "minApr": "0.80", "maxApr": "0.80", "subscriptionCoinList": [ { "subscriptionCoin": "BTC", "precision": "", "feeRate": "0", "exchangeRate": "1" } ], "sellOut": "NO" }, { "productId": "1216935633797513218", "coin": "BGSOL", "minApr": "5.93", "maxApr": "5.93", "subscriptionCoinList": [ { "subscriptionCoin": "SOL", "precision": "", "feeRate": "0", "exchangeRate": "1.14251924" } ], "sellOut": "NO" } ] }
json
application/json

Get Elite Subscribe Info

GET
https://api.bitget.com
/api/v3/earn/elite-subscribe-info

Rate limit: 5/sec/UID

Permission: UTA mgt. (read)

Query On-Chain Selected Subscription Details

Get Elite Subscribe Info › Request Parameters

productId
​string · required

Product ID

Get Elite Subscribe Info › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
productSubId
​string

Product sub-ID

minAmount
​string

Minimum subscription amount

remainQuota
​string

Remaining subscription quota

exchangeRate
​string

Exchange rate, only applicable to BGBTC / BGSOL

productCoin
​string

Product coin

interestTime
​string

Interest accrual start time in Unix milliseconds; only applicable to BGUSD / BGBTC

settleTime
​string

Interest distribution time in Unix milliseconds; only applicable to BGUSD / BGBTC

precision
​string

Subscription yield precision, positive integer. 1 means 1 decimal place

feeRate
​string

Fee rate

​object[]

List of subscription coins, only applicable to BGUSD

subscriptionCoin
​string

Subscription coin

remainQuota
​string

Remaining subscription quota

precision
​string

Subscription precision, positive integer. 1 means 1 decimal place

feeRate
​string

Fee rate

exchangeRate
​string

Exchange rate

GET/api/v3/earn/elite-subscribe-info
curl 'https://api.bitget.com/api/v3/earn/elite-subscribe-info?productId=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1774532838451, "data": { "productSubId": "1216935633814290435", "minAmount": "0.00000001", "remainQuota": "24995.76563944", "exchangeRate": "", "productCoin": "BGUSD", "interestTime": "1774540800000", "settleTime": "1774656000000", "precision": "8", "feeRate": "", "subscriptionCoinList": [ { "subscriptionCoin": "USDC", "precision": "8", "feeRate": "0", "exchangeRate": "1", "remainQuota": "24995.76563944", "minAmount": "0.1" }, { "subscriptionCoin": "USDT", "precision": "8", "feeRate": "0", "exchangeRate": "0.99979509", "remainQuota": "24995.76563944", "minAmount": "10" } ] } }
json
application/json

Elite Subscribe

POST
https://api.bitget.com
/api/v3/earn/elite-subscribe

Rate limit: 5/sec/UID

Permission: UTA mgt. (read & write)

Perform On-Chain Selected Product Subscription

Elite Subscribe › Request Parameters

productSubId
​string · required

Product sub-ID

amount
​string · required

Subscription amount

coin
​string

Subscription coin.

Required when subscribing to BGUSD. Can be USDT or USDC;

classic accounts support subscription with USDT/USDC; unified accounts only support subscription with USDC

paymentAccount
​string

Debit account:

spot Funding account;

unified Unified account (supported only in unified account mode);

if not provided, the default is the funding account

Elite Subscribe › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

Subscription Order ID

POST/api/v3/earn/elite-subscribe
curl 'https://api.bitget.com/api/v3/earn/elite-subscribe?productSubId=<string>&amount=<string>' \ --request POST
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1774534443629, "data": { "orderId": "142102777777777777" } }
json
application/json

Get Elite Subscribe Result

GET
https://api.bitget.com
/api/v3/earn/elite-subscribe-result

Rate limit: 5/sec/UID

Permission: UTA mgt. (read)

Query On-Chain Selected Subscription Result

Get Elite Subscribe Result › Request Parameters

orderId
​string · required

Subscription order ID

Get Elite Subscribe Result › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
result
​string

Subscription result:

settled Subscription successful;

pending Subscription in progress;

rejected Subscription failed

GET/api/v3/earn/elite-subscribe-result
curl 'https://api.bitget.com/api/v3/earn/elite-subscribe-result?orderId=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1774535103055, "data": { "result": "settled" } }
json
application/json

Get Redeem Info

GET
https://api.bitget.com
/api/v3/earn/elite-redeem-info

Rate limit: 5/sec/UID

Permission: UTA mgt. (read)

Query On-Chain Selected Redemption Information

Get Redeem Info › Request Parameters

productId
​string · required

Product ID

Get Redeem Info › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
productId
​string

Product ID

productSubId
​string

Product sub-ID

productCoin
​string

Product coin

subscriptionCoin
​string

Subscription coin

profitCoin
​string

Profit coin

exchangeRate
​string

Exchange rate, used for BGBTC/BGSOL

totalUnPayInterestAmount
​string

Total undistributed interest amount

preSettleApr
​string

Early settlement APR

receivedCoin
​string

Credited coin, used for BGBTC/BGSOL

unsettledPoints
​string

Unsettled points, available for BGBTC

​object[]

List of BGUSD credited coins, used for BGUSD

bgusdReceiveCoin
​string

BGUSD credited coin, used for BGUSD

bgusdExchangeRate
​string

BGUSD exchange rate, available for BGUSD

​object[]

Redemption mode list

redeemFeeRate
​string

Redemption fee rate

remainQuota
​string

Remaining quota

redeemType
​string

Redemption type:

fast Fast redemption;

standard Standard redemption

redeemScale
​string

Redemption precision

redeemDelayDate
​string

Redemption delayed crediting time

minRedeemAmount
​string

Minimum redemption amount

redeemTime
​string

Redemption time

GET/api/v3/earn/elite-redeem-info
curl 'https://api.bitget.com/api/v3/earn/elite-redeem-info?productId=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1774536688556, "data": { "productId": "1216935633797513220", "productSubId": "1216935633814290435", "productCoin": "BGUSD", "subscriptionCoin": "", "profitCoin": "", "exchangeRate": "", "totalUnPayInterestAmount": "", "preSettleApr": "", "receivedCoin": "", "unsettledPoints": "", "bgusdReceiveCoinList": [ { "bgusdReceiveCoin": "USDC", "bgusdExchangeRate": "1" }, { "bgusdReceiveCoin": "USDT", "bgusdExchangeRate": "1.00035041" } ], "redeemModeList": [ { "redeemFeeRate": "0.0005", "remainQuota": "9999.00000000", "redeemType": "fast", "redeemScale": "8", "redeemDelayDate": "10", "minRedeemAmount": "0.00000001", "redeemTime": "1774537288495" }, { "redeemFeeRate": "0.0005", "remainQuota": "10000000.00000000", "redeemType": "standard", "redeemScale": "8", "redeemDelayDate": "3", "minRedeemAmount": "0.00000001", "redeemTime": "1774795888542" } ] } }
json
application/json

Elite Redeem

POST
https://api.bitget.com
/api/v3/earn/elite-redeem

Rate limit: 5/sec/UID

Permission: UTA mgt. (read & write)

Perform On-Chain Selected Redemption

Elite Redeem › Request Parameters

productId
​string · required

Product ID

productSubId
​string · required

Product sub-ID

redeemType
​string · required

Redemption type

fast Fast redemption

standard Standard redemption - BGUSD supports both fast and standard redemption; BGSOL/BGBTC only support standard redemption

amount
​string · required

Subscription amount

receiveAccount
​string · required

Crediting account type

spot Funding account

unified Unified account (supported only in unified account mode)

advancedSettle
​string

Whether to redeem early

yes Yes

no No

Default value: no

Only applicable to BGBTC

coin
​string

Subscription currency - Required for BGUSD

Elite Redeem › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

Redemption Order ID

POST/api/v3/earn/elite-redeem
curl 'https://api.bitget.com/api/v3/earn/elite-redeem?productId=<string>&productSubId=<string>&redeemType=<string>&amount=<string>&receiveAccount=<string>' \ --request POST
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1774534443629, "data": { "orderId": "142102777777777777" } }
json
application/json

Get Elite Assets

GET
https://api.bitget.com
/api/v3/earn/elite-assets

Rate limit: 5/sec/UID

Permission: UTA mgt. (read)

Query On-Chain Selected Asset Information

Get Elite Assets › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

Asset list

productId
​string

Product ID

productCoin
​string

Product coin

holdingAmount
​string

Holdings

usdtHoldingAmount
​string

Holdings (in USDT equivalent)

exchangeRate
​string

Exchange rate

apr
​string

Annualized yield in percentage format, e.g. 4.20 means 4.20%; applicable to BGSOL / BGBTC

minApy
​string

Minimum APY, only applicable to BGUSD

maxApy
​string

Maximum APY, only applicable to BGUSD

subscriptionCoin
​string

Subscription coin

exchangeAmount
​string

Exchange amount

​object[]

Project list, only applicable to BGBTC

projectName
​string

Project name, only applicable to BGBTC

unsettledBGPoints
​string

Unsettled BG points, only applicable to BGBTC

interestCoin
​string

Interest distribution coin, only applicable to BGUSD

totalProfit
​string

Cumulative profit, only applicable to BGUSD

GET/api/v3/earn/elite-assets
curl https://api.bitget.com/api/v3/earn/elite-assets
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1774531452270, "data": { "resultList": [ { "productId": "1216935633797513220", "productCoin": "BGUSD", "holdingAmount": "3.23436056", "usdtHoldingAmount": "3.23553532", "exchangeRate": "1", "apr": "4.00", "subscriptionCoin": "USDC", "exchangeAmount": "3.23436056", "unsettledBGPoints": "", "interestCoin": "BGUSD", "totalProfit": "0.16769105" } ] } }
json
application/json

Get Elite Records

GET
https://api.bitget.com
/api/v3/earn/elite-records

Rate limit: 5/sec/UID

Permission: UTA mgt. (read)

Query On-Chain Selected History

Get Elite Records › Request Parameters

type
​string · required

Record type:

subscribe Subscription;

redeem Redemption;

interest Interest distribution

startTime
​string

Start timestamp in Unix milliseconds, e.g. 1597026383085;

the maximum time range supported is three months;

if not provided, the default end time is three months

endTime
​string

End timestamp in Unix milliseconds, e.g. 1597026383085

limit
​string

Number of records to query, default is 20, maximum is 100

cursor
​string

Cursor ID.

Request paginated content after this ID (updated data); the value passed should be the endId from the corresponding API

Get Elite Records › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

Record list

recordId
​string

Record ID

productId
​string

Product ID

coin
​string

Coin name

status
​string

Order status.

Subscription: settled Subscription successful, pending Subscription in progress, rejected Subscription failed;

Redemption: settled Redemption successful, pending Redemption in progress;

Interest distribution: settled Interest distribution successful, pending Interest distribution in progress

exchangeRate
​string

Exchange rate

receivedCoin
​string

Received coin

receivedAmount
​string

Received amount

investAmount
​string

Investment amount

feeRate
​string

Fee rate

redeemType
​string[]

Redemption type:

fast Fast redemption;

standard Standard redemption

receivingAccount
​string

Redemption account:

spot Funding account;

unified Unified account (supported only in unified account mode);

returned only when type=redeem

actualReceivingAccount
​string

Actual redemption account:

spot Funding account;

unified Unified account (supported only in unified account mode);

returned only when type=redeem

paymentAccount
​string[]

Payment account:

spot Funding account;

unified Unified account (supported only in unified account mode);

returned only when type=subscribe

settlePoints
​string

Settled points, returned only for BGBTC when type=interest

fee
​string

Fee, only applicable to type=redeem & type=subscribe

bizTime
​string

Business time

endId
​string

Cursor ID for next page (the smallest record ID in current page; pass it to cursor to query older records)

GET/api/v3/earn/elite-records
curl 'https://api.bitget.com/api/v3/earn/elite-records?type=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1774531930360, "data": { "recordList": [ { "recordId": "1421055362391416832", "productId": "1216935633797513218", "coin": "BGSOL", "status": "settled", "exchangeRate": "0.87525878", "receivedCoin": "BGSOL", "receivedAmount": "0.00875258", "investAmount": "0.01", "feeRate": "", "redeemType": "", "receivingAccount": "", "actualReceivingAccount": "", "paymentAccount": [ "spot" ], "settlePoints": "", "fee": "0", "bizTime": "1774531930360" } ], "endId": "1421055235278839808" } }
json
application/json

Cash+