/tianyancha/companies

POST /api/tianyancha/companies

Price: 20 credits

Get a Chinese company's registry profile by Tianyancha id (gid)

How to use it

Get full registry details for a Chinese company by its Tianyancha id (gid).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• gid string required — Tianyancha company id (gid) or company page URL (examples: "59837300")

Response

• @type string (default: "TianyanchaCompany")
• gid string required
• unified_social_credit_code string nullable
• name string required
• name_en string nullable
• alias string nullable
• status string nullable
• company_type string nullable
• org_number string nullable
• registration_number string nullable
• legal_representative string nullable
• established_at string nullable
• approved_at string nullable
• industry string nullable
• reg_capital string nullable
• actual_capital string nullable
• reg_institute string nullable
• address string nullable
• area string nullable
• business_scope string nullable
• staff_count integer nullable
• staff_count_range string nullable
• emails array
• phones array
• websites array
• tags array
• previous_names array
  • @type string (default: "TianyanchaPreviousName")
  • name string required
  • start_date string nullable
  • end_date string nullable
• image string 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 — Company gid not found in the Tianyancha registry 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.