Skip to content
Credit Snapshot

Credit Snapshot

Queries Credit Limit Changes Query 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/risk_credit_amount_changes

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.credit_snapshot

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
member_idstring

Member ID. Filters results by Member ID.

originstring

Source. Filters results by Source.

auto_credit · Auto assigned (System)credit_audit · Manual adjustment (User)app_auto · Submitted by client through APP (Auto Approved by System)rule_change · Adjusted by credit limit rule (User)batch_change · Batch Adjustment (User)credit_group · Group Default Credit Limitmanual_add · Manual adjustment (User)credit_blacklist · Included inside blacklistmanual_adjust · Manual adjustment (User)dynamic_credit_limit_adjustment · Dynamic Credit Limit Adjustment

updated_atobject

Updated At. Filters results by Updated At.

Child attributes
gtestring

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

ltestring

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

operatorstring

Processed By. Filters results by Processed By.

after_finance_amountobject

Credit Limit (After). Filters results by Credit Limit (After).

Child attributes
gtenumber

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

ltenumber

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 Credit Limit Changes 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

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

member_idstring

Member ID. Returned value: Member ID.

member_id_valstring

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

member_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.

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.

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.

account_channelstring

Channel. Returned value: Channel.

credit_currencystring

Currency. Returned value: Currency.

originstring

Source. Returned value: Source.

origin_valstring

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

before_finance_amountstring

Credit Limit (Before). Returned value: Credit Limit (Before).

after_finance_amountstring

Credit Limit (After). Returned value: Credit Limit (After).

created_atstring

Submitted At. Returned value: Submitted 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.

operatorstring

Processed By. Returned value: Processed By.

applicantstring

Submitted By. Returned value: Submitted By.

remarkstring

Remarks. Returned value: Remarks.

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