/twse/companies/financials

POST /api/twse/companies/financials

Price: 1 credit

Get one quarterly financial statement of a Taiwan listed or OTC company — income statement, balance sheet or cash-flow statement — with every line item, its level in the hierarchy and its amount and share of the total for each reported period, plus links to the XBRL and e-book filings

How to use it

Amounts are in thousands of TWD except per-share lines, which are in TWD; line-item names are in Chinese as filed. Statements start in 2013; a quarter not yet filed returns an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Stock code of the company (examples: "2330", "2882")
• statement string required — Which financial statement to return (one of: "income", "balance_sheet", "cash_flow")
• year integer nullable — Fiscal year; the latest filed statement when omitted (examples: 2025)
• quarter integer nullable — Fiscal quarter, 1-4; required with year (min: 1; max: 4)

Response

• @type string (default: "TwseFinancialStatement")
• company_code string required
• statement string required
• year integer required
• quarter integer required
• company_name string nullable
• report_type string nullable
• periods array (default: [])
• line_items array (default: [])
  • @type string (default: "TwseStatementItem")
  • name string required
  • level integer required
  • values array (default: [])
    • @type string (default: "TwseStatementValue")
    • period string required
    • amount number nullable
    • percent number nullable
• xbrl_url string nullable
• ebook_url string nullable

Errors

• 422 — company is not a 4-6 character stock code, year is before 2013, or year comes without quarter 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 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.