Query HashKey Cash List

Returns the cash-asset list on the HashKey platform.

Request parameters

This endpoint has no required parameters; see the field definitions for optional parameters.
See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Reported per currency, it returns each crypto currency's total assets total_asset, free assets free_asset, and locked amount locked_asset.

Returns

On success, returns the HashKey cash-asset list. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/v1/whaleapi/asset/hashkey/cash_list

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

account_balance.account

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Responses

HTTP 200Successful response

Standard response envelopecodemessagedata

dataobjectdata structure

asset_listarray<object>required

Currency List. Currency List

Child attributes

currencystringrequired

Currency. Currency

total_assetstringrequired

Cash Amount. Cash Amount

free_assetstringrequired

Available Amount. Available Amount

locked_assetstringrequired

FrozenAmount. FrozenAmount

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request GET \
  --url 'https://b-api.lbkrs.com/v1/whaleapi/asset/hashkey/cash_list' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "asset_list": [
      {
        "currency": "BTC",
        "total_asset": "100",
        "free_asset": "100",
        "locked_asset": "125630.50"
      }
    ]
  }
}