Stock Freeze Ticket · Whale Docs

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

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.

freeze_ticket_statusstring

Freeze Approval Status. Filters results by Freeze Approval Status.

Allowed values:

WAIT - Waiting for Approval
WAIT_APPROVE - Under Approval
APPROVED - Approved
REJECTED - Rejected
CLOSE - Close

WAITWAIT_APPROVEAPPROVEDREJECTEDCLOSE

account_typestring

Account Type. Filters results by Account Type.

Allowed values: SETTLEMENT

SETTLEMENT

map_statusstring

Freeze Status. Filters results by Freeze Status.

Allowed values:

INIT - Init
FREEZED - Freezed
FREEZE_FAILED - Freeze Failed

INITFREEZEDFREEZE_FAILED

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 Stock Freeze Ticket 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.

user_namestring

Name. Returned value: Name.

user_name_valstring

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

origin_idstring

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

origin_id_valstring

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

account_typestring

Account Type. Returned value: Account Type.

statusstring

Freeze Status. Returned value: Freeze Status.

status_valstring

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

counter_idstring

Stock Code. Returned value: Stock Code.

freeze_amountstring

Freeze Qty. Returned value: Freeze Qty.

memostring

Freeze Remarks. Returned value: Freeze Remarks.

inner_memostring

Freeze Internal Remarks. Returned value: Freeze Internal Remarks.

expire_timestring

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

freeze_ticket_creatorstring

Freeze Req Submitted By. Returned value: Freeze Req Submitted By.

freeze_ticket_creator_valstring

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

freeze_ticket_statusstring

Freeze Approval Status. Returned value: Freeze Approval Status.

freeze_ticket_status_valstring

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

freeze_resultstring

Freeze Status. Returned value: Freeze Status.

freeze_result_valstring

Freeze Status (raw value). Raw value of freeze_result. The freeze_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.

updated_atstring

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

freeze_nostring

Freeze ID. Returned value: Freeze 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/account_stock_lock_tickets' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "75874",
        "member_id": "1000000000000000000",
        "member_id_val": "",
        "user_name": "示例用户",
        "user_name_val": "示例用户",
        "origin_id": "H00000000",
        "origin_id_val": "10000000",
        "account_type": "SETTLEMENT",
        "status": "Freezed",
        "status_val": "UNFREEZED",
        "counter_id": "ST/SZ/000001",
        "freeze_amount": "5",
        "memo": "auto-test-备注",
        "inner_memo": "auto-test-内部备注",
        "expire_time": "1782808245",
        "freeze_ticket_creator": "示例用户",
        "freeze_ticket_creator_val": "示例用户",
        "freeze_ticket_status": "Approved",
        "freeze_ticket_status_val": "APPROVED",
        "freeze_result": "Success",
        "freeze_result_val": "Success",
        "created_at": "1782376250",
        "updated_at": "1782808321",
        "freeze_no": "202606250830523086373427640447"
      }
    ],
    "total": 391
  }
}

Export

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

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

Export options Export records Download result