v1

latestOpenAPI 3.1.0MIT2026-08-0453113564.4 KB

Health-Check

X/Twitter Service Health

Returns public health and freshness metadata for the X/Twitter stocks platform.

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

get/x/stocks/v1/health

Response

Successful Response

statusstring required

Current health status (healthy/unhealthy)

servicestring required

Service identifier

versionstring required

Current API version

total_mentionsinteger required

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

tickers_trackedinteger required

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": "x-stocks",
  "version": "1.49.0",
  "total_mentions": 15420,
  "tickers_tracked": 247,
  "scheduler": {
    "running": true,
    "last_scrape": "2025-12-31T06:00:00Z",
    "scrape_count": 42,
    "error_count": 2,
    "success_rate": 0.95
  }
}