/sse/companies

POST /api/sse/companies

Price: 1 credit

Get the profile of a company listed on the Shanghai Stock Exchange: Chinese and English names, A- and B-share codes and listing dates, board, CSRC industry, region, addresses and contacts, legal representative and board secretary, share structure and the ten largest shareholders

How to use it

Takes the six-digit A-share code; a B-share code (900xxx) answers 412, so look it up with sse/companies/search and pass `company_code`. 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)
• company string required — Six-digit A-share stock code or SSE company page URL (examples: "600519", "688981", "https://www.sse.com.cn/assortment/stock/list/info/company/index.shtml?COMPANY_CODE=600519"; minLength: 1)

Response

• @type string (default: "SseCompany")
• company_code string required
• url string required
• a_share_code string nullable
• b_share_code string nullable
• name string nullable
• name_en string nullable
• full_name string nullable
• full_name_en string nullable
• a_share_name string nullable
• b_share_name string nullable
• b_share_full_name string nullable
• security_full_name string nullable
• security_type string nullable
• board string nullable
• a_share_listed_date integer nullable
• b_share_listed_date integer nullable
• a_share_status string nullable
• b_share_status string nullable
• status_flags array (default: [])
• industry_code string nullable
• industry string nullable
• industry_division_code string nullable
• industry_division string nullable
• star_industry string nullable
• region string nullable
• region_code string nullable
• city_code string nullable
• registered_address string nullable
• office_address string nullable
• postal_code string nullable
• email string nullable
• investor_relations_phone string nullable
• legal_representative string nullable
• board_secretary string nullable
• has_weighted_voting_rights boolean nullable
• is_listed_abroad boolean nullable
• foreign_listing_venue string nullable
• convertible_bond_code string nullable
• convertible_bond_name string nullable
• other_listing_code string nullable
• other_listing_name string nullable
• share_structure object nullable
  • @type string (default: "SseShareStructure")
  • as_of_date integer nullable
  • total_domestic_shares number nullable
  • total_unrestricted_shares number nullable
  • a_unrestricted_shares number nullable
  • a_restricted_shares number nullable
  • b_shares number nullable
  • cdr_shares number nullable
  • special_shares number nullable
• top_shareholders array (default: [])
  • @type string (default: "SseShareholder")
  • name string required
  • shares integer nullable
  • percent number nullable
  • report_date integer nullable

Errors

• 422 — company is not a six-digit stock code or SSE company 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 Shanghai-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.