/investing/quotes/financials

POST /api/investing/quotes/financials

Price: 1 credit

Get income statement, balance sheet, cash flow, or ratios for an equity

How to use it

Get financial statements for an equity: income statement, balance sheet, cash flow (each with up to 10 annual or 10 quarterly periods of line-item indicators), or financial ratios (current TTM/MRQ values with industry comparison). Identify the company by ticker, name, path, or URL.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• quote string required — Equity to look up: a ticker symbol or name ('AAPL'), a section path, or an instrument URL. (examples: "AAPL", "/equities/microsoft-corp"; minLength: 1)
• statement string — Financial statement to return (default: "income-statement"; one of: "income-statement", "balance-sheet", "cash-flow", "ratios")
• period string — Reporting period (ignored for ratios) (default: "annual"; one of: "annual", "quarterly")

Response

• @type string (default: "InvestingFinancials")
• statement string required
• period string nullable
• company_name string nullable
• currency_id integer nullable
• reports array (default: [])
  • @type string (default: "InvestingFinancialReport")
  • year integer nullable
  • period_end_date string nullable
  • filing_date string nullable
  • calendar_quarter integer nullable
  • currency_id integer nullable
  • indicators array (default: [])
    • @type string (default: "InvestingFinancialIndicator")
    • key string required
    • name string nullable
    • value number nullable
    • industry_value number nullable
• ratios array (default: [])
  • @type string (default: "InvestingFinancialIndicator")
  • key string required
  • name string nullable
  • value number nullable
  • industry_value 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 — Company or financial data not found 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.