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

Field	Type	Nullable	Description
`id`	`string`	No	Instrument identifier: re-feed into /v1/finance/quote ("GOOGL:NASDAQ" \| ".INX:INDEXSP" \| "EUR-USD")
`ticker`	`string`	Yes	Ticker symbol (null for forex/crypto asset pairs)
`exchange`	`string`	Yes	Primary exchange / market identifier
`name`	`string`	Yes	Display name (e.g. 'Alphabet Inc Class A')
`type`	`string`	No	Instrument class: stock \| etf \| index \| crypto \| forex \| futures \| fund \| unknown
`url`	`string`	Yes
`currency`	`string`	Yes	Price currency (null for asset pairs)
`pair.base_symbol`	`string`	Yes
`pair.quote_symbol`	`string`	Yes
`pair.base_display_name`	`string`	Yes
`pair.quote_display_name`	`string`	Yes
`price.current`	`number`	Yes
`price.previous_close`	`number`	Yes
`price.delta`	`number`	Yes
`price.percentage_delta`	`number`	Yes
`price.trend`	`string`	Yes
`price.day_low`	`number`	Yes
`price.day_high`	`number`	Yes
`price.year_low`	`number`	Yes
`price.year_high`	`number`	Yes
`price.timestamp`	`string`	Yes
`metrics.market_cap`	`number`	Yes
`metrics.volume`	`number`	Yes
`metrics.avg_volume`	`number`	Yes
`metrics.pe_ratio`	`number`	Yes
`metrics.dividend_yield`	`number`	Yes
`metrics.ytd_return`	`number`	Yes
`metrics.expense_ratio`	`number`	Yes
`metrics.net_assets`	`number`	Yes
`metrics.yield`	`number`	Yes
`metrics.open_interest`	`number`	Yes
`metrics.category`	`string`	Yes
`metrics.metrics_currency`	`string`	Yes
`about.description`	`string`	Yes
`about.description_source_url`	`string`	Yes
`about.ceo`	`string`	Yes
`about.founded`	`string`	Yes
`about.headquarters`	`string`	Yes
`about.website`	`string`	Yes
`about.employees`	`number`	Yes
`graph`	`object[]`	Yes	Intraday price series ({ timestamp, value, volume })
`financials.quarterly`	`object[]`	Yes
`financials.annual`	`object[]`	Yes
`peers`	`object[]`	Yes	Related instruments (compare_to)

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.

Platform	`ticker`	`exchange`	`name`	`url`	`currency`	`pair.base_symbol`	`pair.quote_symbol`	`pair.base_display_name`	`pair.quote_display_name`	`price.current`	`price.previous_close`	`price.delta`
Finance	yes		yes	yes	yes

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.