/szse/companies

POST /api/szse/companies

Price: 1 credit

Get the profile of a company listed on the Shenzhen Stock Exchange: Chinese and English names, A- and B-share codes with listing dates and share counts, board, industry, region, province and city, registered address, website, the unprofitable, weighted-voting and VIE flags, and the latest trading indicators (amount, trades, P/E, turnover, market capitalisation) beside the previous day's

How to use it

Takes the A-share code; a B-share-only code (200xxx) answers 412. Find codes with szse/companies/search. Money is in CNY and share counts in shares.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Six-digit stock code or SZSE stock page URL (examples: "000001", "300750", "https://www.szse.cn/certificate/individual/index.html?code=300750"; minLength: 1)

Response

• @type string (default: "SzseCompany")
• company_code string required
• url string required
• name string nullable
• name_extended string nullable
• full_name string nullable
• full_name_en string nullable
• board string nullable
• a_share_code string nullable
• a_share_listed_date integer nullable
• a_share_total_shares number nullable
• a_share_float_shares number nullable
• b_share_code string nullable
• b_share_name string nullable
• b_share_name_extended string nullable
• b_share_listed_date integer nullable
• b_share_total_shares number nullable
• b_share_float_shares number nullable
• industry string nullable
• region string nullable
• province string nullable
• city string nullable
• registered_address string nullable
• website string nullable
• is_unprofitable boolean nullable
• has_weighted_voting_rights boolean nullable
• has_vie_structure boolean nullable
• trading object nullable
  • @type string (default: "SzseTradingIndicators")
  • as_of_date integer nullable
  • amount_cny number nullable
  • trades number nullable
  • pe_ratio number nullable
  • turnover_percent number nullable
  • market_cap_cny number nullable
  • float_market_cap_cny number nullable
  • total_shares number nullable
  • float_shares number nullable
  • previous_amount_cny number nullable
  • previous_trades number nullable
  • previous_pe_ratio number nullable
  • previous_turnover_percent number nullable
  • previous_market_cap_cny number nullable
  • previous_float_market_cap_cny number nullable
  • previous_total_shares number nullable
  • previous_float_shares number nullable

Errors

• 422 — company is not a six-digit stock code or SZSE stock 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 Shenzhen-listed company under that stock code 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.