Skip to content
Subscription Record Synchronization

Subscription Order Sync List

Queries Subscription Order Sync List data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

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/ipo_sync_records

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

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

Permission

ipo.financing_rate

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Query parameters

filtersobject

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

Child attributes
counter_idstring

Counter Id. Filters results by Counter Id.

statestring

Sync Status. Filters results by Sync Status.

1,2 · Pending Synchronization3,4 · Synchronized, awaiting result5 · Failed, please try again6,7 · Result Returned

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Subscription Order Sync List 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.

counter_idstring

Counter Id. Returned value: Counter Id.

counter_id_valstring

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

stock_namestring

Stock Name. Returned value: Stock Name.

total_cntstring

Sync Orders. Returned value: Sync Orders.

statestring

Sync Status. Returned value: Sync Status.

state_valstring

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

received_cntstring

No. of Successful Receptions. Returned value: No. of Successful Receptions.

failed_cntstring

No. of Failed Receptions. Returned value: No. of Failed Receptions.

methodstring

Subscription Method. Returned value: Subscription Method.

method_valstring

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

target_methodstring

Counterparty Subscription Method. Returned value: Counterparty Subscription Method.

target_method_valstring

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

ratiostring

Financing Ratio. Returned value: Financing Ratio.

tratiostring

Counterparty Financing Ratio. Returned value: Counterparty Financing Ratio.

created_atstring

Submission Time. Returned value: Submission Time. The date or time format follows the value returned by the API.

receipt_atstring

Response Time. Returned value: Response Time. The date or time format follows the value returned by the API.

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

Whale Docs