Query Account Total Asset OverView

This interface is used to query the complete asset overview for a specified securities account. By providing the account number account_no and currency currency, it returns the asset summary over_view (including total assets, total cash, money market fund balance, and market values of various asset types) as well as detailed holdings details for each asset category (covering cash, stocks, options, funds, bonds, OTC, virtual assets, and money market funds).

GEThttps://b-api.longbridge.xyz/v1/whaleapi/asset/overview

Authorization

AuthorizationstringheaderRequired

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

Parameters

account_nostringRequired

Account NO Eg:L6VQEU00121996

currencystringRequired

Responses

HTTP 200Fields are taken from the real responses definition for this operation in the published Whale OpenAPI spec (whale-openapi/Whale-openapi.json).

Standard response envelopecodemessagedata

dataobjectdata structure

over_viewobjectrequired

Asset Over View. Asset Over View

Child attributes

total_assetstringrequired

total_asset

total_cashstringrequired

Total Cash Amount. Total Cash Amount

mmf_amountstringrequired

MMF Amount. MMF Amount

stock_mvstringrequired

Stock Market Value. Stock Market Value

fund_mvstringrequired

Fund Market Value. Fund Market Value

bond_mvstringrequired

Bond Market Value. Bond Market Value

otc_mvstringrequired

Otc Market Value. Otc Market Value

crypto_mvstringrequired

Crypto Market Value. Crypto Market Value

currencystringrequired

currency

detailsobjectrequired

Asset Detail. Asset Detail

Child attributes

cash_detailsarray<object>required

Cash List. Cash List

Child attributes

currencystringrequired

Currency. Currency

settled_balancestringrequired

Settled Cash. Settled Cash

unsettled_balancestringrequired

UnSettled Cash. UnSettled Cash

outstandingstringrequired

Standing Cash. Standing Cash

frozen_amountstringrequired

Frozen Cash. Frozen Cash

available_amountstringrequired

AvailAble Cash. AvailAble Cash

withdraw_amountstringrequired

Withdraw Cash. Withdraw Cash

stock_detailsarray<object>required

Stock List. Stock List

Child attributes

symbolstringrequired

Symbol. Symbol

currencystringrequired

Currency. Currency

last_donestringrequired

Last Done. Last Done

quantitystringrequired

Holding Quantity. Holding Quantity

market_valuestringrequired

Market Value. Market Value

settled_quantitystringrequired

Settled Quantity. Settled Quantity

unsettled_settled_quantitystringrequired

UnSettled Quantity. UnSettled Quantity

symbol_namestringrequired

Symbol Name. Symbol Name

option_detailsarray<object>required

Option List. Option List

Child attributes

symbolstringrequired

Symbol. Symbol

currencystringrequired

Currency. Currency

last_donestringrequired

Last Done. Last Done

quantitystringrequired

Holding Quantity. Holding Quantity

market_valueobjectrequired

Market Value. Market Value

settled_quantitystringrequired

Settled Quantity. Settled Quantity

unsettled_settled_quantitystringrequired

UnSettled Quantity. UnSettled Quantity

symbol_namestringrequired

Symbol Name. Symbol Name

underlying_symbolstringrequired

UnderLying Symbol. UnderLying Symbol

underlying_symbol_namestringrequired

UnderLying Symbol Name. UnderLying Symbol Name

fund_detailsarray<object>required

Fund List. Fund List

Child attributes

symbolstringrequired

Symbol. Symbol

currencystringrequired

Currency. Currency

holding_unitsstringrequired

Holding Units. Holding Units

current_net_valuestringrequired

Net Value. Net Value

market_valuestringrequired

Market Value. Market Value

bond_detailsarray<object>required

Bond List. Bond List

Child attributes

symbolstringrequired

Symbol. Symbol

currencystringrequired

Currency. Currency

holding_unitsstringrequired

Holding Units. Holding Units

current_net_valuestringrequired

Net Value. Net Value

market_valuestringrequired

Market Value. Market Value

otc_detailsarray<object>required

Otc List. Otc List

Child attributes

symbolstringrequired

Symbol. Symbol

currencystringrequired

Currency. Currency

holding_unitsstringrequired

Holding Units. Holding Units

current_net_valuestringrequired

Net Value. Net Value

market_valuestringrequired

Market Value. Market Value

va_detailsarray<object>required

Crypto List. Crypto List

Child attributes

symbolstringrequired

Symbol. Symbol

currencystringrequired

Currency. Currency

last_donestringrequired

Last Done. Last Done

quantitystringrequired

Quantity. Quantity

market_valuestringrequired

Market Value. Market Value

mmf_detailsarray<object>required

MMF List. MMF List

Child attributes

currencystringrequired

Currency. Currency

net_valuestringrequired

Net Value. Net Value

holding_unitsstringrequired

Holding Units. Holding Units

market_valuestringrequired

Market Value. Market Value

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.longbridge.xyz/v1/whaleapi/asset/overview' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "over_view": {
      "total_asset": "string",
      "total_cash": "string",
      "mmf_amount": "string",
      "stock_mv": "string",
      "fund_mv": "string",
      "bond_mv": "string",
      "otc_mv": "string",
      "crypto_mv": "string",
      "currency": "string"
    },
    "details": {
      "cash_details": [
        {
          "currency": "string",
          "settled_balance": "string",
          "unsettled_balance": "string",
          "outstanding": "string",
          "frozen_amount": "string",
          "available_amount": "string",
          "withdraw_amount": "string"
        }
      ],
      "stock_details": [
        {
          "symbol": "string",
          "currency": "string",
          "last_done": "string",
          "quantity": "string",
          "market_value": "string",
          "settled_quantity": "string",
          "unsettled_settled_quantity": "string",
          "symbol_name": "string"
        }
      ],
      "option_details": [
        {
          "symbol": "string",
          "currency": "string",
          "last_done": "string",
          "quantity": "string",
          "market_value": {},
          "settled_quantity": "string",
          "unsettled_settled_quantity": "string",
          "symbol_name": "string",
          "underlying_symbol": "string",
          "underlying_symbol_name": "string"
        }
      ],
      "fund_details": [
        {
          "symbol": "string",
          "currency": "string",
          "holding_units": "string",
          "current_net_value": "string",
          "market_value": "string"
        }
      ],
      "bond_details": [
        {
          "symbol": "string",
          "currency": "string",
          "holding_units": "string",
          "current_net_value": "string",
          "market_value": "string"
        }
      ],
      "otc_details": [
        {
          "symbol": "string",
          "currency": "string",
          "holding_units": "string",
          "current_net_value": "string",
          "market_value": "string"
        }
      ],
      "va_details": [
        {
          "symbol": "string",
          "currency": "string",
          "last_done": "string",
          "quantity": "string",
          "market_value": "string"
        }
      ],
      "mmf_details": [
        {
          "currency": "string",
          "net_value": "string",
          "holding_units": "string",
          "market_value": "string"
        }
      ]
    }
  }
}