Skip to content
Longport Whale
Subscription Record Synchronization

Create OB Sync Record

The endpoint shared by "New" and inline "Retry" on the Subscription Record Synchronization page, used to create an OB subscription sync record.

POSThttps://b-api.longbridge.xyz/ob/create/record

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

counter_idstringrequired

Counter ID. IPO instrument code.

recordsarray<string>required

Sync Records. Each item is a channel sync configuration; on create it is the selected records (rows with an empty channel filtered out), and on retry it is a single-element array of the current row's data.

records[].channelstringrequired

Origin Channel. Origin channel.

records[].methodstringrequired

Subscription Method. Subscription method.

records[].ratiostringrequired

Ratio. A percentage value; sent as a string without the % sign, e.g. "100" means 100%.

records[].target_methodstringrequired

Target Method. Target subscription method.

records[].target_ratiostringrequired

Target Ratio. Target subscription ratio, a percentage value; sent as a string without the % sign.

is_retrybooleanrequired

Is Retry. Send false for a create operation; send true for a "Retry" operation.

Responses

HTTP 200No confirmable field definitions are available for the response yet.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs