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
Earn
Earn

Cash+

Cash+


Get Cash+ Subscribe Info

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

Rate limit: 10/sec/UID

Permission: UTA mgt. (read)

Query the subscription prerequisites of Cash+, including the annualized rate and the subscribable coin list.

Get Cash+ Subscribe Info › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
profitSourceCoin
​string

Coin the profit is sourced from
Currently USDGO

cashPlusApr
​string

Current Cash+ annualized rate
Expressed as a decimal: 0.04 means 4%

​object[]

List of subscribable coins

interestTime
​string

Interest accrual start time, Unix millisecond timestamp

payInterestTime
​string

Interest distribution time, Unix millisecond timestamp

subscribeTime
​string

Subscription time, Unix millisecond timestamp

GET/api/v3/earn/cashplus/subscribe-info
curl https://api.bitget.com/api/v3/earn/cashplus/subscribe-info
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1789368447497, "data": { "profitSourceCoin": "USDGO", "cashPlusApr": "0.04", "subscribeCoinList": [ { "productSubId": "1358292433724211201", "coin": "USDT", "minAmount": "10", "conversionRate": "1", "subscribeScale": "2", "profitScale": "8", "soldOut": "no" }, { "productSubId": "1358292433724211202", "coin": "USDC", "minAmount": "10", "conversionRate": "1", "subscribeScale": "2", "profitScale": "8", "soldOut": "no" } ], "interestTime": "1789368447497", "payInterestTime": "1789454847497", "subscribeTime": "1789368447497" } }
json
application/json

Cash+ Subscribe

POST
https://api.bitget.com
/api/v3/earn/cashplus/subscribe

Rate limit: 1/sec/UID

Permission: UTA mgt. (read & write)

Subscribe to Cash+ with the selected coin and amount.

Cash+ Subscribe › Request Parameters

productSubId
​string · required

Product sub-ID
Obtained from subscribe-info

amount
​number · required

Subscription amount, in the subscription coin

accountType
​string

Debit account type
funding Funding account
uta Unified account
otc OTC account
Multiple values are supported, separated by commas (for example funding,uta). Defaults to the funding account when omitted

idempotentNo
​string

Idempotency ID, used to prevent duplicate submissions

Cash+ Subscribe › Response Parameters

200

Successful response

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

Subscription order ID, used to query the subscription result

POST/api/v3/earn/cashplus/subscribe
curl https://api.bitget.com/api/v3/earn/cashplus/subscribe \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "productSubId": "productSubId", "amount": 0, "accountType": "accountType", "idempotentNo": "idempotentNo" }'
Example Request Body
{ "productSubId": "productSubId", "amount": 0, "accountType": "accountType", "idempotentNo": "idempotentNo" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1789368447497, "data": { "orderId": "1483284264811290624" } }
json
application/json

Get Cash+ Subscribe Result

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

Rate limit: 10/sec/UID

Permission: UTA mgt. (read)

Query the result of a Cash+ subscription order.

Get Cash+ Subscribe Result › Request Parameters

orderId
​string · required

Order ID returned by the subscription API

Get Cash+ Subscribe Result › Response Parameters

200

Successful response

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

Subscription order ID

status
​string

Subscription order status
processing In progress
success Subscription successful
failed Subscription failed

coin
​string

Subscription coin

amount
​string

Subscription amount

subscribeTime
​string

Subscription time, Unix millisecond timestamp

interestTime
​string

Interest accrual start time, Unix millisecond timestamp

dividendTime
​string

First interest distribution time, Unix millisecond timestamp

​object[]

List of payment accounts

GET/api/v3/earn/cashplus/subscribe-result
curl 'https://api.bitget.com/api/v3/earn/cashplus/subscribe-result?orderId=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1789368447497, "data": { "orderId": "1483284264811290624", "status": "success", "coin": "USDT", "amount": "100", "subscribeTime": "1789368447497", "interestTime": "1789368447497", "dividendTime": "1789454847497", "paymentAccountList": [ { "accountType": "funding", "payAmount": "60" }, { "accountType": "uta", "payAmount": "40" } ] } }
json
application/json

Get Cash+ Redeem Info

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

Rate limit: 10/sec/UID

Permission: UTA mgt. (read)

Query the redemption prerequisites of Cash+, including the redeemable coin list and the redeemable position.

Get Cash+ Redeem Info › Response Parameters

200

Successful response

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

List of coins credited on redemption

userRemainingQuota
​string

Remaining redemption quota of the user for today

GET/api/v3/earn/cashplus/redeem-info
curl https://api.bitget.com/api/v3/earn/cashplus/redeem-info
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1789368447497, "data": { "redeemCoinList": [ { "productSubId": "1358292433724211201", "coin": "USDT", "conversionRate": "1", "redeemAvailable": "100.00000000", "redeemMinAmount": "0.01", "redeemScale": "2", "redeemTime": "1789368447497", "receivedTime": "1789372047497" } ], "userRemainingQuota": "50000" } }
json
application/json

Cash+ Redeem

POST
https://api.bitget.com
/api/v3/earn/cashplus/redeem

Rate limit: 1/sec/UID

Permission: UTA mgt. (read & write)

Redeem Cash+ into the selected coin.

Cash+ Redeem › Request Parameters

productSubId
​string · required

Product sub-ID

amount
​string · required

Amount of Cash+ to redeem

accountType
​string

Credit account type
funding Funding account
uta Unified account
Defaults to the funding account when omitted

Cash+ Redeem › Response Parameters

200

Successful response

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

Redemption order ID, used to query the redemption result

redeemTime
​integer · int64

Redemption request time, Unix millisecond timestamp

receiveTime
​integer · int64

Estimated arrival time, Unix millisecond timestamp

POST/api/v3/earn/cashplus/redeem
curl https://api.bitget.com/api/v3/earn/cashplus/redeem \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "productSubId": "productSubId", "amount": "amount", "accountType": "accountType" }'
Example Request Body
{ "productSubId": "productSubId", "amount": "amount", "accountType": "accountType" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1789368447497, "data": { "orderId": "1483284264811290624", "redeemTime": 1789368447497, "receiveTime": 1789368447497 } }
json
application/json

Get Cash+ Redeem Result

GET
https://api.bitget.com
/api/v3/earn/cashplus/redeem-result

Rate limit: 10/sec/UID

Permission: UTA mgt. (read)

Query the result of a Cash+ redemption order.

Get Cash+ Redeem Result › Request Parameters

orderId
​string · required

Order ID returned by the redemption API

Get Cash+ Redeem Result › Response Parameters

200

Successful response

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

Redemption order ID

status
​string

Redemption status
processing In progress
success Redemption successful
failed Redemption failed

redeemTime
​string

Redemption request time, Unix millisecond timestamp

receiveTime
​string

Estimated arrival time, Unix millisecond timestamp

GET/api/v3/earn/cashplus/redeem-result
curl 'https://api.bitget.com/api/v3/earn/cashplus/redeem-result?orderId=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1789368447497, "data": { "orderId": "1483284264811290624", "status": "success", "redeemTime": "1789368447497", "receiveTime": "1789368447497" } }
json
application/json

Get Cash+ Positions

GET
https://api.bitget.com
/api/v3/earn/cashplus/positions

Rate limit: 10/sec/UID

Permission: UTA mgt. (read)

Query the user's Cash+ holding.

Get Cash+ Positions › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
balance
​string

Cash+ holding
Converted to USD amount

totalProfit
​string

Cumulative profit
Converted to USD amount

yesterdayProfit
​string

Profit from yesterday
Converted to USD amount

apr
​string

Annualized rate of return
A compound annual rate for reference

GET/api/v3/earn/cashplus/positions
curl https://api.bitget.com/api/v3/earn/cashplus/positions
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1789368447497, "data": { "balance": "100.00", "totalProfit": "0.05", "yesterdayProfit": "0.01", "apr": "0.04" } }
json
application/json

Get Cash+ History Orders

GET
https://api.bitget.com
/api/v3/earn/cashplus/history-orders

Rate limit: 10/sec/UID

Permission: UTA mgt. (read)

Query the Cash+ history records with cursor-based pagination.

Get Cash+ History Orders › Request Parameters

startTime
​string

Query start time, Unix millisecond timestamp

endTime
​string

Query end time, Unix millisecond timestamp

recordType
​string

Record type
subscribe Subscription
redeem Redemption
compound_interest Compound interest
liquidation_redeem Liquidation redemption

limit
​string

Number of entries per page
Default 20, maximum 100

cursor
​string

Cursor ID
Pass the nextCursor returned by the previous page to fetch the next page. Omit it for the first page

Get Cash+ History Orders › Response Parameters

200

Successful response

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

Record list

nextCursor
​string

Cursor ID of the next page

GET/api/v3/earn/cashplus/history-orders
curl https://api.bitget.com/api/v3/earn/cashplus/history-orders
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1789368447497, "data": { "items": [ { "recordId": "1483284264811290624", "recordType": "subscribe", "status": "success", "amount": "100", "coin": "USDT", "createdTime": 1789368447497, "accountType": "funding" } ], "nextCursor": "1483284264811290623" } }
json
application/json

On-chain Earn API