/twse/warrants

POST /api/twse/warrants

Price: 105 credits

Warrants listed on the Taiwan Stock Exchange: code and name, call or put, underlying, exercise period and last trading day, units issued, exercise ratio, original and current strike, cap and floor

How to use it

Filter by `underlying` with the exchange's Chinese short name, such as the `short_name` of twse/companies/search; without it the first `count` warrants of the register are returned, so narrow the call with `underlying` or `warrant_type`.

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 warrants to return (min: 1; max: 5000)
• underlying string nullable — Short name of the underlying security or index (examples: "台積電")
• warrant_type string nullable — Call or put warrants only (one of: "call", "put")

Response

• @type string (default: "TwseWarrant")
• warrant_code string required
• name string nullable
• warrant_type string nullable
• category string nullable
• underlying string nullable
• market_maker_quote_method string nullable
• exercise_start_date integer nullable
• last_trading_date integer nullable
• expiry_date integer nullable
• issued_thousand_units integer nullable
• settlement_method_code string nullable
• exercise_ratio_per_thousand_units number nullable
• original_strike number nullable
• original_cap number nullable
• original_floor number nullable
• strike number nullable
• cap number nullable
• floor number nullable
• note string nullable

Errors

• 422 — underlying is blank or warrant_type is not call or put 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.