Skip to content
Longport WhaleLongport Whale
Client Trading Limit

Client Trading Limit

Query each customer's current trading-credit grants, so risk and credit teams can see the available trading limit of every securities account and how much of it is used.

Request parameters

  • Combine business filters through filters (see the filters field notes below for the optional fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Each record carries customer information, account type, and currency, plus the granted trading credit, its type (for example global or single-currency), the per-currency limit detail, status (such as working or expired), and expiry time.
  • It also shows usage such as the used trading limit, buying-power limit, in-flight business, and settlement amounts.
  • Filter by customer, status, or trade-credit type.

Returns

On success, returns the matched records and pagination info. See the response schema for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_trade_credits

Authorization

AuthorizationstringheaderRequired

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

Permission

credit_quota.trader_limit_list

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

Request body application/json

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
aaidstring

Client. Filters results by Client.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

statusstring

Status. Filters results by Status.

Allowed values: 0 Working, 1 Expired, 3 Pending

Values
0
Working
1
Expired
3
Pending
trade_credit_typestring

Type. Filters results by Type.

Allowed values: 0 Global, 1 Single Currency

Values
0
Global
1
Single Currency
pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Trade Limit Query records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

aaidstring

A/C No.. Returned value: A/C No..

aaid_valstring

A/C No. (raw value). Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

member_idstring

Client. Returned value: Client.

statusstring

Status. Returned value: Status.

status_valstring

Status (raw value). Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

real_namestring

Name. Returned value: Name.

account_typestring

Account Type. Returned value: Account Type.

account_type_valstring

Account Type (raw value). Raw value of account_type. The account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

currencystring

Main Currency. Returned value: Main Currency.

trade_credit_typestring

Type. Returned value: Type.

trade_credit_type_valstring

Type (raw value). Raw value of trade_credit_type. The trade_credit_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

business_amountstring

Cash Balance. Returned value: Cash Balance.

settlement_amountstring

Settled balance. Returned value: Settled balance.

finance_amountstring

Financing Amt. Returned value: Financing Amt.

total_used_finance_amountstring

Used Financing Amt. Returned value: Used Financing Amt.

trade_creditstring

Trading Limit. Returned value: Trading Limit.

buy_limitstring

Buying Power. Returned value: Buying Power.

used_trading_limitstring

Used Trading Limit. Returned value: Used Trading Limit.

expired_atstring

Trading Limit Expiry Date. Returned value: Trading Limit Expiry Date. The date or time format follows the value returned by the API.

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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

Whale Docs