Equity Cash Flow

GET/gateway/v1/equity/cash-flow

Returns paginated standardized cash-flow periods for a US-listed equity. The response preserves serving-layer values, status, origin, and period metadata.

Query Parameters

symbolstringrequired

US equity ticker symbol

Example: AAPL

periodenum<string>

Financial period

Available options:quarterlyytdannualttm

end_datestring

Inclusive latest period end date in YYYY-MM-DD format

Example: 2024-12-31

limitinteger

Maximum financial periods to return

Equity Cash Flow

const options = {method: 'GET'};

fetch('https://api.asksurf.ai/gateway/v1/equity/cash-flow?symbol=AAPL&end_date=2024-12-31', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "$schema": "https://example.com/schemas/DataResponseEquityCashFlowItem.json",
  "data": [
    {
      "beginning_cash": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "business_acquisitions_and_disposals": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "calculated_at": 123,
      "capital_expenditure": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "change_in_cash": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "currency": "<string>",
      "debt_issuance_repayment": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "depreciation_and_amortization": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "dividends_and_distributions": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "ending_cash": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "equity_issuance_purchase": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "financing_cash_flow": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "fiscal_period": "<string>",
      "fiscal_quarter": 123,
      "fiscal_year": 123,
      "formula_version": "<string>",
      "free_cash_flow": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "fx_effect": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "investing_cash_flow": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "investment_acquisitions_and_disposals": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "net_income": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "operating_cash_flow": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "period": "<string>",
      "report_period": "<string>",
      "share_based_compensation": {
        "quality_reason_codes": [],
        "reason_code": "<string>",
        "source_accessions": [],
        "source_financial_metric_snapshot_ids": [],
        "source_revision_ids": [],
        "source_statement_ids": [],
        "status": "<string>",
        "value": 123,
        "value_origin": "<string>"
      },
      "source_updated_at": 123,
      "symbol": "<string>"
    }
  ],
  "meta": {
    "cached": true,
    "credits_used": 123,
    "empty_reason": "<string>",
    "has_more": true,
    "limit": 123,
    "offset": 123,
    "total": 123,
    "watermark": 123
  }
}