Equity Financial Overview

GET/gateway/v1/equity/overview

Returns a paginated financial overview for a US-listed equity. Values are served as reported or derived by the financial-data serving layer; missing values remain explicit nulls and are not recalculated by this API.

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 Financial Overview

const options = {method: 'GET'};

fetch('https://api.asksurf.ai/gateway/v1/equity/overview?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/DataResponseEquityOverviewItem.json",
  "data": [
    {
      "calculated_at": 123,
      "cash_and_equivalents": {
        "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>"
      },
      "company_name": "<string>",
      "currency": "<string>",
      "current_ratio": {
        "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>"
      },
      "debt_to_equity": {
        "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>"
      },
      "duration_months": 123,
      "ebit": {
        "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>"
      },
      "ebit_margin": {
        "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>"
      },
      "ebitda": {
        "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>"
      },
      "ebitda_margin": {
        "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>"
      },
      "eps_basic": {
        "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>"
      },
      "eps_diluted": {
        "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>"
      },
      "exchange": "<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>"
      },
      "gross_margin": {
        "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>"
      },
      "gross_profit": {
        "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>"
      },
      "industry": "<string>",
      "liabilities_to_assets": {
        "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_debt": {
        "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>"
      },
      "net_margin": {
        "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>"
      },
      "operating_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_margin": {
        "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>"
      },
      "pb_mrq": {
        "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>"
      },
      "pe_lyr": {
        "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>"
      },
      "pe_ttm": {
        "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>",
      "period_start": "<string>",
      "ps_ttm": {
        "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>"
      },
      "report_period": "<string>",
      "return_on_assets": {
        "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>"
      },
      "return_on_equity": {
        "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>"
      },
      "return_on_invested_capital": {
        "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>"
      },
      "revenue": {
        "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>"
      },
      "revenue_yoy": {
        "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>"
      },
      "sector": "<string>",
      "shareholders_equity": {
        "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>",
      "total_assets": {
        "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>"
      },
      "total_debt": {
        "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>"
      },
      "total_liabilities": {
        "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>"
      }
    }
  ],
  "meta": {
    "cached": true,
    "credits_used": 123,
    "empty_reason": "<string>",
    "has_more": true,
    "limit": 123,
    "offset": 123,
    "total": 123,
    "watermark": 123
  }
}