Skip to content
HK IPO

Import IPO Subscription Payables

Bulk-imports the IPO subscription list for a specified security from an uploaded file.

Request parameters

  • Required: counter_id (security ID), file_path (file location)
  • See each field description for its format, value range, and business meaning.

Business notes

Writes the subscription list items of the instrument from the file at file_path. Importing takes three steps:

  1. Call GET /file/upload_url?service=lb.ipo.service to get a presigned upload URL and a key, then PUT the CSV file; that key is the file_path.
  2. Call POST /v1/ipo/payable/parse with the same counter_id and file_path to create a parse batch.
  3. Call this endpoint to import. Without a prior parse it returns 400 解析批次已失效 (parse batch expired).

Importing replaces the instrument's whole subscription list with the file contents: every existing row is replaced, rows that remain get new ids, and previously fetched ids can no longer be used with ipo_payable_save / ipo_payable_delete.

Risk warning

This operation bulk-writes payable data used for IPO subscription deductions. Verify the security and the import file content before calling.

Result

On success, the subscription list is bulk-imported; the returned data follows the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/ipo/payable/import

Authorization

AuthorizationstringheaderRequired

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

Permission

ipo.subscription_manage

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

Request body application/json

counter_idstringrequired

Counter ID. This field is required. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

file_pathstringrequired

File path. The key returned by GET /file/upload_url?service=lb.ipo.service. Call POST /v1/ipo/payable/parse with the same counter_id and file_path first, or the import returns 400 解析批次已失效 (parse batch expired). This field is required.

Responses

HTTP 200The request was processed successfully. data.result is true when the import is complete.
Standard response envelopecodemessagedata
dataobjectdata structure
resultboolean

Whether the request succeeded.

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