/sse/ipo-projects

POST /api/sse/ipo-projects

Price: 5 credits

Get one IPO application reviewed by the Shanghai Stock Exchange: issuer, board, review status, planned raise, intermediaries with their signing staff, the review timeline, the reasons recorded for status changes and the disclosed documents (prospectus drafts, sponsor, legal and audit reports) with PDF links

How to use it

Find project ids with sse/ipo-projects/search; `timeline` is oldest step 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 — IPO project id or SSE project page URL (examples: "2245", "https://www.sse.com.cn/listing/renewal/ipo/index_listing_detail.shtml?auditId=2245"; minLength: 1)

Response

• @type string (default: "SseIpoProjectDetail")
• id string required
• url string required
• company_name string nullable
• company_short_name string nullable
• company_stock_code string nullable
• uniform_credit_code string nullable
• board string nullable
• status string nullable
• status_code integer nullable
• committee_result_code integer nullable
• registration_result_code integer nullable
• suspension_code integer nullable
• project_type_code integer nullable
• planned_raise_cny number nullable
• industry_code string nullable
• industry string nullable
• province string nullable
• district string nullable
• applied_at integer nullable
• created_at integer nullable
• updated_at integer nullable
• issuer_people array (default: [])
  • @type string (default: "SseIpoPerson")
  • name string nullable
  • job_title string nullable
  • job_type_code integer nullable
  • person_id string nullable
• intermediaries array (default: [])
  • @type string (default: "SseIpoIntermediary")
  • name string nullable
  • short_name string nullable
  • role string nullable
  • intermediary_id string nullable
  • order integer nullable
  • people array (default: [])
    • @type string (default: "SseIpoPerson")
    • name string nullable
    • job_title string nullable
    • job_type_code integer nullable
    • person_id string nullable
• timeline array (default: [])
  • @type string (default: "SseIpoStep")
  • status string nullable
  • status_code integer nullable
  • published_date integer nullable
  • signed_at integer nullable
  • recorded_at integer nullable
  • reason string nullable
  • item_id string nullable
• status_reasons array (default: [])
  • @type string (default: "SseIpoStep")
  • status string nullable
  • status_code integer nullable
  • published_date integer nullable
  • signed_at integer nullable
  • recorded_at integer nullable
  • reason string nullable
  • item_id string nullable
• documents array (default: [])
  • @type string (default: "SseIpoDocument")
  • url string nullable
  • file_name string nullable
  • type_code string nullable
  • file_type_code integer nullable
  • size_bytes integer nullable
  • version integer nullable
  • updated_at integer nullable
  • file_id string nullable

Errors

• 422 — id is not a numeric project id or SSE project page URL 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 SSE 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.