Clear Instruction Settings

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

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

Child attributes

marketstring

Values come from the clear_markets dynamic enumeration; not a fixed set.

biz_typestring

Values come from the clear_biz_type dynamic enumeration; not a fixed set.

pageinteger

page_sizeinteger

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

marketstring

market_valstring

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

settlement_channelstring

settlement_channel_valstring

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

stagestring

stage_valstring

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

account_typestring

account_type_valstring

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.

biz_typestring

biz_type_valstring

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

directionstring

direction_valstring

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

positionstring

position_valstring

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

instr_typestring

instr_type_valstring

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

settle_methodstring

settle_method_valstring

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

custodian_idstring

custodian_id_valstring

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

sub_position_nostring

updated_atstring

updated_bystring

totalintegerrequired

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_instruction_settings' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "market": "string",
        "market_val": "string",
        "settlement_channel": "string",
        "settlement_channel_val": "string",
        "stage": "string",
        "stage_val": "string",
        "account_type": "string",
        "account_type_val": "string",
        "biz_type": "string",
        "biz_type_val": "string",
        "direction": "string",
        "direction_val": "string",
        "position": "string",
        "position_val": "string",
        "instr_type": "string",
        "instr_type_val": "string",
        "settle_method": "string",
        "settle_method_val": "string",
        "custodian_id": "string",
        "custodian_id_val": "string",
        "sub_position_no": "string",
        "updated_at": "string",
        "updated_by": "string"
      }
    ],
    "total": 1
  }
}

Export

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

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

Export options Export records Download result