Bitget APIBitget API
UTAClassic
Legacy Doc
  • Overview
  • API Documentation
  • WebSocket
  • Agent Hub
  • SDK
  • Changelog
Copied to clipboard
API Document
Classic Earn
    Savings
      Get Savings Product ListgetSavings AccountgetSavings AssetsgetSavings RecordsgetSavings Subscription DetailgetSubscribe SavingspostSavings Subscription ResultgetRedeem SavingspostSavings Redemption Resultsget
Classic Earn Savings
Classic Earn Savings

Savings

Classic Account — Savings


Get Savings Product List

GET
https://api.bitget.com
/api/v2/earn/savings/product

Rate limit: 10/sec/UID

Get savings product list.

Get Savings Product List › Request Parameters

coin
​string

Coin e.g. BTC

filter
​string

Filter conditions

available Available for subscription

held Held

available_and_held Available for subscription and held

all Query all including those that have been removed from the shelves

Get Savings Product List › Response Parameters

200

Successful response

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

Product id

coin
​string

Savings subscription coin

periodType
​string

Period type

flexible flexible period

fixed fixed period

period
​string

Period

flexible This value is not returned

apyType
​string

Interest rate type

single single interest rate

ladder ladder income

advanceRedeem
​string

Whether early redemption is allowed

Yes allowed

No not allowed

settleMethod
​string

Settlement method

daily daily interest and daily settlement

maturity repayment of principal and interest at maturity

​object[]

Ladder interest rate information

status
​string

Product status

not_started Warming up

in_progress Subscribing

paused Paused

completed Ended

sold_out Sold out

off_line Off line

productLevel
​string

Product level

beginner beginner product

normal normal product

VIP VIP product

GET/api/v2/earn/savings/product
curl https://api.bitget.com/api/v2/earn/savings/product
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696747382760, "data": [ { "productId": "12313123", "coin": "BGB", "periodType": "flexible", "period": "", "apyType": "ladder", "advanceRedeem": "", "settleMethod": "", "apyList": [ { "rateLevel": "0", "minStepVal": "0.000000", "maxStepVal": "200.000000", "currentApy": "6.00" }, { "rateLevel": "1", "minStepVal": "200.000000", "maxStepVal": "5000.000000", "currentApy": "50.00" } ], "status": "in_progress", "productLevel": "normal" } ] }
json
application/json

Savings Account

GET
https://api.bitget.com
/api/v2/earn/savings/account

Rate limit: 10/sec/UID

Get savings account info.

Savings Account › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
btcAmount
​string

Estimated total asset value in BTC

usdtAmount
​string

Estimated total asset value in USDT

btc24hEarning
​string

24-hour earning in BTC

usdt24hEarning
​string

24-hour earning in USDT

btcTotalEarning
​string

Cumulative earning in BTC

usdtTotalEarning
​string

Cumulative earning in USDT

GET/api/v2/earn/savings/account
curl https://api.bitget.com/api/v2/earn/savings/account
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696748551073, "data": { "btcAmount": "0.35821314", "usdtAmount": "9481.55500000", "btc24hEarning": "0.00000009", "usdt24hEarning": "0.00263912", "btcTotalEarning": "0.00000761", "usdtTotalEarning": "0.20145653" } }
json
application/json

Savings Assets

GET
https://api.bitget.com
/api/v2/earn/savings/assets

Rate limit: 10/sec/UID

Get savings assets.

Savings Assets › Request Parameters

periodType
​string · required

Period type

flexible demand deposit

fixed time deposit

startTime
​string

Start timestamp

(Savings creation time)

Milliseconds format of timestamp Unix, e.g. 1597026383085

(The maximum time span supported is three months. The default start time is three months ago if no value is set for the start time.)

endTime
​string

End timestamp

(Savings creation time)

Milliseconds format of timestamp Unix, e.g. 1597026383085

(The maximum time span supported is three months. The default end time is now if no value is set for the end time.)

limit
​string

Number of queries: Default: 20, maximum: 100.

idLessThan
​string

Separate page content before this ID is requested (older data), and the value input should be the end ID of the last request.

Savings Assets › Response Parameters

200

Successful response

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

Savings assets list

endId
​string

End ID for pagination

GET/api/v2/earn/savings/assets
curl 'https://api.bitget.com/api/v2/earn/savings/assets?periodType=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696748867881, "data": { "resultList": [ { "productId": "123123123", "orderId": "xxxx", "productCoin": "BGB", "interestCoin": "BGB", "periodType": "flexible", "period": "", "holdAmount": "100.000", "lastProfit": "0.01643800", "totalProfit": "1.25479000", "holdDays": "", "status": "in_holding", "allowRedemption": "", "productLevel": "normal", "apy": [ { "rateLevel": "1", "minApy": "0.000000", "maxApy": "200.000000", "currentApy": "6.00" } ] } ], "endId": "123456789" } }
json
application/json

Savings Records

GET
https://api.bitget.com
/api/v2/earn/savings/records

Rate limit: 10/sec/UID

Get savings records.

Savings Records › Request Parameters

periodType
​string · required

Period type

flexible flexible current

fixed fixed term

coin
​string

Subscribe coin

orderType
​string

Record type

subscribe subscription

redeem redemption

pay_interest interest payment

deduction penalty interest (only supports regular periods)

startTime
​string

Start timestamp

(Copy trade creation time)

Milliseconds format of timestamp Unix, e.g. 1597026383085

(The maximum time span supported is three months. The default end time is three months if no value is set for the end time.)

endTime
​string

End timestamp

(Copy trade creation time)

Milliseconds format of timestamp Unix, e.g. 1597026383085

(The maximum time span supported is three months. The default start time is three months ago if no value is set for the start time.)

limit
​string

Number of queries: Default: 20, maximum: 100.

idLessThan
​string

Separate page content before this ID is requested (older data), and the value input should be the end ID of the last request.

Savings Records › Response Parameters

200

Successful response

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

Data list

endId
​string

End ID for pagination

GET/api/v2/earn/savings/records
curl 'https://api.bitget.com/api/v2/earn/savings/records?periodType=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696749517654, "data": { "resultList": [ { "orderId": "123123123123", "coinName": "BGB", "settleCoinName": "BGB", "productType": "flexible", "period": "", "productLevel": "normal", "amount": "200.000000", "ts": "1695797014392", "orderType": "redeem" } ], "endId": "456456456456" } }
json
application/json

Savings Subscription Detail

GET
https://api.bitget.com
/api/v2/earn/savings/subscribe-info

Rate limit: 10/sec/UID

Get subscription detail before subscribe savings.

Savings Subscription Detail › Request Parameters

productId
​string · required

Product ID

periodType
​string · required

Period type

flexible flexible period

fixed fixed period

Savings Subscription Detail › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
singleMinAmount
​string

Minimum limit for a single transaction

singleMaxAmount
​string

Maximum limit for a single transaction

remainingAmount
​string

Amount held remaing

subscribePrecision
​string

Subscription precision

profitPrecision
​string

Profit precison

subscribeTime
​string

Subscription time, Unix millisecond timestamp

interestTime
​string

Interest generation time, Unix millisecond timestamp

settleTime
​string

Interest settlement time, Unix millisecond timestamp

expireTime
​string

Expiration time, Unix millisecond timestamp

redeemTime
​string

Redemption time, Unix millisecond timestamp

settleMethod
​string

Settlement method

​object[]

Ladder interest rate info

redeemDelay
​string

The number of days of delay in the redemption's arrival. The return value is D+1, which means the redemption is delayed by one day, and so on.

GET/api/v2/earn/savings/subscribe-info
curl 'https://api.bitget.com/api/v2/earn/savings/subscribe-info?productId=<string>&periodType=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696751519392, "data": { "singleMinAmount": "10.000000", "singleMaxAmount": "2000.000000", "remainingAmount": "4899.999990", "subscribePrecision": "6", "profitPrecision": "6", "subscribeTime": "1696751519451", "interestTime": "1696780800000", "settleTime": "1696867200000", "expireTime": "", "redeemTime": "", "settleMethod": "", "apyList": [ { "rateLevel": "0", "minStepVal": "0.000000", "maxStepVal": "200.000000", "currentApy": "6.00" }, { "rateLevel": "1", "minStepVal": "200.000000", "maxStepVal": "5000.000000", "currentApy": "50.00" } ], "redeemDelay": "" } }
json
application/json

Subscribe Savings

POST
https://api.bitget.com
/api/v2/earn/savings/subscribe

Rate limit: 10/sec/UID

Subscribe savings.

Subscribe Savings › Request Parameters

productId
​string · required

Product ID

periodType
​string · required

Period type

flexible flexible period

fixed fixed period

amount
​string · required

Subscribe amount

Subscribe Savings › Response Parameters

200

Successful response

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

Successful subscription order ID

POST/api/v2/earn/savings/subscribe
curl https://api.bitget.com/api/v2/earn/savings/subscribe \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "productId": "productId", "periodType": "periodType", "amount": "amount" }'
Example Request Body
{ "productId": "productId", "periodType": "periodType", "amount": "amount" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1748783837837, "data": { "orderId": "1313060074239184896" } }
json
application/json

Savings Subscription Result

GET
https://api.bitget.com
/api/v2/earn/savings/subscribe-result

Rate limit: 10/sec/UID

Get savings subscription result.

Savings Subscription Result › Request Parameters

orderId
​string · required

Order ID

periodType
​string · required

Period type

flexible flexible period

fixed fixed period

Savings Subscription Result › Response Parameters

200

Successful response

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

Subscription result

success Success

fail Fail

msg
​string

There will be an error message when the result is fail

GET/api/v2/earn/savings/subscribe-result
curl 'https://api.bitget.com/api/v2/earn/savings/subscribe-result?orderId=<string>&periodType=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696752594890, "data": { "result": "success", "msg": "" } }
json
application/json

Redeem Savings

POST
https://api.bitget.com
/api/v2/earn/savings/redeem

Rate limit: 10/sec/UID

Redeem savings.

The interval of each redeem should be more than 1min, or it would return error.

Redeem Savings › Request Parameters

productId
​string · required

Product ID

periodType
​string · required

Period type

flexible flexible period

fixed fixed period

amount
​string · required

Subscribe amount

orderId
​string

Assets Order ID

get this for /assets orderId

Redeem Savings › Response Parameters

200

Successful response

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

Redemption successful order ID

status
​string

Order status

POST/api/v2/earn/savings/redeem
curl https://api.bitget.com/api/v2/earn/savings/redeem \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "productId": "productId", "orderId": "orderId", "periodType": "periodType", "amount": "amount" }'
Example Request Body
{ "productId": "productId", "orderId": "orderId", "periodType": "periodType", "amount": "amount" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696751519392, "data": { "orderId": "123123123", "status": "2000.000000" } }
json
application/json

Savings Redemption Results

GET
https://api.bitget.com
/api/v2/earn/savings/redeem-result

Rate limit: 10/sec/UID

Get savings redeem result.

Savings Redemption Results › Request Parameters

orderId
​string · required

Subscription order ID

periodType
​string · required

Period type

flexible flexible current

fixed fixed term

Savings Redemption Results › Response Parameters

200

Successful response

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

Redemption result

success Success

fail Fail

msg
​string

There will be an error message when the result is fail

GET/api/v2/earn/savings/redeem-result
curl 'https://api.bitget.com/api/v2/earn/savings/redeem-result?orderId=<string>&periodType=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696752594890, "data": { "result": "success", "msg": "" } }
json
application/json