BUbullish
history

Get Historical Hourly Borrow Interest

Get Historical Hourly Borrow Interest. Each entry denotes the hourly quantities for the specific asset. Total borrowed quantity is inclusive of interest. interest = totalBorrowedQuantity - borrowedQuantity which denotes the interest charged in the particular hour for the asset.

  • supports pagination
  • filtering createdAtDatetime, createdAtTimestamp requires additional keywords, see filtering support
  • On a single query request you can retrieve data over a 7 day window, with the data available for the last 90 days

Ratelimited: True

get/v1/history/borrow-interest

Request

Query parameters

tradingAccountIdstring

unique trading account ID

Example:111000000000001

Id of the trading account. tradingAccountId is mandatory in the query for users with multiple trading accounts. For users with a single trading account, it can be automatically retrieved from the login.

assetSymbolstring required

asset symbol as denoted in the world

Example:BTC
createdAtDatetime[gte]string date-time required

ISO 8601 with millisecond as string

Example:2025-05-20T01:01:01.000Z

start timestamp of period, ISO 8601 with millisecond as string

createdAtDatetime[lte]string date-time required

ISO 8601 with millisecond as string

Example:2025-05-20T01:01:01.000Z

end timestamp of period, ISO 8601 with millisecond as string

Response

OK

assetIdstring required

unique asset ID

assetSymbolstring required

asset symbol as denoted in the world

borrowedQuantitystring required

see asset value format

totalBorrowedQuantitystring required

see asset value format

createdAtDatetimestring date-time required

denotes the hour in which the principal quantity was borrowed or when the interest was charged, ISO 8601 with millisecond as string

createdAtTimestampstring string required

denotes the hour in which the principal quantity was borrowed or when the interest was charged

Example response

[
  {
    "assetId": "1",
    "assetSymbol": "BTC",
    "borrowedQuantity": "1.00000000",
    "totalBorrowedQuantity": "1.00000000",
    "createdAtDatetime": "2020-08-21T08:00:00.000Z",
    "createdAtTimestamp": "1621490985000"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.