← Araçlar

get_financials

Financial statements (normalised) · salt-okunur

Income statement, balance sheet and cash flow in one normalised schema (revenue,
    gross_profit, operating_profit, ebitda, net_income, total_assets, cash, financial_debt,
    equity, operating/investing/financing cash flow …) with the source line/taxonomy name per
    field and the reporting currency. Two sources: `ticker` → Yahoo Finance time series
    (several periods); `disclosure_id` → the official KAP filing (`source: kap`, exact
    figures, labels '(3M)' quarter vs '(YTD)' cumulative). Find FR ids with
    search_disclosures(tickers=[…], disclosure_type='FR').

Parametreler

Girdi şeması

{
  "properties": {
    "ticker": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "BIST ticker, e.g. THYAO — time series from Yahoo Finance",
      "title": "Ticker"
    },
    "disclosure_id": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A KAP financial-report (FR) disclosure id — the official filing parsed from KAP's XBRL data (current period + prior-year comparatives)",
      "title": "Disclosure Id"
    },
    "frequency": {
      "default": "quarterly",
      "description": "Yahoo series only",
      "enum": [
        "annual",
        "quarterly"
      ],
      "title": "Frequency",
      "type": "string"
    },
    "periods": {
      "default": 8,
      "maximum": 40,
      "minimum": 1,
      "title": "Periods",
      "type": "integer"
    },
    "fields": {
      "anyOf": [
        {
          "items": {
            "enum": [
              "revenue",
              "cost_of_revenue",
              "gross_profit",
              "operating_profit",
              "ebitda",
              "depreciation",
              "interest_expense",
              "pretax_income",
              "tax_expense",
              "net_income",
              "eps_diluted",
              "total_assets",
              "current_assets",
              "cash",
              "inventory",
              "receivables",
              "total_liabilities",
              "current_liabilities",
              "financial_debt",
              "net_debt",
              "equity",
              "shares_outstanding",
              "operating_cash_flow",
              "investing_cash_flow",
              "financing_cash_flow",
              "capex",
              "free_cash_flow",
              "dividends_paid"
            ],
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Subset of normalised fields; default all (see get_reference_codes.financial_fields)",
      "title": "Fields"
    }
  },
  "title": "get_financialsArguments",
  "type": "object"
}

Çıktı şeması

{
  "additionalProperties": true,
  "title": "get_financialsDictOutput",
  "type": "object"
}