Skip to content
International Placing

Placement subscription records

Query the list of international placement subscription records.

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

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

placement.manager

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

Query parameters

filtersobject

Filters

Child attributes
updated_atobject

Update At. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
gtestring

Greater Than or Equal

ltestring

Less Than or Equal

created_atobject

Created At. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
gtestring

Greater Than or Equal

ltestring

Less Than or Equal

aaidstring

Client

statusstring

Local Order Status

145678

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
idstring

Order ID

custom_memberstring

Client

origin_idstring

A/C No.

counter_idstring

Stock

marketstring

Market

subscription_methodstring

Type

subscription_method_valstring

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

custom_subscriptionstring

Subscription

custom_allotmentstring

Allotment

statusstring

Local Status

status_valstring

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

need_payment_with_currencystring

To Be Paid

withdraw_cash_with_currencystring

Client Balance

margin_callstring

Margin Call Amount

origin_channelstring

Channel

commission_amountstring

Handling Fees Deduction Amt

custom_timestring

Submit/Updated Time

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