/twse/market/investors

POST /api/twse/market/investors

Price: 20 credits

Shares bought and sold per security on one Taiwan Stock Exchange trading day by foreign investors, foreign dealers, investment trusts and domestic dealers (proprietary and hedging), with each net figure and the institutional total

How to use it

History starts on 2012-05-02. With industry_code set, include_warrants has no effect.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• date integer nullable — Trading day, as unix seconds; the latest trading day when omitted (examples: 1790812800)
• count integer required — Max number of securities to return (min: 1; max: 20000)
• include_warrants boolean — Include warrants and callable bull/bear contracts (default: false)
• industry_code string nullable — Two-digit industry code of the exchange (examples: "01", "24")

Response

• @type string (default: "TwseInvestorFlow")
• security_code string required
• date integer required
• foreign_buy_shares integer nullable
• foreign_sell_shares integer nullable
• foreign_net_shares integer nullable
• foreign_dealer_buy_shares integer nullable
• foreign_dealer_sell_shares integer nullable
• foreign_dealer_net_shares integer nullable
• investment_trust_buy_shares integer nullable
• investment_trust_sell_shares integer nullable
• investment_trust_net_shares integer nullable
• dealer_net_shares integer nullable
• dealer_proprietary_buy_shares integer nullable
• dealer_proprietary_sell_shares integer nullable
• dealer_proprietary_net_shares integer nullable
• dealer_hedging_buy_shares integer nullable
• dealer_hedging_sell_shares integer nullable
• dealer_hedging_net_shares integer nullable
• institutional_net_shares integer nullable

Errors

• 422 — industry_code is not two digits 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.