/sse/companies/search

POST /api/sse/companies/search

Price: 5 credits

List companies listed on the Shanghai Stock Exchange by share class (main-board A, B or STAR Market), listing status, CSRC industry and province, each with its stock codes, Chinese and English names, board, industry, region and listing date

How to use it

Matches stock codes only, not names. A B-share company is listed under its A-share `company_code` with the B-share code in `b_share_code`; pass `company_code` to sse/companies for the full profile.

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 companies to return (min: 1; max: 2500)
• share_class string nullable — Share class to list; all classes when omitted (one of: "main_board_a", "b_share", "star")
• status string — Listed or delisted companies (default: "listed"; one of: "listed", "delisted")
• 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")
• region string nullable — Province of registration (one of: "beijing", "tianjin", "hebei", "shanxi", "inner_mongolia", "liaoning", "jilin", "heilongjiang", "shanghai", "jiangsu", "zhejiang", "anhui", "fujian", "jiangxi", "shandong", "henan", "hubei", "hunan", "guangdong", "guangxi", "hainan", "chongqing", "sichuan", "guizhou", "yunnan", "tibet", "shaanxi", "gansu", "qinghai", "ningxia", "xinjiang", "outside_mainland")
• stock_code string nullable — Six-digit stock code to match (examples: "600519"; pattern: ^\d{6}$)

Response

• @type string (default: "SseListedCompany")
• company_code 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
• security_name string nullable
• security_full_name string nullable
• share_class string nullable
• board string nullable
• listed_date integer nullable
• delisted_date integer nullable
• is_delisted boolean nullable
• industry_code string nullable
• industry string nullable
• region_code string nullable
• region string nullable
• state_code string nullable
• stock_state_code string nullable
• status_flags array (default: [])

Errors

• 422 — stock_code is not six digits, or an unknown share_class, industry or region 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.