Gateway Health & Mirror Telemetry
GET/v1/health0 Credits (Free)($0.00)
Zero-cost health probe returning real-time upstream pool status and total posts, comments, subreddits, and users cached in our local PostgreSQL 16 mirror.
Example Request (cURL / Python / JavaScript)
curl "https://api.forumdataapi.com/v1/health" \
-H "x-api-key: rd_live_your_api_key"import requests
res = requests.get(
"https://api.forumdataapi.com/v1/health",
headers={"x-api-key": "rd_live_your_api_key"},
timeout=30,
)
print(res.json())const res = await fetch("https://api.forumdataapi.com/v1/health", {
headers: { "x-api-key": "rd_live_your_api_key" },
});
const data = await res.json();
console.log(data);Live Response Preview
{
"status": "ok",
"service": "forumdataapi.com",
"version": "1.0.0",
"posts_cached": 14820,
"comments_cached": 92410,
"subreddits_cached": 640,
"users_cached": 3890,
"timestamp": "2026-11-04T16:00:00.000Z"
}Response Fields
Gateway health status and cached entity counts
| Field | Type | Sample / Notes |
|---|---|---|
status | string | Gateway health status (ok) |
service | string | Service identifier (forumdataapi.com) |
version | string | Gateway release version |
posts_cached | integer | Total public Reddit posts indexed in local PostgreSQL 16 mirror |
comments_cached | integer | Total public Reddit comments indexed in local PostgreSQL 16 mirror |
subreddits_cached | integer | Total subreddits indexed in local PostgreSQL 16 mirror |
users_cached | integer | Total Reddit user profiles indexed in local PostgreSQL 16 mirror |
timestamp | string | ISO-8601 server timestamp |
Status Codes
- 200
- Gateway health status and cached entity counts