Skip to content
Longport WhaleLongport Whale
HK IPO

Parse Subscription List File

Parses an uploaded subscription list file and creates the parse batch that the import uses.

Request parameters

  • Required: counter_id (instrument ID), file_path (file path)
  • See each field's description for format, value range, and business meaning.

Business notes

Step 2 of importing a subscription list:

  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. The first CSV row is the header 股数,金额 (shares, amount); each following row is one subscription tier with its payable amount.
  2. Call this endpoint to parse the file; it returns how many rows parsed and failed.
  3. Call POST /v1/ipo/payable/import with the same counter_id and file_path to import.

This endpoint only parses the file and does not change the subscription list.

Result

On success, returns the parsed row count success_cnt and the failed row count fail_cnt.

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

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

Instrument ID, in the form {type}/{market}/{code}, e.g. ST/HK/700. This field is required.

file_pathstringrequired

File path: the key returned by GET /file/upload_url?service=lb.ipo.service. This field is required.

Responses

HTTP 200The request was processed successfully. data returns the parsed and failed row counts.
Standard response envelopecodemessagedata
dataobjectdata structure
success_cntinteger

Number of rows parsed successfully.

fail_cntinteger

Number of rows that failed to parse.

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