Get Account List · Whale Docs

GEThttps://api.lbkrs.com/v3/account/list

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get account list” operation.

Standard response envelopecodemessagedata

dataobjectdata structure

statusarray<object>

Account list

Child attributes

aaidstring

Account aaid

nostring

Account number

account_channelstring

Broker channel the account belongs to

account_namestring

Account name (used for scenarios such as demo accounts)

account_typestring

Account type: M Main account

account_openboolean

Whether the account has been opened

account_stateinteger

Account status (only effective when account_open is true): 0 Not opened/not applicable, 4 Suspended, 5 Dormant; the specific meaning of -1/1/2/3 has not been confirmed from the frontend code

-1012345

statestring

Account-opening status: -1 Not opened, 0 Default initialized, OCR completed, 1 Identity information verified, 2 Liveness verification passed, 3 Account-opening information being submitted, 4 Submitted by user, pending confirmation, 5 Submission completed by user, 6 Account-opening PDF generated, 7 Under Phillip review, 8 Review failed, 9 Account opened successfully

-10123456789

disableboolean

Whether the account is disabled

verify_statestring

Verification status; the value has the same meaning as state

depositboolean

Whether funds have been deposited

tradeboolean

Whether trading is allowed

check_tradeboolean

Whether trading permission verification is required

t_pwdboolean

Whether a trading password has been set

can_modifyboolean

Whether the account information can be modified

is_master_totp_deviceboolean

Whether this is the primary TOTP verification device

options_agreeboolean

Whether the options agreement has been signed

close_deposit_guideboolean

Whether the deposit guidance has been dismissed

crypto_openedboolean

Whether a cryptocurrency account has been opened

client_typeinteger

Client type: 0 (demo account), 1 Individual, 2 Corporate, 3 Joint

0123

client_detail_typestring

Client sub-type, e.g. "0" (retail client), OB

card_typeinteger

Account-opening ID document type: 0 ID card, 1 Passport

01

locationstring

Account-opening location

face_merchantstring

Facial recognition provider

parent_aaidstring

Main account aaid; 0 means no main account

reasonstring

Account-opening failure reason

reason_titlestring

Account-opening failure reason title

next_stepstring

Next account-opening guidance step

uploadbaseaddressemployconfirm_pinyinfinancecompliancesignaturesubmitted

step_processstring

Account-opening progress

submitted_atstring

Account-opening information submission timestamp (seconds)

open_account_atstring

Account-opening success timestamp (seconds)

setting_updated_atstring

Account settings update timestamp (seconds)

open_rateinteger

Account-opening progress percentage

sip_statestring

SIP (Singapore) activation status: 0 SIP not activated, 1 Submitted, 2 PDF generated, 3 Under Phillip review, 4 SIP activation failed, 5 SIP activated successfully (this field is marked deprecated in internal documentation but is still returned)

012345

ckaut_statestring

Verification status; the enum has the same meaning as sip_state

markarray<string>

Account marks; known values: dt Intraday margin, options Options-dedicated account, va Virtual/cryptocurrency account, demo Demo account, northbound_wmc Northbound Connect, southbound_wmc Southbound Connect

orgobject

Account-opening entity information

Child attributes

entitystring

Entity full name

org_idstring

Entity ID

logostring

Entity logo

iconstring

Entity icon

namestring

Entity display name

account_channelstring

Broker channel the entity belongs to

settingobject

Account trading security settings

Child attributes

p_trade_authstring

Whether trading-password verification is enabled for order placement

trade_2fa_totp_authstring

Whether trading TOTP two-factor verification is enabled

trade_2fa_device_totp_authstring

Whether device-level trading TOTP two-factor verification is enabled

trade_expires_instring

Trading-password verification validity period (seconds)

allow_open_broker_numsinteger

Number of brokers still available for account opening

external_linksarray<object>

List of associated external accounts

Child attributes

account_namestring

External account name

orgobject

External account entity information

Child attributes

external_idstring

External entity ID

iconstring

Icon

introstring

Introduction

linkstring

Redirect link

logostring

Logo

multi_linkstring

Multi-language redirect link

namestring

Entity name

sloganstring

Slogan

Request

let request = WhaleCoreHTTPRequest(
    method: .get,
    path: "/v3/account/list"
)

let response = try await WhaleCoreService.requestService.send(request)
print(response.bodyString)

Response Example

{
  "code": 0,
  "message": "success",
  "data": {
    "status": [
      {
        "state": "9",
        "open_rate": 0,
        "sip_state": "5",
        "ckaut_state": "0",
        "next_step": "submitted",
        "card_type": 0,
        "reason": "",
        "face_merchant": "ca",
        "submitted_at": "1677160341",
        "account_channel": "lb",
        "account_open": true,
        "account_name": "",
        "no": "H10304472",
        "deposit": true,
        "trade": true,
        "location": "CN",
        "aaid": "20126981",
        "options_agree": false,
        "org": {
          "entity": "Longbridge Securities (Hong Kong) Limited (BPX066)",
          "org_id": "1",
          "logo": "https://assets.lbctrl.com/uploads/1_5_moji8troxgktz96t7w_Group-1.png",
          "icon": "https://pub.lbctrl.com/files/2023/0/VCH7ekrjyfQCpTJAKnYHuS8AxKLZb2MZ/Group626927.png",
          "name": "Longbridge Comprehensive Account",
          "account_channel": ""
        },
        "setting_updated_at": "1677204480",
        "t_pwd": true,
        "account_type": "M",
        "setting": {
          "p_trade_auth": "NO",
          "trade_2fa_device_totp_auth": "NO",
          "trade_2fa_totp_auth": "NO",
          "trade_expires_in": "7200"
        },
        "parent_aaid": "0",
        "client_type": 1,
        "client_detail_type": "0",
        "mark": [
          "restr_ml_inv"
        ],
        "account_state": 1,
        "disable": false,
        "check_trade": true,
        "close_deposit_guide": false,
        "is_master_totp_device": false,
        "step_process": "",
        "open_account_at": "1677204480",
        "can_modify": true,
        "crypto_opened": false,
        "verify_state": "9",
        "reason_title": ""
      },
      {
        "state": "0",
        "open_rate": 0,
        "sip_state": "0",
        "ckaut_state": "0",
        "next_step": "",
        "card_type": 0,
        "reason": "",
        "face_merchant": "",
        "submitted_at": "0",
        "account_channel": "lb_papertrading",
        "account_open": false,
        "account_name": "Demo Comprehensive Account",
        "no": "",
        "deposit": false,
        "trade": false,
        "location": "",
        "aaid": "0",
        "options_agree": false,
        "org": {
          "entity": "Demo Trading Environment",
          "org_id": "1",
          "logo": "https://pub.lbctrl.com/files/2023/0/9dBWyK365HsRbqoKczkNWZrrbVGioEBa/Group_626553.webp",
          "icon": "https://pub.lbctrl.com/files/2023/0/VZdTZZQAgG6HVGi6YJmnk1XQcGbPxFP4/tg_standard.png",
          "name": "Demo Trading",
          "account_channel": ""
        },
        "setting_updated_at": "0",
        "t_pwd": true,
        "account_type": "",
        "setting": {},
        "parent_aaid": "0",
        "client_type": 0,
        "client_detail_type": "",
        "mark": [
          "demo"
        ],
        "account_state": 0,
        "disable": false,
        "check_trade": false,
        "close_deposit_guide": false,
        "is_master_totp_device": false,
        "step_process": "",
        "open_account_at": "0",
        "can_modify": true,
        "crypto_opened": false,
        "verify_state": "0",
        "reason_title": ""
      }
    ],
    "allow_open_broker_nums": 0,
    "external_links": []
  }
}