Bitget APIBitget API
UTAClassic
Legacy Doc
  • Overview
  • API Documentation
  • WebSocket
  • Agent Hub
  • SDK
  • Changelog
Copied to clipboard
API Document
Classic Earn
    SharkFin
      Get Sharkfin ProductsgetSharkFin AccountgetSharkFin AssetsgetSharkFin RecordsgetSharkFin Subscription DetailgetSubscribe SharkFinpostSharkFin Subscription Resultget
Classic Earn SharkFin
Classic Earn SharkFin

SharkFin

Classic Account — SharkFin


Get Sharkfin Products

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

Rate limit: 10/sec/UID

Get sharkfin products.

Get Sharkfin Products › Request Parameters

coin
​string · required

Shark coin

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.

Get Sharkfin Products › Response Parameters

200

Successful response

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

Sharkfin product list info

productId
​string

Product ID

productName
​string

Sharkfin product name

productCoin
​string

Sharkfin product coin

subscribeCoin
​string

Sharkfin Subscribe coin

farmingStartTime
​string

Start time, Unix millisecond timestamp

farmingEndTime
​string

End time, Unix millisecond timestamp

lowerRate
​string

Minimum rate

defaultRate
​string

Default rate

upperRate
​string

Maximum rate

period
​string

Investment period

interestStartTime
​string

Interest calculation start time

status
​string

Product status

not_started Warming up

in_progress Subscribing

paused Paused

interest_pending Interest is accruing

settle_pending Pending settlement

settled Settled

redeemed redeemed

sold_out Sold out

minAmount
​string

Product minimum limit

limitAmount
​string

Product limit

If there is no limit, return unlimited

soldAmount
​string

Sold amount

startTime
​string

Start timestamp

Milliseconds format of timestamp Unix, e.g. 1597026383085

endTime
​string

End timestamp

Milliseconds format of timestamp Unix, e.g. 1597026383085

endId
​string

End ID for pagination

GET/api/v2/earn/sharkfin/product
curl 'https://api.bitget.com/api/v2/earn/sharkfin/product?coin=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696754489003, "data": { "resultList": [ { "productId": "1", "productName": "USDT/ETH_20231009", "productCoin": "ETH", "subscribeCoin": "USDT", "farmingStartTime": "1696744800000", "farmingEndTime": "1696831200000", "lowerRate": "7.06", "defaultRate": "7", "upperRate": "8.8", "period": "7", "interestStartTime": "1696838400000", "status": "in_progress", "minAmount": "0.1", "limitAmount": "500001.0", "soldAmount": "310187.2", "endTime": "1696831200000", "startTime": "1696744800000" } ], "endId": "1" } }
json
application/json

SharkFin Account

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

Rate limit: 10/sec/UID

Get sharkfin account info.

SharkFin Account › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
btcSubscribeAmount
​string

Estimated total asset value in BTC

usdtSubscribeAmount
​string

Estimated total asset value in USDT

btcHistoricalAmount
​string

24-hour earning in BTC

usdtHistoricalAmount
​string

24-hour earning in USDT

btcTotalEarning
​string

Cumulative earning in BTC

usdtTotalEarning
​string

Cumulative earning in USDT

GET/api/v2/earn/sharkfin/account
curl https://api.bitget.com/api/v2/earn/sharkfin/account
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696755312297, "data": { "btcSubscribeAmount": "0.00000000", "usdtSubscribeAmount": "0.00", "btcHistoricalAmount": "0.00000000", "usdtHistoricalAmount": "0.00000000", "btcTotalEarning": "0.00000000", "usdtTotalEarning": "0.00000000" } }
json
application/json

SharkFin Assets

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

Rate limit: 10/sec/UID

Get sharkfin assets.

SharkFin Assets › Request Parameters

status
​string · required

Shark status

subscribed Subscribed(default)

settled Settled

startTime
​string

Start timestamp

(Sharkfin 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

(Sharkfin 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.

SharkFin Assets › Response Parameters

200

Successful response

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

Sharkfin product list info

productId
​string

Product ID

interestStartTime
​string

Interest accrual start time

interestEndTime
​string

Interest accrual end time

productCoin
​string

Product subscription coin

subscribeCoin
​string

Subscription coin

trend
​string

Trend

up rise

down fall

settleTime
​string

Settlement time, Unix millisecond timestamp

interestAmount
​string

Interest amount

productStatus
​string

Product status

running Subscription

pause has been suspended

wait_interest is pending

wait_settle is pending settlement

settle has been settled

redeem has been redeemed

sell_out sold out

endId
​string

End ID for pagination

GET/api/v2/earn/sharkfin/assets
curl 'https://api.bitget.com/api/v2/earn/sharkfin/assets?status=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696756316611, "data": { "resultList": [ { "productId": "12312313", "interestStartTime": "1697199180000", "interestEndTime": "1697803980000", "productCoin": "BTC", "subscribeCoin": "USDT", "trend": "up", "settleTime": "1697803980000", "interestAmount": "", "productStatus": "running" } ], "endId": "456456456" } }
json
application/json

SharkFin Records

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

Rate limit: 10/sec/UID

Get sharkfin records.

SharkFin Records › Request Parameters

type
​string · required

Transaction type

subscription subscription

redemption redemption

interest interest payment

coin
​string

Subscribe coin

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 start time is three months ago if no value is set for the start 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 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.

SharkFin Records › Response Parameters

200

Successful response

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

Record list

orderId
​string

RecordId

product
​string

Sharkfin productName

period
​string

Investment period

amount
​string

Subscribe amount

ts
​string

Create timestamp

Milliseconds format of timestamp Unix, e.g. 1597026383085

type
​string

Transaction type

subscription subscription

redemption redemption

interest interest payment

endId
​string

End ID for pagination

GET/api/v2/earn/sharkfin/records
curl 'https://api.bitget.com/api/v2/earn/sharkfin/records?type=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696757048457, "data": { "resultList": [ { "orderId": "1", "product": "USDT/BTC_20231013", "period": "7", "amount": "100.00000000", "ts": "1696756278760", "type": "subscription" } ], "endId": "1" } }
json
application/json

SharkFin Subscription Detail

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

Rate limit: 10/sec/UID

Get subscription detail before subscribe sharkfin.

SharkFin Subscription Detail › Request Parameters

productId
​string · required

Product ID

SharkFin Subscription Detail › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
productCoin
​string

Product coin

subscribeCoin
​string

Subscribe coin

interestTime
​string

Interest start date in Unix timestamp format (in milliseconds)

expirationTime
​string

Settlement time Unix timestamp format in milliseconds

minPrice
​string

Minimum price of price range

currentPrice
​string

Current price

maxPrice
​string

The maximum price of the price range

minRate
​string

Minimum rate

defaultRate
​string

Default rate

maxRate
​string

Maximum rate

period
​string

Investment period

productMinAmount
​string

Product minimum limit

availableBalance
​string

Available Balance

userAmount
​string

User quota

remainingAmount
​string

Remaining balance

profitPrecision
​string

Interest calculation scale

subscribePrecision
​string

Subscribe calculation scale

GET/api/v2/earn/sharkfin/subscribe-info
curl 'https://api.bitget.com/api/v2/earn/sharkfin/subscribe-info?productId=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1696757209022, "data": { "productCoin": "BTC", "subscribeCoin": "USDT", "interestTime": "1697199180000", "expirationTime": "1697803980000", "minPrice": "28000.00", "currentPrice": "30211.23", "maxPrice": "32000.00", "minRate": "5.00", "defaultRate": "1.00", "maxRate": "20.00", "period": "7", "productMinAmount": "0.00100000", "availableBalance": "788", "userAmount": "500.00000000", "remainingAmount": "400.00000000", "profitPrecision": "8", "subscribePrecision": "8" } }
json
application/json

Subscribe SharkFin

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

Rate limit: 10/sec/UID

Subscribe sharkfin.

Subscribe SharkFin › Request Parameters

productId
​string · required

Product ID

amount
​string · required

Subscription amount

Subscribe SharkFin › Response Parameters

200

Successful response

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

Order Id

status
​string

Order status

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

SharkFin Subscription Result

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

Rate limit: 5/sec/UID

Get sharkfin subscription result.

SharkFin Subscription Result › Request Parameters

orderId
​string · required

Order ID

SharkFin Subscription Result › Response Parameters

200

Successful response

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

Is the subscription successful

success Success

fail Fail

msg
​string

There will be an error message when the result is fail

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