Equity Segment Financials

GET/gateway/v1/equity/segments

Returns provider-reported product and operating/geographic segment facts for a US-listed equity. Provider labels and missing-value status are preserved; segment values are not added across incompatible dimensions.

Query Parameters

symbolstringrequired

US equity ticker symbol

Example: AAPL

periodenum<string>

Financial period

Available options:quarterlyannual

statement_typeenum<string>

Optional statement family

Available options:incomebalance_sheetcash_flow

metric_codestring

Optional normalized metric code

dimension_typestring

Optional provider dimension key

labelstring

Optional provider segment label

start_datestring

Inclusive period start

end_datestring

Inclusive period end

limitinteger

Maximum facts to return

offsetinteger

Number of facts to skip

Equity Segment Financials

const options = {method: 'GET'};

fetch('https://api.asksurf.ai/gateway/v1/equity/segments?symbol=AAPL', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "$schema": "https://example.com/schemas/DataResponseEquitySegmentFinancial.json",
  "data": [
    {
      "calculated_at": 123,
      "currency": "<string>",
      "dimension_type": "<string>",
      "fiscal_quarter": 123,
      "fiscal_year": 123,
      "label": "<string>",
      "label_key": "<string>",
      "materialized_at": 123,
      "metric_code": "<string>",
      "period": "<string>",
      "presentation_period": "<string>",
      "reason_code": "<string>",
      "report_period": "<string>",
      "source_accessions": [],
      "source_observed_at": 123,
      "source_provider_tickers": [],
      "statement_type": "<string>",
      "status": "<string>",
      "symbol": "<string>",
      "unit": "<string>",
      "value": 123
    }
  ],
  "meta": {
    "cached": true,
    "credits_used": 123,
    "empty_reason": "<string>",
    "has_more": true,
    "limit": 123,
    "offset": 123,
    "total": 123,
    "watermark": 123
  }
}