/szse/companies/search

POST /api/szse/companies/search

Price: 1 credit

List companies listed on the Shenzhen Stock Exchange (main board and ChiNext) as A-shares, B-shares, CDRs or A+B pairs, by code or name, board, CSRC industry and location: code, short name, board, listing date, total and float shares, industry and the unprofitable, weighted-voting and VIE flags

How to use it

`keyword` matches codes and Chinese short names. Pass `company_code` as `company` to szse/companies for the full profile. Share counts are in shares.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of listings to return (min: 1; max: 3000)
• keyword string nullable — Stock code or short name (examples: "000001", "平安"; minLength: 1)
• share_class string — Which listing table to read (default: "a_share"; one of: "a_share", "b_share", "cdr", "a_and_b")
• board string nullable — Board of the listing; both when omitted (one of: "main", "chinext")
• industry string nullable — CSRC industry sector (one of: "agriculture", "mining", "manufacturing", "utilities", "construction", "wholesale_retail", "transport_logistics", "hospitality_catering", "information_technology", "finance", "real_estate", "leasing_business_services", "research_technical_services", "environment_public_facilities", "resident_services", "education", "health_social_work", "culture_sports_entertainment", "diversified")
• location string nullable — Province or city of the company, in Chinese (examples: "深圳", "广东"; minLength: 1)

Response

• @type string (default: "SzseListedCompany")
• company_code string required
• name string nullable
• share_class string required
• board string nullable
• listed_date integer nullable
• total_shares number nullable
• float_shares number nullable
• b_share_code string nullable
• b_share_name string nullable
• b_share_listed_date integer nullable
• industry_code string nullable
• industry string nullable
• shares_per_cdr number nullable
• is_unprofitable boolean nullable
• has_weighted_voting_rights boolean nullable
• has_vie_structure boolean nullable

Errors

• 422 — An unknown share_class, board or industry 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 — The entity was not found, or a precondition failed 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.