Skip to content
Longport WhaleLongport Whale
Credit Group

Credit Group List

Queries the financing credit group list, used to manage credit shared across multiple accounts at the group level.

Request parameters

  • Combine business filters through filters (see the filters field descriptions below), and use page, page_size, and orderBy to control pagination and ordering.

Business notes

  • Each record represents a credit group that aggregates the limits of several client accounts within it.
  • It includes the group ID, group name, nature, country/region, remark, plus the group's total credit and the used financing amount across the group.
  • Commonly used to view overall credit scale and usage on a per-group basis.

Returns

On success, returns the matched record list and pagination info. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_credit_limit.credit_group_query

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

AAID. Filters results by AAID.

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.

namestring

Group Name. Filters results by Group Name.

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 Credit Group List 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: Records matching the query conditions.

Child attributes
idstring

Group ID. Returned value: Unique identifier of the current record.

namestring

Group Name. Returned value: Group Name.

business_typestring

Business Type. Returned value: Business Type.

countrystring

Country/ Region. Returned value: Country/ Region.

remarkstring

Remarks. Returned value: Remarks.

group_creditstring

Group Credit Limit Quota. Returned value: Group Credit Limit Quota.

used_finance_amountstring

Used Credit Limit Quota. Returned value: Used Credit Limit Quota.

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