/xueqiu/quotes/financials

POST /api/xueqiu/quotes/financials

Price: 10 credits

Get the income statement, balance sheet, cash flow statement or key financial indicators of a Shanghai, Shenzhen, Beijing, Hong Kong or US listed company from Xueqiu, one row per reported period with every line item's value and its year-on-year change

How to use it

Line-item names are Xueqiu's own keys and differ between mainland, Hong Kong and US filers. change_yoy is a fraction, so 0.12 means up 12% on the same period a year earlier.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• symbol string required — Xueqiu security symbol or quote page URL (examples: "SH600519", "00700", "AAPL", "https://xueqiu.com/S/SZ000001")
• count integer required — Max number of report periods to return, newest first (min: 1; max: 100)
• statement string — Financial statement (default: "income"; one of: "income", "balance", "cash_flow", "indicator")
• period string — Every reported period, or annual reports only (default: "all"; one of: "all", "annual")

Response

• @type string (default: "XueqiuFinancialReport")
• symbol string required
• statement string required
• company_name string nullable
• report_name string nullable
• report_date integer nullable
• period_start_date integer nullable
• period_end_date integer nullable
• fiscal_year integer nullable
• months_count integer nullable
• report_type_code string nullable
• currency string nullable
• published_at integer nullable
• metrics array (default: [])
  • @type string (default: "XueqiuFinancialMetric")
  • name string required
  • value number nullable
  • change_yoy number nullable

Errors

• 422 — The request body did not validate 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 — Xueqiu has no financial statements under that symbol 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.