/twse/announcements

POST /api/twse/announcements

Price: 1 credit

Get one material-information announcement of a Taiwan listed or OTC company: subject, full text, the disclosure rule clause it was filed under, event date, publication time and the spokesperson

How to use it

Takes an `id` from twse/companies/announcements or twse/announcements/latest. 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)
• announcement string required — Announcement id from a TWSE announcement list (examples: "2330-sii-1150102-1")

Response

• @type string (default: "TwseAnnouncement")
• id string required
• company_code string required
• serial_number integer required
• company_name string nullable
• market string nullable
• published_at integer nullable
• subject string nullable
• rule_clause string nullable
• event_date integer nullable
• body string nullable
• spokesperson string nullable
• spokesperson_title string nullable
• spokesperson_phone string nullable

Errors

• 422 — announcement is not an id of the form 2330-sii-1150102-1 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 announcement under that id 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.