Global Limit

Query global trade limits, the base layer of the risk-control trade-limit system, defining the default thresholds of each order-control rule by limit type.

Request parameters

Combine business filters through filters (optional fields are documented under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Records come from the global limit configuration. Each record is identified by a limit code code representing one risk-control rule, with name as the rule name and type as the limit type (for example, stock).
Every limit carries three tiers of thresholds — warn, review, and reject (level_warn/level_audit/level_reject) — each with its own comparison operator, combined into condition_warn, condition_audit, and condition_reject; when matched, an order is respectively flagged, sent to manual review, or rejected outright.
Records also include the limit currency currency, the enabled flag enable, a remark, the operator last_update_user, and the update time.
Typically used by risk-control staff to review and maintain order limits at the global level.

Returns

On success, returns the list of matching records with pagination info. See the response definition for the meaning of each column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_risk_limit_config.risk_limit_config_global_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

typestring

Type. Filters results by Type.

Allowed values: client, company, stock, user, other, multiple

Values

client: Client
company: Company
stock: Stock
user: User
other: Other
multiple: Multiple

enablestring

Enable. Filters results by Enable.

Allowed values: true Activated, false Not Activated

Values

true: Activated
false: Not Activated

codestring

Code. Filters results by Code.

Values are dynamic. Call GET /v1/datasets/refs/risk_limit_codes_global to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

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 Global Trade Limit 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.

codestring

Code. Returned value: Code.

code_v2string

Name. Returned value: Name.

code_v2_valstring

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

currencystring

Currency. Returned value: Currency.

enablestring

Enable. Returned value: Indicates whether enable.

enable_valstring

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

typestring

Type. Returned value: Type.

type_valstring

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

condition_warnstring

Prompt Conditions. Returned value: Prompt Conditions.

condition_auditstring

Trial Conditions. Returned value: Trial Conditions.

condition_rejectstring

Reject Conditions. Returned value: Reject Conditions.

updated_atstring

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

last_update_userstring

Requestor. Returned value: Requestor.

account_channelstring

AccountChannel. Returned value: AccountChannel.

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

Request

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "6063",
        "code": "UBB",
        "code_v2": "Trader's Single Buy Order Amount Limit",
        "code_v2_val": "UBB",
        "currency": "HKD",
        "enable": "Activated",
        "enable_val": "true",
        "type": "User",
        "type_val": "user",
        "condition_warn": "Unlimited",
        "condition_audit": ">=1.00",
        "condition_reject": "Unlimited",
        "updated_at": "1784017190",
        "last_update_user": "user@example.com",
        "account_channel": "longport_test"
      }
    ],
    "total": 48
  }
}