/bse/companies/search

POST /api/bse/companies/search

Price: 1 credit

List the companies listed on the Beijing Stock Exchange by stock code, CSRC industry division and province: code, short and English names, ISIN, industry, region, listing date, total and float shares, sponsor broker, trading mode and the day's price limits

How to use it

Matches stock codes only, not names. Industry codes are CSRC divisions such as C36 (automobile manufacturing). Pass `company_code` to bse/companies for the 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: 400)
• stock_code string nullable — Six-digit stock code to match (examples: "920021"; pattern: ^\d{6}$)
• industry_codes array nullable — CSRC industry division codes (examples: ["C36"], ["C36","C35"]; minItems: 1)
• regions array nullable — Provinces of the companies (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"; minItems: 1)
• sort string — Result order (default: "code"; one of: "code", "listed_newest", "listed_oldest")

Response

• @type string (default: "BseListedCompany")
• company_code string required
• name string nullable
• name_en string nullable
• isin string nullable
• industry string nullable
• region string nullable
• listed_date integer nullable
• neeq_listed_date integer nullable
• total_shares integer nullable
• float_shares integer nullable
• sponsor_broker string nullable
• transfer_mode string nullable
• limit_up_price_cny number nullable
• limit_down_price_cny number nullable
• as_of_date integer nullable

Errors

• 422 — stock_code is not six digits, an industry code is not a CSRC division, or an unknown 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.