Manual Adjustment - OTC Derivatives

Queries Manual Adjustment - OTC Derivatives data. Combine business filters in filters, and use page and page_size to control pagination.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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

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

Child attributes

aaidstring

AAID. Filters results by AAID.

directionstring

Adjustment Direction. Filters results by Adjustment Direction.

Allowed values: DEBIT, CREDIT

DEBITCREDIT

ticket_statusstring

Status. Filters results by Status.

Allowed values:

WAIT - Waiting for Approval
WAIT_APPROVE - Under Approval
REJECTED - Rejected
CLOSE - Close
REVOKING - Revoking
REVOKED - Revoked
SUCCESS - Success
FAILED - Failed
PROCESS - Process

WAITWAIT_APPROVEREJECTEDCLOSEREVOKINGREVOKEDSUCCESSFAILEDPROCESS

request_idstring

Batch ID. Filters results by Batch ID.

finish_atobject

Completed At. Filters results by Completed At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

Responses

HTTP 200On success, returns paginated Manual Adjustment - OTC Derivatives 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.

member_idstring

Member ID. Returned value: Member ID.

member_id_valstring

Member ID (raw value). 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.

aaid2string

Name. Returned value: Name.

aaid2_valstring

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

aaid3string

A/C No. Returned value: A/C No.

aaid3_valstring

A/C No (raw value). Raw value of aaid3. The aaid3 field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

security_typestring

Asset Type. Returned value: Asset Type.

security_type_valstring

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

directionstring

Adjustment Direction. Returned value: Adjustment Direction.

direction_valstring

Adjustment Direction (raw value). 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.

biz_codestring

Biz Code. Returned value: Biz Code.

biz_code_valstring

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

biz_code_visiblestring

Display to Client?. Returned value: Display to Client?.

biz_code_visible_valstring

Display to Client? (raw value). Raw value of biz_code_visible. The biz_code_visible field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_idstring

OTC Derivatives. Returned value: OTC Derivatives.

custodianstring

Custodian. Returned value: Custodian.

custodian_valstring

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

sub_position_no_namestring

Sub Account No. Returned value: Sub Account No.

sub_position_no_name_valstring

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

streetstring

Street. Returned value: Street.

nomineestring

Nominee. Returned value: Nominee.

ownstring

Own. Returned value: Own.

incurred_quantitystring

Qty. Returned value: Qty.

cost_amountstring

Cost. Returned value: Cost.

cost_currencystring

Currency. Returned value: Currency.

ticket_statusstring

Status. Returned value: Status.

ticket_status_valstring

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

ticket_creatorstring

Submitted By. Returned value: Submitted By.

ticket_creator_valstring

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

ticket_approvedstring

Approved By. Returned value: Approved By.

ticket_approved_valstring

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

remarkstring

Remarks. Returned value: Remarks.

inner_remarkstring

Internal Remarks. Returned value: Internal Remarks.

resultstring

Adjustment Status. Returned value: Adjustment Status.

result_valstring

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

created_atstring

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

user_ledger_datestring

Ledger Date. Returned value: Ledger Date. The date or time format follows the value returned by the API.

third_flagstring

Third Party. Returned value: Third Party.

third_flag_valstring

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

finish_atstring

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

ticket_idstring

Ticket No. Returned value: Ticket No.

request_idstring

Batch ID. Returned value: Batch ID.

revoke_request_idstring

Revoke Batch ID. Returned value: Revoke Batch ID.

app_notifystring

App Push. Returned value: App Push.

app_notify_valstring

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

email_notifystring

Email Push. Returned value: Email Push.

email_notify_valstring

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

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "13538809",
        "member_id": "1000000000000000000",
        "member_id_val": "",
        "aaid2": " LB",
        "aaid2_val": "55786646",
        "aaid3": "H00000000",
        "aaid3_val": "55786646",
        "security_type": "WM",
        "security_type_val": "WM",
        "direction": "CREDIT",
        "direction_val": "CREDIT",
        "biz_code": "LDPDNSCR12 [Buy Completed]",
        "biz_code_val": "LDPDNSCR12",
        "biz_code_visible": "Visible",
        "biz_code_visible_val": "true",
        "counter_id": "DP/FN/R1F5AVGWAJQS6-O001",
        "custodian": "",
        "custodian_val": "",
        "sub_position_no_name": "",
        "sub_position_no_name_val": "",
        "street": "202,020",
        "nominee": "",
        "own": "",
        "incurred_quantity": "202,020",
        "cost_amount": "202,020",
        "cost_currency": "HKD",
        "ticket_status": "Success",
        "ticket_status_val": "SUCCESS",
        "ticket_creator": "示例用户",
        "ticket_creator_val": "示例用户",
        "ticket_approved": "逸风 (Mo Yutao)",
        "ticket_approved_val": "27379",
        "remark": "",
        "inner_remark": "",
        "result": "Finished",
        "result_val": "调账完成",
        "created_at": "1783324144",
        "user_ledger_date": "",
        "third_flag": " ",
        "third_flag_val": "false",
        "finish_at": "1783324148",
        "ticket_id": "4442236",
        "request_id": "20260706074904971cffa16429bc11",
        "revoke_request_id": "",
        "app_notify": "NO",
        "app_notify_val": "false",
        "email_notify": "user@example.com",
        "email_notify_val": "user@example.com"
      }
    ],
    "total": 107
  }
}

Export

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

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

Export options Export records Download result