Credit Line Parameters

Query the credit-parameter configuration.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains per-client credit parameters — client, securities account, credit type, counter channel, currency, whether global, enabled status, auto-credit max limit, credit coefficient, CCF, app-applicable limit and dynamic credit adjustment; used to configure a client's credit rules.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_credit_limit.credit_limit_para_qurey

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

Request body application/json

filtersobject

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

Child attributes

member_idstring

Filters results by Member ID.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Credit Line Parameters records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

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.

member_idstring

Returned value: Member ID.

member_id_valstring

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

Returned value: Name.

aaidstring

Returned value: A/C No.

aaid_valstring

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.

credit_typestring

Returned value: Credit Limit Type.

credit_type_valstring

Raw value of credit_type. The credit_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

account_channelstring

Returned value: Channel.

credit_currencystring

Returned value: Currency.

credit_setting_typestring

Returned value: Global/ Individual.

credit_setting_type_valstring

Raw value of credit_setting_type. The credit_setting_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

auto_creditstring

Returned value: Status.

auto_credit_valstring

Raw value of auto_credit. The auto_credit field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

auto_credit_limitstring

Returned value: Max System Auto Approval Limit.

credit_coefficientstring

Returned value: Credit Limit Multiplier Coefficient.

credit_fpsstring

Returned value: Credit FPS.

ccfstring

Returned value: CCF(%).

applicablestring

Returned value: APP Max Credit Limit Submission Amt.

net_asset_ratiostring

Returned value: Declared NAV Multiples.

totalintegerrequired

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/risk_credit_configs' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "member_id": "",
        "member_id_val": "",
        "member_real_name": "Zhang San",
        "aaid": "",
        "aaid_val": "",
        "credit_type": "Margin Credit Limit",
        "credit_type_val": "1",
        "account_channel": "longport_test",
        "credit_currency": "HKD",
        "credit_setting_type": "Global",
        "credit_setting_type_val": "0",
        "auto_credit": "On",
        "auto_credit_val": "true",
        "auto_credit_limit": "1,000,000.00",
        "credit_coefficient": "1.00",
        "credit_fps": "0.30",
        "ccf": "100.00",
        "applicable": "1,000,000.00",
        "net_asset_ratio": "1"
      }
    ],
    "total": 14789
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_credit_configs/download

lb_hk_credit_limit.credit_limit_para_qurey

Export options Export records Download result