https://b-api.longbridge.xyz/v1/datasets/ipo_ordersDataset 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
Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.
Permission
The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.
Query parameters
Filters. Combines business filters. Omit a filter field to disable that filter.
Child attributes
Update At. Filters results by Update At.
Child attributes
Greater Than or Equal. Inclusive lower bound of the filter range.
Less Than or Equal. Inclusive upper bound of the filter range.
Created At. Filters results by Created At.
Child attributes
Greater Than or Equal. Inclusive lower bound of the filter range.
Less Than or Equal. Inclusive upper bound of the filter range.
Client. Filters results by Client.
Stock. Filters results by Stock.
Success. Filters results by Success.
false · Failedtrue · Successful=* · --
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 · --
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
Subscription Methods. Filters results by Subscription Methods.
0 · Normal Order
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.
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
Order ID. Filters results by Order ID.
Page. Page number to retrieve, starting from 1.
Page Size. Number of records to return per page.
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.codemessagedatadataobjectdata structureList. Returned value: List of list.
Child attributes
Order ID. Returned value: Unique identifier of the current record.
Client. Returned value: Client.
A/C No.. Returned value: A/C No..
Stock. Returned value: Stock.
Market. Returned value: Market.
Subscription. Returned value: Subscription.
Allotment. Returned value: Allotment.
Local Status. Returned value: Local Status.
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.
Action. Returned value: Action.
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.
Financing. Returned value: Financing.
To Be Paid. Returned value: To Be Paid.
IPO User Balance. Returned value: IPO User Balance.
Margin Call Amount. Returned value: Margin Call Amount.
Type. Returned value: Type.
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.
Channel. Returned value: Channel.
Subscription Method. Returned value: Subscription Method.
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.
Financing Interest Deduction Amt. Returned value: Financing Interest Deduction Amt.
Handling Fees Deduction Amt. Returned value: Handling Fees Deduction Amt.
Submit/Updated Time. Returned value: Submit/Updated Time. The date or time format follows the value returned by the API.
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.codemessagedatadataobjectdata structureNo nested fields
HTTP 401The user is not authenticated, or the login session has expired.codemessagedatadataobjectdata structureNo nested fields
HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.codemessagedatadataobjectdata structureNo nested fields
HTTP 408The request timed out. Check the business error code in code and the error details in message.codemessagedatadataobjectdata structureNo nested fields