Skip to content
Longport WhaleLongport Whale
Exceed Credit Limit Details

Exceed Credit Limit Details

Queries Excess Margin Usage Report data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/account_overuse_financings

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_credit_limit.client_credit_limit_query

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

Query parameters

filtersobject

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

Child attributes
aaidstring

AAID. Filters results by AAID.

finance_amountobject

Financing Amt. Filters results by Financing Amt.

Child attributes
gteinteger

Greater Than or Equal. Inclusive lower bound of the filter range.

lteinteger

Less Than or Equal. Inclusive upper bound of the filter range.

used_financeobject

Used Financing Amt. Filters results by Used Financing Amt.

Child attributes
gteinteger

Greater Than or Equal. Inclusive lower bound of the filter range.

lteinteger

Less Than or Equal. Inclusive upper bound of the filter range.

account_typestring

Account Type. Filters results by Account Type.

M · MarginC · CashF · Futures

markstring

Account Tag. Filters results by Account Tag.

dt · Day Trade

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 Excess Margin Usage Report 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
aaidstring

AAID. Returned value: AAID.

aaid_valstring

AAID (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

Member ID. Returned value: Member ID.

real_namestring

Name. Returned value: Name.

origin_idstring

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

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.

account_markstring

Account Tag. Returned value: Account Tag.

account_mark_valstring

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

account_channelstring

Channel. Returned value: Channel.

credit_currencystring

Based Currency. Returned value: Based Currency.

finance_amountstring

Financing Amt. Returned value: Financing Amt.

used_financestring

Used Financing Amt. Returned value: Used Financing Amt.

main_used_financestring

Used Financing Amt (Based CCY). Returned value: Used Financing Amt (Based CCY).

other_used_financestring

Used Financing Amt (Other Curr). Returned value: Used Financing Amt (Other Curr).

exceed_amountstring

Excess Financing Amt. Returned value: Excess Financing Amt.

exceed_ratestring

Excess Financing Ratio. Returned value: Excess Financing Ratio.

main_settlement_book_balancestring

Settled Balance (Based CCY). Returned value: Settled Balance (Based CCY).

other_settlement_book_balancestring

Settled Balance (Other Curr). Returned value: Settled Balance (Other Curr).

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