Skip to content
Subscription Records

Iposubscription Record Query

Queries Iposubscription Record Query 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_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

ipo.ipo_ordercrm_admin.trade

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
updated_atobject

Update At. Filters results by Update At.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

created_atobject

Created At. Filters results by Created At.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

aaidstring

Client. Filters results by Client.

counter_idstring

Stock. Filters results by Stock.

successstring

Success. Filters results by Success.

false · Failedtrue · Successful=* · --

statusstring

Local Order Status. Filters results by Local Order Status.

1 · Pending deduction,Funds are freezing2 · Deduction failed3 · Deducted,To be allotment4 · Allotment,Successful5 · Allotment,Failed6 · Revoked7 · Cancel8 · Refused100 · --

marketstring

Market. Filters results by Market.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

markstring

Subscription Methods. Filters results by Subscription Methods.

0 · Normal Order

origin_channelstring

Origin Channel. Filters results by Origin Channel.

Values are dynamic. Call GET /v1/datasets/refs/ipo_channel to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

subscription_methodstring

Kind. Filters results by Kind.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

1 · Margin2 · Cash4 · Placement5 · 0 Cost

idstring

Order ID. Filters results by Order ID.

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 Iposubscription Record Query 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

Order ID. Returned value: Unique identifier of the current record.

custom_memberstring

Client. Returned value: Client.

origin_idstring

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

counter_idstring

Stock. Returned value: Stock.

marketstring

Market. Returned value: Market.

custom2_subscriptionstring

Subscription. Returned value: Subscription.

custom_allotmentstring

Allotment. Returned value: Allotment.

statusstring

Local Status. Returned value: Local Status.

status_valstring

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

statestring

Action. Returned value: Action.

state_valstring

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

custom_financingstring

Financing. Returned value: Financing.

need_payment_with_currencystring

To Be Paid. Returned value: To Be Paid.

withdraw_cash_with_currencystring

IPO User Balance. Returned value: IPO User Balance.

margin_callstring

Margin Call Amount. Returned value: Margin Call Amount.

subscription_methodstring

Type. Returned value: Type.

subscription_method_valstring

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

origin_channelstring

Channel. Returned value: Channel.

markstring

Subscription Method. Returned value: Subscription Method.

mark_valstring

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

interest_amountstring

Financing Interest Deduction Amt. Returned value: Financing Interest Deduction Amt.

commission_amountstring

Handling Fees Deduction Amt. Returned value: Handling Fees Deduction Amt.

custom_timestring

Submit/Updated Time. Returned value: Submit/Updated 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