/twse/companies/dividends

POST /api/twse/companies/dividends

Price: 5 credits

Dividend decisions of a Taiwan listed or OTC company: period, board and shareholders-meeting dates, earnings available for distribution, cash and stock dividends per share by source, totals paid, and the articles-of-incorporation clause

How to use it

Without a window it returns the latest decisions; pass date_from/date_to for earlier years. Common-share decisions come first, newest first, then preferred-share ones; text is in Chinese.

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 dividend decisions to return (min: 1; max: 500)
• company string required — Stock code of the company (examples: "2330", "2882")
• date_from integer nullable — Earliest dividend year, as unix seconds; year-granular (examples: 1577836800)
• date_to integer nullable — Latest dividend year, as unix seconds; year-granular (examples: 1767225600)

Response

• @type string (default: "TwseDividend")
• company_code string required
• share_class string required
• preferred_share string nullable
• status string nullable
• period string nullable
• period_start integer nullable
• period_end integer nullable
• term integer nullable
• board_resolution_date integer nullable
• shareholders_meeting_date integer nullable
• retained_earnings_start_twd number nullable
• net_income_twd number nullable
• distributable_earnings_twd number nullable
• retained_earnings_end_twd number nullable
• cash_dividend_per_share_twd number nullable
• cash_from_legal_reserve_per_share_twd number nullable
• cash_from_capital_reserve_per_share_twd number nullable
• total_cash_dividend_twd number nullable
• stock_dividend_per_share_twd number nullable
• stock_from_legal_reserve_per_share_twd number nullable
• stock_from_capital_reserve_per_share_twd number nullable
• total_stock_dividend_shares integer nullable
• articles_clause string nullable
• articles_url string nullable
• note string nullable
• par_value string nullable

Errors

• 422 — company is not a 4-6 character stock code, or date_to is before date_from 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.