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

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

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

endId

string

End ID for pagination

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

endId

string

End ID for pagination

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

POST

https://api.bitget.com

/api/v2/earn/sharkfin/subscribe

Rate limit: 10/sec/UID

Subscribe sharkfin.

productId

string · required

Product ID

amount

string · required

Subscription amount

200

Successful response

code

string

msg

string

requestTime

integer

object

orderId

string

Order Id

status

string

Order status

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

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

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

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

endId

string

End ID for pagination

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

endId

string

End ID for pagination

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

POST

https://api.bitget.com

/api/v2/earn/sharkfin/subscribe

Rate limit: 10/sec/UID

Subscribe sharkfin.

productId

string · required

Product ID

amount

string · required

Subscription amount

200

Successful response

code

string

msg

string

requestTime

integer

object

orderId

string

Order Id

status

string

Order status

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

SharkFin

Get Sharkfin Products

Get Sharkfin Products › Request Parameters

Get Sharkfin Products › Response Parameters

SharkFin Account

SharkFin Account › Response Parameters

SharkFin Assets

SharkFin Assets › Request Parameters

SharkFin Assets › Response Parameters

SharkFin Records

SharkFin Records › Request Parameters

SharkFin Records › Response Parameters

SharkFin Subscription Detail

SharkFin Subscription Detail › Request Parameters

SharkFin Subscription Detail › Response Parameters

Subscribe SharkFin

Subscribe SharkFin › Request Parameters

Subscribe SharkFin › Response Parameters

SharkFin Subscription Result

SharkFin Subscription Result › Request Parameters

SharkFin Subscription Result › Response Parameters

SharkFin

Get Sharkfin Products

Get Sharkfin Products › Request Parameters

Get Sharkfin Products › Response Parameters

SharkFin Account

SharkFin Account › Response Parameters

SharkFin Assets

SharkFin Assets › Request Parameters

SharkFin Assets › Response Parameters

SharkFin Records

SharkFin Records › Request Parameters

SharkFin Records › Response Parameters

SharkFin Subscription Detail

SharkFin Subscription Detail › Request Parameters

SharkFin Subscription Detail › Response Parameters

Subscribe SharkFin

Subscribe SharkFin › Request Parameters

Subscribe SharkFin › Response Parameters

SharkFin Subscription Result

SharkFin Subscription Result › Request Parameters

SharkFin Subscription Result › Response Parameters