Embed Ticker Card Json

Public JSON sibling to /embed/ticker/<T>.

Path: GET /api/v1/embed/ticker/<TICKER>?mode={compact,research}&ref=<host> Same data shape as the HTML embed (ticker + name + price + change_pct + as_of + as_of_humanized), with optional metrics block in research mode. Same rate limit + ticker normalization + ref hostname-shape gate as the HTML route.

metrics (research mode only) — any field is null when the figure is genuinely unavailable, never zero: pe price/earnings ratio ev_ebitda enterprise value / EBITDA div_yield dividend yield, as a PERCENT (2.15 means 2.15%) roe return on equity, as a PERCENT mkt_cap market capitalisation in RAW US DOLLARS

The unit on mkt_cap is stated because the value it is derived from is not in that unit: the snapshot carries market cap in BILLIONS, and publishing that verbatim under a bare mkt_cap key is how three of four callers misread the same figure in #44.

get/api/v1/embed/ticker/{ticker}

Request

  • Base URL: https://www.oxfordledge.com (the document declares no server; this is the origin it was published from)
  • URL: https://www.oxfordledge.com/api/v1/embed/ticker/{ticker}
  • Auth: none declared

Path parameters

tickerstring required

Query parameters

modestring nullable
refstring nullable

Response

Successful Response

tickerstring required

Uppercase ticker symbol.

namestring nullable

Company name; None if profile lookup empty.

pricenumber nullable

Latest close/intraday price; None if unavailable.

change_pctnumber nullable

Daily change in percent; None if unavailable.

as_ofstring nullable

ISO-8601 datetime or YYYY-MM-DD for the data freshness anchor. Null if unavailable.

as_of_humanizedstring required

Human-friendly freshness phrase: 'just now' / 'N min ago' / 'N hrs ago' / 'N days ago' / 'YYYY-MM-DD' (≥7d old) / 'data unavailable' (None).

modestring required

Either 'compact' or 'research'. Research mode adds the metrics block.

refstring nullable

Normalized embedding-host attribution (DNS-shape validated). Null when no ref param.

metricsobject nullable

Only present when mode=research. Five-metric block (pe / ev_ebitda / div_yield / roe / mkt_cap) mirroring the HTML embed's research strip.

pe_basisstring nullable

Only present when mode=research. The period metrics.pe divides by: 'TTM' (trailing four reported quarters), a fiscal year such as 'FY2025', or 'vendor'. Null when no P/E or no basis is known.

Changes

No recorded changes to this operation across all 1 revision of this API.