/bse/ipo-projects

POST /api/bse/ipo-projects

Price: 5 credits

Get one IPO application reviewed by the Beijing Stock Exchange: company, status, intermediaries with their signing staff, the review dates (receipt, inquiry, listing committee, registration, suspension, termination), the exchange's suspension and resumption notes and every disclosed document (prospectus, sponsor letters, audit and legal reports, inquiry replies) with PDF links

How to use it

Find project ids with bse/ipo-projects/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — IPO project id (examples: "772"; pattern: ^\d{1,9}$)

Response

• @type string (default: "BseIpoProjectDetail")
• id string required
• item_number string nullable
• company_name string nullable
• stock_code string nullable
• stock_name string nullable
• status_code string nullable
• company_type_code string nullable
• registered_address string nullable
• sponsor string nullable
• sponsor_representatives array (default: [])
• law_firm string nullable
• lawyers array (default: [])
• accounting_firm string nullable
• accountants array (default: [])
• appraiser string nullable
• appraisers array (default: [])
• received_date integer nullable
• published_date integer nullable
• operated_at integer nullable
• updated_at integer nullable
• review_dates object nullable
  • @type string (default: "BseIpoReviewDates")
  • received_date integer nullable
  • inquiry_date integer nullable
  • listing_committee_date integer nullable
  • listing_committee_result string nullable
  • listing_committee_result_date integer nullable
  • submitted_date integer nullable
  • approval_result string nullable
  • approval_result_date integer nullable
  • re_pass_date integer nullable
  • suspended_date integer nullable
  • terminated_date integer nullable
• events array (default: [])
  • @type string (default: "BseIpoEvent")
  • event_id string nullable
  • occurred_date integer nullable
  • text string nullable
• documents array (default: [])
  • @type string (default: "BseIpoDocument")
  • id string required
  • pdf_url string nullable
  • file_format string nullable
  • published_date integer nullable
  • updated_at integer nullable
  • company_code string nullable
  • company_name string nullable
  • type_code string nullable
  • subtype_code string nullable
  • revision_count integer nullable
  • group_code string required
  • stage_code string nullable

Errors

• 422 — id is not a numeric project id Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No BSE IPO project under that id Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.