Docs
View as Markdown

finance.statements

stable 2 credits

Annual income statement, balance sheet and cash flow lines for a listed company (one row per metric).

GET /v1/finance/statements

What you get#

A list of Finance results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • 2 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
symbolstringyes(required)Company ticker, e.g. AAPLmax 15 chars; must match [A-Z0-9.^=-]{1,15}; trimmed, upper

Request#

curl "https://api.onekey.dev/v1/finance/statements?symbol=AAPL" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Finance response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "market": {
        "symbol": "AAPL"
      },
      "ext": {
        "metric": "annualTotalAssets",
        "totalRevenue": null,
        "grossProfit": null,
        "operatingIncome": null,
        "netIncome": null,
        "basicEps": null,
        "totalAssets": [
          {
            "dataId": 23220,
            "asOfDate": "2024-09-30",
            "periodType": "12M",
            "currencyCode": "USD",
            "reportedValue": {
              "raw": 364980000000,
              "fmt": "364.98B"
            }
          },
          {
            "dataId": 23220,
            "asOfDate": "2025-09-30",
            "periodType": "12M",
            "currencyCode": "USD",
            "reportedValue": {
              "raw": 359241000000,
              "fmt": "359.24B"
            }
          }
        ],
        "totalLiabilities": null,
        "stockholdersEquity": null,
        "operatingCashFlow": null,
        "capitalExpenditure": null,
        "freeCashFlow": null,
        "cashAndEquivalents": null
      }
    },
    {
      "market": {
        "symbol": "AAPL"
      },
      "ext": {
        "metric": "annualCapitalExpenditure",
        "totalRevenue": null,
        "grossProfit": null,
        "operatingIncome": null,
        "netIncome": null,
        "basicEps": null,
        "totalAssets": null,
        "totalLiabilities": null,
        "stockholdersEquity": null,
        "operatingCashFlow": null,
        "capitalExpenditure": [
          {
            "dataId": 26005,
            "asOfDate": "2024-09-30",
            "periodType": "12M",
            "currencyCode": "USD",
            "reportedValue": {
              "raw": -9447000000,
              "fmt": "-9.45B"
            }
          },
          {
            "dataId": 26005,
            "asOfDate": "2025-09-30",
            "periodType": "12M",
            "currencyCode": "USD",
            "reportedValue": {
              "raw": -12715000000,
              "fmt": "-12.71B"
            }
          }
        ],
        "freeCashFlow": null,
        "cashAndEquivalents": null
      }
    }
  ],
  "metadata": {
    "platform": "finance",
    "endpoint": "statements",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
meta.symbol.0market.symbol-
meta.type.0ext.metric-
annualTotalRevenueext.totalRevenue-
annualGrossProfitext.grossProfit-
annualOperatingIncomeext.operatingIncome-
annualNetIncomeext.netIncome-
annualBasicEPSext.basicEps-
annualTotalAssetsext.totalAssets-
annualTotalLiabilitiesNetMinorityInterestext.totalLiabilities-
annualStockholdersEquityext.stockholdersEquity-
annualOperatingCashFlowext.operatingCashFlow-
annualCapitalExpenditureext.capitalExpenditure-
annualFreeCashFlowext.freeCashFlow-
annualCashAndCashEquivalentsext.cashAndEquivalents-

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).