API reference

An illustrative JSON API over the SUSURRUS CO. dataset. These endpoints mirror the site's search, ticker, and screener data but aren't wired up yet - the live site renders HTML fragments for htmx instead of JSON.

GET/api/v1/search

Search symbols by ticker, company name, or industry.

Param	Type	Description
`q`	string	Search query. Required.
`limit`	integer	Max results to return. Default 20.

{
  "query": "nvidia",
  "count": 1,
  "results": [
    { "symbol": "NVDA", "name": "NVIDIA CORP", "industry": "SEMICONDUCTORS & RELATED DEVICES" }
  ]
}

GET/api/v1/tickers/{symbol}

Full quarterly financial history for one symbol.

Param	Type	Description
`symbol`	string	Ticker symbol, case-insensitive. Path parameter.

{
  "symbol": "NVDA",
  "name": "NVIDIA CORP",
  "industry": "SEMICONDUCTORS & RELATED DEVICES",
  "quarters": [
    {
      "end_date": "2015-09-30",
      "price": 21.72,
      "pct_change": null,
      "volume": 73641074,
      "revenue": null,
      "earnings": -124000000,
      "gross_profit": -63000000,
      "market_cap": null,
      "debt_eq_ratio": null
    }
  ]
}

GET/api/v1/screener

Filter every tracked symbol by industry and by min/max ranges over each quarterly metric, using each company's latest filing.

Param	Type	Description
`industry`	string	Exact industry match. Optional.
`{metric}_min`	number	Lower bound for any quarterly metric, e.g. `revenue_min`. Optional.
`{metric}_max`	number	Upper bound for any quarterly metric, e.g. `market_cap_max`. Optional.

{
  "count": 2,
  "results": [
    { "symbol": "AAPL", "name": "APPLE INC.", "industry": "ELECTRONIC COMPUTERS", "price": 227.52, "revenue": 391035000000, "earnings": 93736000000, "market_cap": 3450000000000 },
    { "symbol": "MSFT", "name": "MICROSOFT CORP", "industry": "SERVICES-PREPACKAGED SOFTWARE", "price": 429.03, "revenue": 245122000000, "earnings": 88136000000, "market_cap": 3190000000000 }
  ]
}