Clearing - System Configuration

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

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

Query parameters

filtersobject

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

Child attributes

remarkstring

Filters results by Configuration Items.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing - System Configuration 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

config_codestring

Returned value: Configuration Items.

config_code_valstring

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

enablestring

Returned value: Indicates whether enable/disable.

config_typestring

Returned value: Type.

config_type_valstring

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

valstring

Returned value: Other parameters.

makerstring

Returned value: Operator.

maker_valstring

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

created_atstring

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

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/clearing_system_configs' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "config_code": "Deposit interest switch",
        "config_code_val": "1001",
        "enable": "0",
        "config_type": "Switch",
        "config_type_val": "0",
        "val": "",
        "maker": "木木",
        "maker_val": "21206",
        "created_at": "1775631987"
      }
    ],
    "total": 23
  }
}

Export

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

POSThttps://b-api.longbridge.xyz/v1/datasets/clearing_system_configs/download

Export options Export records Download result