/twse/market/surveillance

POST /api/twse/market/surveillance

Price: 1 credit

Current Taiwan Stock Exchange surveillance lists: securities flagged for unusual trading, under disposition measures or close to them, halted, suspended from margin or day trading, moved to periodic call auction, or promoted abnormally on investment TV programmes

How to use it

Each list is the exchange's latest publication; a quiet day returns an empty list. 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 entries to return (min: 1; max: 1000)
• list string required — Which surveillance list to return (one of: "attention", "disposition", "near_disposition", "trading_halts", "margin_suspensions", "day_trading_suspensions_upcoming", "day_trading_suspensions_recent", "trading_method_changes", "tv_promoted")

Response

• @type string (default: "TwseSurveillanceEntry")
• list_name string required
• security_code string required
• security_name string nullable
• date integer nullable
• start_date integer nullable
• end_date integer nullable
• period string nullable
• halted_at integer nullable
• resumed_at integer nullable
• reason string nullable
• measure string nullable
• announcement_count integer nullable
• criteria string nullable
• detail string nullable
• related_information string nullable
• closing_price number nullable
• pe_ratio number nullable
• is_periodic_call_auction boolean nullable

Errors

• 422 — list is not one of the listed values 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.