/bse/companies

POST /api/bse/companies

Price: 1 credit

Get the profile of a company listed on the Beijing Stock Exchange: short, full, English and former names, ISIN, industry, region, listing dates, total and float shares, sponsor broker, trading mode, the weighted-voting flag and the day's price limits

How to use it

Takes the current 920xxx code; a pre-change code answers 412, and `has_former_code` marks a company that had one. 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 stock code or BSE company page URL (examples: "920021", "https://www.bse.cn/products/neeq_listed_companies/related_announcement.html?companyCode=920021"; minLength: 1)

Response

• @type string (default: "BseCompany")
• company_code string required
• name string nullable
• full_name string nullable
• name_en string nullable
• former_names array (default: [])
• isin string nullable
• industry string nullable
• industry_code string nullable
• region string nullable
• listed_date integer nullable
• published_date integer nullable
• neeq_listed_date integer nullable
• total_shares integer nullable
• float_shares integer nullable
• sponsor_broker string nullable
• transfer_mode string nullable
• has_weighted_voting_rights boolean nullable
• has_former_code boolean nullable
• limit_up_price_cny number nullable
• limit_down_price_cny number nullable
• as_of_date integer nullable

Errors

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