/szse/ipo-projects

POST /api/szse/ipo-projects

Price: 5 credits

Get one IPO, refinancing, restructuring or board-transfer application reviewed by the Shenzhen Stock Exchange: company, status, intermediaries with their signing staff, the review progress and timeline, the recorded status events and every disclosed document (prospectus, sponsor and legal reports, inquiry responses, committee and registration results) with PDF links

How to use it

Find project ids with szse/ipo-projects/search; `timeline` is oldest first, `events` newest first.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Review project id (examples: "1002816", "1002245"; minLength: 1)

Response

• @type string (default: "SzseIpoProjectDetail")
• id string required
• company_name string nullable
• company_short_name string nullable
• project_type string nullable
• board string nullable
• status string nullable
• status_code integer nullable
• stage string nullable
• stage_code integer nullable
• region string nullable
• industry string nullable
• planned_raise_cny number nullable
• planned_asset_purchase_issue_cny number nullable
• planned_matching_raise_cny number nullable
• business_subtype string nullable
• business_subtype_code integer nullable
• issue_target string nullable
• issue_target_code integer nullable
• review_procedure string nullable
• review_procedure_code integer nullable
• accepted_date integer nullable
• updated_date integer nullable
• sponsor string nullable
• sponsor_short_name string nullable
• sponsor_code string nullable
• sponsor_representatives array (default: [])
• co_sponsor string nullable
• co_sponsor_short_name string nullable
• co_sponsor_code string nullable
• co_sponsor_representatives array (default: [])
• law_firm string nullable
• lawyers array (default: [])
• accounting_firm string nullable
• accountants array (default: [])
• appraiser string nullable
• appraisers array (default: [])
• latest_audit_end_date integer nullable
• progress array (default: [])
  • @type string (default: "SzseIpoStep")
  • step string nullable
  • status_code integer nullable
  • is_finished boolean nullable
  • started_at integer nullable
  • stage_type integer nullable
• timeline array (default: [])
  • @type string (default: "SzseIpoStep")
  • step string nullable
  • status_code integer nullable
  • is_finished boolean nullable
  • started_at integer nullable
  • stage_type integer nullable
• events array (default: [])
  • @type string (default: "SzseIpoEvent")
  • occurred_at integer nullable
  • text string nullable
• documents array (default: [])
  • @type string (default: "SzseIpoDocument")
  • group string required
  • material string nullable
  • url string nullable
  • file_name string nullable
  • file_format string nullable
  • published_at integer nullable
  • document_type_code integer nullable
  • material_category_code integer nullable
  • file_id integer 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 SZSE review 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.