/cninfo/companies

POST /api/cninfo/companies

Price: 1 credit

Get the profile of a company listed in Shenzhen, Shanghai or Beijing from CNINFO: names, industry, board, listing and founding dates, management, addresses and contacts, business scope, IPO details, linked B-share, H-share and bond codes, share capital and headline financial ratios

How to use it

Takes the six-digit A-share code; a B-share code answers 412, so pass `a_share_code` instead. Find the code with cninfo/companies/search from a name or pinyin initials. Money fields are 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 — A-share stock code or CNINFO company page URL (examples: "300750", "600519", "https://www.cninfo.com.cn/new/disclosure/stock?stockCode=300750&orgId=GD165627"; minLength: 1)

Response

• @type string (default: "CninfoCompany")
• code string required
• name string nullable
• full_name string nullable
• english_name string nullable
• former_names array (default: [])
• name_initials string nullable
• org_id string nullable
• url string nullable
• security_category string nullable
• is_delisted boolean nullable
• listing_board string nullable
• board_type_code string nullable
• industry string nullable
• indices array (default: [])
• founded_date integer nullable
• listed_date integer nullable
• legal_representative string nullable
• general_manager string nullable
• board_secretary string nullable
• registered_address string nullable
• office_address string nullable
• postal_code string nullable
• phone string nullable
• fax string nullable
• email string nullable
• website string nullable
• main_business string nullable
• business_scope string nullable
• description string nullable
• registered_capital_cny number nullable
• a_share_code string nullable
• a_share_name string nullable
• b_share_code string nullable
• b_share_name string nullable
• h_share_code string nullable
• h_share_name string nullable
• convertible_bond string nullable
• cdr string nullable
• par_value_cny number nullable
• ipo_price_cny number nullable
• ipo_net_proceeds_cny number nullable
• ipo_lead_underwriter string nullable
• financial_statement_template integer nullable
• total_shares number nullable
• float_shares number nullable
• latest_revenue_cny number nullable
• latest_net_profit_cny number nullable
• cash_cny number nullable
• receivables_cny number nullable
• goodwill_cny number nullable
• roe_percent number nullable
• debt_to_assets_percent number nullable
• pledge_ratio_percent number nullable

Errors

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