Clearing - Custodian Management

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

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

namestring

Filters results by Custodian Name.

ccass_codestring

Filters results by CCASS Code.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

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

Returned value: Unique identifier of the current record.

namestring

Returned value: Name.

custodian_typestring

Returned value: Type.

custodian_type_valstring

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

settlement_channelstring

Returned value: Settlement Channel.

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.

settle_typestring

Returned value: Basis Of Holding Reconciliation.

settle_type_valstring

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

trading_account_typestring

Returned value: Basis Of Sub Account.

trading_account_type_valstring

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

ccass_codestring

Returned value: CCASS Code.

addressstring

Returned value: Address.

emailstring

Returned value: Email.

faxstring

Returned value: Fax.

contact_personstring

Returned value: Stamp Duty Contact Person.

telstring

Returned value: Stamp Duty Tel.

stamp_duty_file_nostring

Returned value: Stamp Duty File No.

seat_nosstring

Returned value: Broker No.

company_namestring

Returned value: Report Company Name.

updated_atstring

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

updated_bystring

Returned value: Updated By.

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "20940",
        "name": "CLSA",
        "custodian_type": "Custodian/Broker",
        "custodian_type_val": "1",
        "settlement_channel": "settlement_clsa_hk",
        "settlement_channel_val": "settlement_clsa_hk",
        "settle_type": "Settled Position",
        "settle_type_val": "0",
        "trading_account_type": "Trading Account",
        "trading_account_type_val": "1",
        "ccass_code": "",
        "address": "示例地址 Example Address",
        "email": "user@example.com",
        "fax": "1",
        "contact_person": "",
        "tel": "",
        "stamp_duty_file_no": "",
        "seat_nos": "",
        "company_name": "",
        "updated_at": "1776134933",
        "updated_by": "user@example.com"
      }
    ],
    "total": 24
  }
}

Export

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

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

Export options Export records Download result