/xueqiu/quotes/company

POST /api/xueqiu/quotes/company

Price: 5 credits

Get the company profile behind a Shanghai, Shenzhen, Beijing, Hong Kong or US listing from Xueqiu: names, business description, industry, chairman and management, controlling holder, staff, addresses, contacts and IPO terms

How to use it

Hong Kong profiles carry fewer fields than mainland and US ones: no short names, industry, management beyond the chairman, staff count or postcode.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• symbol string required — Xueqiu security symbol or quote page URL (examples: "SH600519", "00700", "AAPL", "https://xueqiu.com/S/SZ000001")

Response

• @type string (default: "XueqiuCompany")
• symbol string required
• url string nullable
• org_id string nullable
• name string nullable
• short_name string nullable
• name_en string nullable
• short_name_en string nullable
• former_name string nullable
• description string nullable
• main_business string nullable
• business_scope string nullable
• industry_code string nullable
• industry_name string nullable
• chairman string nullable
• legal_representative string nullable
• general_manager string nullable
• secretary string nullable
• actual_controller string nullable
• controller_type string nullable
• main_holder string nullable
• executives_count integer nullable
• employee_count integer nullable
• registered_capital number nullable
• currency string nullable
• country string nullable
• province string nullable
• district_code string nullable
• registered_address string nullable
• registered_address_en string nullable
• office_address string nullable
• office_address_en string nullable
• postcode string nullable
• phone string nullable
• fax string nullable
• email string nullable
• website string nullable
• listing_venue string nullable
• ipo_shares number nullable
• ipo_price number nullable
• ipo_proceeds number nullable
• ipo_pe number nullable
• ipo_lottery_rate number nullable
• established_date integer nullable
• listed_date integer nullable

Errors

• 422 — The request body did not validate 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 — Xueqiu has no company profile under that symbol 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.