/twse/companies/monthly-revenue

POST /api/twse/companies/monthly-revenue

Price: 1 credit

Monthly revenue history of a Taiwan listed or OTC company: revenue for the month and the same month a year earlier, the change, year-to-date totals against last year, and the company's note on the change

How to use it

Newest month first; history starts in 2013 or at listing. Amounts are in thousands of TWD.

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 months to return (min: 1; max: 150)
• company string required — Stock code of the company (examples: "2330", "6488")
• date_from integer nullable — Earliest month, as unix seconds; month-granular (examples: 1735689600)
• date_to integer nullable — Latest month, as unix seconds; month-granular (examples: 1788220800)

Response

• @type string (default: "TwseMonthlyRevenue")
• month integer required
• company_code string required
• revenue_thousand_twd integer nullable
• revenue_last_year_thousand_twd integer nullable
• change_thousand_twd integer nullable
• change_percent number nullable
• year_to_date_thousand_twd integer nullable
• year_to_date_last_year_thousand_twd integer nullable
• year_to_date_change_thousand_twd integer nullable
• year_to_date_change_percent number nullable
• note string nullable

Errors

• 422 — company is not a 4-6 character stock code, or date_to is before date_from 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 company under that stock code 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.