SocialCrawl
Unified schema

Quote schema

The unified SocialCrawl financial quote schema. Every field, its type, per-platform availability, and a machine-readable JSON Schema, generated from the canonical Zod source.

Every SocialCrawl endpoint that returns a financial quote gives you this exact shape, whatever the source platform. Write your parser once and the same code reads quote data from every platform below. That is the unified schema: one contract instead of a dozen raw upstream formats.

Field reference

FieldTypeNullableDescription
idstringNoInstrument identifier: re-feed into /v1/finance/quote ("GOOGL:NASDAQ" | ".INX:INDEXSP" | "EUR-USD")
tickerstringYesTicker symbol (null for forex/crypto asset pairs)
exchangestringYesPrimary exchange / market identifier
namestringYesDisplay name (e.g. 'Alphabet Inc Class A')
typestringNoInstrument class: stock | etf | index | crypto | forex | futures | fund | unknown
urlstringYesURL of the quote page on the source.
currencystringYesPrice currency (null for asset pairs)
pair.base_symbolstringYesSymbol of the base currency, for example EUR or BTC.
pair.quote_symbolstringYesSymbol of the quote currency, for example USD.
pair.base_display_namestringYesName of the base currency, for example Euro.
pair.quote_display_namestringYesName of the quote currency, for example United States Dollar.
price.currentnumberYesLatest price, or the index level for an index, in the quote currency.
price.previous_closenumberYesClosing price of the previous trading session.
price.deltanumberYesAbsolute change from the previous close, in the quote currency.
price.percentage_deltanumberYesChange from the previous close as a percentage (1.5 means 1.5%).
price.trendstringYesDirection of the change from the previous close: up, down or stable.
price.day_lownumberYesLowest price of the current trading day.
price.day_highnumberYesHighest price of the current trading day.
price.year_lownumberYesLowest price of the last 52 weeks.
price.year_highnumberYesHighest price of the last 52 weeks.
price.timestampstringYesWhen the price was quoted, as a UTC timestamp string.
metrics.market_capnumberYesMarket capitalisation, in the currency given by metrics_currency.
metrics.volumenumberYesUnits traded in the current session.
metrics.avg_volumenumberYesAverage units traded per session.
metrics.pe_rationumberYesPrice to earnings ratio.
metrics.dividend_yieldnumberYesDividend yield as a percentage, as the source publishes it (0.44 means 0.44%).
metrics.ytd_returnnumberYesReturn since the start of the calendar year, as a percentage. Funds only.
metrics.expense_rationumberYesAnnual fund fee as a percentage of assets. ETFs and funds only.
metrics.net_assetsnumberYesTotal assets under management, in the currency given by metrics_currency. ETFs and funds only.
metrics.yieldnumberYesDistribution yield as a percentage. Funds only.
metrics.open_interestnumberYesNumber of outstanding contracts that have not been settled. Futures only.
metrics.categorystringYesThe fund category, for example a sector or asset class. ETFs and funds only.
metrics.metrics_currencystringYesCurrency that market_cap and net_assets are expressed in.
about.descriptionstringYesCompany description.
about.description_source_urlstringYesWhere the description was taken from.
about.ceostringYesName of the chief executive.
about.foundedstringYesWhen the company was founded, as the source prints it.
about.headquartersstringYesHeadquarters location as text.
about.websitestringYesCompany website.
about.employeesnumberYesNumber of employees.
graphobject[]YesIntraday price series ({ timestamp, value, volume })
financials.quarterlyobject[]YesQuarterly results, newest first.
financials.annualobject[]YesAnnual results, newest first.
peersobject[]YesRelated instruments (compare_to)

Extension fields (ext)

Platform-specific passthrough. Each field is present only on the platforms that expose it and is absent everywhere else, so treat every ext.* field as optional. These carry the richer, per-platform signals the unified leaves cannot hold, and the join keys that chain endpoints together.

FieldTypeNullableDescription
ext.sectionstringNoThe markets-page section the quote came from, such as most_active.

Platform availability

1 platform returns the Quote shape. id, type are never null on any platform. The fields below vary: yes means the platform populates it (the value may still be null); a blank means the platform never provides it, so it is always null.

Platformtickerexchangenameurlcurrencypair.base_symbolpair.quote_symbolpair.base_display_namepair.quote_display_nameprice.currentprice.previous_closeprice.delta
Financeyesyesyesyes

Machine-readable schema

Validate responses programmatically against the JSON Schema (2020-12):

/schemas/quote.json

Point a validator (Ajv, jsonschema, or your framework's) at that URL, or hand it to an agent so it can check the shape without a live call.

Returned by

Endpoints with the Quote / QuoteList archetype return this shape:

Finance

See how the same fields map to each platform's raw upstream names in the cross-platform field equivalence table.

On this page