/twse/companies/search

POST /api/twse/companies/search

Price: 20 credits

Search the Taiwan Stock Exchange company directory — listed companies and public companies not listed on it: names in Chinese and English, industry code, chairman, president, spokesperson, contacts, addresses, founding and listing dates, capital, shares issued, transfer agent and auditors

How to use it

Listed companies come first, in code order. Pass `company_code` to twse/companies for the full profile or to the per-company endpoints.

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: 2000)
• query string nullable — Text matched against the code and the Chinese and English names (examples: "台積", "TSMC")
• market string nullable — Listed on the exchange, or a public company not listed on it (one of: "listed", "public")
• industry_code string nullable — Two-character industry code of the exchange (examples: "24", "17")

Response

• @type string (default: "TwseDirectoryCompany")
• company_code string required
• market string required
• name string nullable
• short_name string nullable
• short_name_en string nullable
• industry_code string nullable
• tax_id string nullable
• foreign_registration_country string nullable
• chairman string nullable
• president string nullable
• spokesperson string nullable
• spokesperson_title string nullable
• deputy_spokesperson string nullable
• phone string nullable
• fax string nullable
• email string nullable
• website string nullable
• address string nullable
• address_en string nullable
• founded_date integer nullable
• listed_date integer nullable
• par_value string nullable
• paid_in_capital_twd integer nullable
• common_shares_issued integer nullable
• private_placement_shares integer nullable
• preferred_shares integer nullable
• financial_statement_type string nullable
• transfer_agent string nullable
• transfer_agent_phone string nullable
• transfer_agent_address string nullable
• audit_firm string nullable
• auditors array (default: [])

Errors

• 422 — query or industry_code is blank 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.