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 | URL of the quote page on the source. |
currency | string | Yes | Price currency (null for asset pairs) |
pair.base_symbol | string | Yes | Symbol of the base currency, for example EUR or BTC. |
pair.quote_symbol | string | Yes | Symbol of the quote currency, for example USD. |
pair.base_display_name | string | Yes | Name of the base currency, for example Euro. |
pair.quote_display_name | string | Yes | Name of the quote currency, for example United States Dollar. |
price.current | number | Yes | Latest price, or the index level for an index, in the quote currency. |
price.previous_close | number | Yes | Closing price of the previous trading session. |
price.delta | number | Yes | Absolute change from the previous close, in the quote currency. |
price.percentage_delta | number | Yes | Change from the previous close as a percentage (1.5 means 1.5%). |
price.trend | string | Yes | Direction of the change from the previous close: up, down or stable. |
price.day_low | number | Yes | Lowest price of the current trading day. |
price.day_high | number | Yes | Highest price of the current trading day. |
price.year_low | number | Yes | Lowest price of the last 52 weeks. |
price.year_high | number | Yes | Highest price of the last 52 weeks. |
price.timestamp | string | Yes | When the price was quoted, as a UTC timestamp string. |
metrics.market_cap | number | Yes | Market capitalisation, in the currency given by metrics_currency. |
metrics.volume | number | Yes | Units traded in the current session. |
metrics.avg_volume | number | Yes | Average units traded per session. |
metrics.pe_ratio | number | Yes | Price to earnings ratio. |
metrics.dividend_yield | number | Yes | Dividend yield as a percentage, as the source publishes it (0.44 means 0.44%). |
metrics.ytd_return | number | Yes | Return since the start of the calendar year, as a percentage. Funds only. |
metrics.expense_ratio | number | Yes | Annual fund fee as a percentage of assets. ETFs and funds only. |
metrics.net_assets | number | Yes | Total assets under management, in the currency given by metrics_currency. ETFs and funds only. |
metrics.yield | number | Yes | Distribution yield as a percentage. Funds only. |
metrics.open_interest | number | Yes | Number of outstanding contracts that have not been settled. Futures only. |
metrics.category | string | Yes | The fund category, for example a sector or asset class. ETFs and funds only. |
metrics.metrics_currency | string | Yes | Currency that market_cap and net_assets are expressed in. |
about.description | string | Yes | Company description. |
about.description_source_url | string | Yes | Where the description was taken from. |
about.ceo | string | Yes | Name of the chief executive. |
about.founded | string | Yes | When the company was founded, as the source prints it. |
about.headquarters | string | Yes | Headquarters location as text. |
about.website | string | Yes | Company website. |
about.employees | number | Yes | Number of employees. |
graph | object[] | Yes | Intraday price series ({ timestamp, value, volume }) |
financials.quarterly | object[] | Yes | Quarterly results, newest first. |
financials.annual | object[] | Yes | Annual results, newest first. |
peers | object[] | Yes | Related 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.
| Field | Type | Nullable | Description |
|---|---|---|---|
ext.section | string | No | The 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.
| 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):
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:
See how the same fields map to each platform's raw upstream names in the cross-platform field equivalence table.
App schema
The unified SocialCrawl app-store listing schema. Every field, its type, per-platform availability, and a machine-readable JSON Schema, generated from the canonical Zod source.
Job schema
The unified SocialCrawl job posting schema. Every field, its type, per-platform availability, and a machine-readable JSON Schema, generated from the canonical Zod source.
