/twse/brokers

POST /api/twse/brokers

Price: 10 credits

Securities brokers of the Taiwan Stock Exchange: code and name, capital, founding and opening dates, management, business types and licensed business lines, settlement bank and accounts, office addresses, staff headcount, and every branch with its address, phone and staff headcount

How to use it

Names and addresses are in Chinese. A branch is listed under the head office whose short name matches the brand before the dash in the branch name.

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 brokers to return (min: 1; max: 1000)
• query string nullable — Text matched against the broker code and name (examples: "元大", "9800")

Response

• @type string (default: "TwseBroker")
• broker_code string required
• name string nullable
• tax_id string nullable
• registered_capital_thousand_twd integer nullable
• paid_in_capital_thousand_twd integer nullable
• allocated_operating_funds_thousand_twd integer nullable
• founded_date integer nullable
• opened_date integer nullable
• margin_trading_start_date integer nullable
• changed_date integer nullable
• region string nullable
• phone string nullable
• fax string nullable
• chairman string nullable
• president string nullable
• public_status string nullable
• business_types string nullable
• business_lines array (default: [])
• settlement_bank string nullable
• settlement_account string nullable
• default_account string nullable
• error_account string nullable
• warrant_exercise_account string nullable
• settlement_agents string nullable
• guarantee_custodian_bank string nullable
• administrative_address string nullable
• brokerage_address string nullable
• brokerage_main_address string nullable
• trading_hall_address string nullable
• proprietary_address string nullable
• proprietary_main_address string nullable
• underwriting_address string nullable
• underwriting_main_address string nullable
• stock_affairs_agent_address string nullable
• note string nullable
• male_staff integer nullable
• female_staff integer nullable
• total_staff integer nullable
• branches array (default: [])
  • @type string (default: "TwseBrokerBranch")
  • branch_code string required
  • name string nullable
  • opened_date integer nullable
  • address string nullable
  • phone string nullable
  • male_staff integer nullable
  • female_staff integer nullable
  • total_staff integer nullable

Errors

• 422 — query is blank 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.