ASasksurf
Equity

Equity Segment Financials

Changed on

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.

get/gateway/v1/equity/segments

Request

  • Base URL
    https://api.asksurf.ai
  • Auth
    HTTP bearer

Query parameters

symbolstring required

US equity ticker symbol

Example:AAPL
period'quarterly' | 'annual'

Financial period

statement_type'income' | 'balance_sheet' | 'cash_flow'

Optional statement family

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

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

Example response

{
  "$schema": "https://example.com/schemas/DataResponseEquitySegmentFinancial.json"
}

Changes

  • 4a9654317fc5Revision changes
    • breaking

      removed the enum value product from the query request parameter dimension_type

    • breaking

      removed the enum value segment from the query request parameter dimension_type

    • breaking

      added the pattern ^[a-z][a-z0-9_]*$ to the query request parameter dimension_type

  • 0034a432f8beRevision changes
    • info

      endpoint added