v1

latestOpenAPI 3.1.0MIT2026-08-0453113564.4 KB

Health-Check

News Service Health

Returns public health and freshness metadata for the news stocks platform.

Use it to check service availability, ingestion freshness and worker liveness. Client integrations usually start with /trending, /stock/{ticker} or /search.

get/news/stocks/v1/health

Response

Successful Response

statusstring required

Current health status

servicestring nullable

Service identifier

versionstring nullable

Service version

total_mentionsinteger

Mentions observed in the most recent scrape cycle; returns 0 when scrape telemetry is unavailable.

tickers_trackedinteger

Distinct tickers observed in the most recent scrape cycle; returns 0 when scrape telemetry is unavailable.

errorstring nullable

Error message if unhealthy

Example response

{
  "status": "healthy",
  "service": "reddit-stocks",
  "version": "1.49.0",
  "total_mentions": 12833,
  "tickers_tracked": 65,
  "scheduler": {
    "running": true,
    "last_scrape": "2026-01-09T10:30:00Z",
    "scrape_count": 142,
    "error_count": 3,
    "success_rate": 0.979
  }
}