Skip to content
Longport WhaleLongport Whale
Subscription Record Synchronization

Sync record overview

Returns a sync-record overview, used to summarize a reporting record's subscription volume by channel combined with client and upstream subscription method and financing ratio.

Request parameters

  • Combine business filters through filters (see the filter field notes below for the available fields), then use page, page_size, and orderBy for pagination and sorting.

Business notes

  • The data is grouped by channel, method, client financing ratio, upstream reported subscription method, and upstream reported financing ratio, returning subscription order count, total subscription amount, and total subscription quantity.
  • A single record (id) may split into multiple rows when the client's and the upstream's subscription method or financing ratio differ.
  • Commonly used within the subscription-record sync flow to get an overall view of a record's subscription distribution before drilling into item-level detail.

Returns

On success, returns the matched records with pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/ipo_ob_sync_record_details

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

ipo.financing_rate

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

Request body application/json

filtersobject

Filters

Child attributes
idstring

ID

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
channelstring

Channel

methodstring

Method

method_valstring

Method (raw value). Raw value behind field method: method returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

ratiostring

Client Financing Ratio

cntstring

Subscription Orders

total_amtstring

No. of Subscription Orders

total_qtystring

Subscription Amounts

target_methodstring

Counterparty Subscription Method

target_method_valstring

Counterparty Subscription Method (raw value). Raw value behind field target_method: target_method returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

tratiostring

Counterparty Financing Ratio

totalintegerrequired

Total

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