Provider Health

GETGET /v1/provider/health

Description

Status of each upstream data provider: state, measured latency, last success and last failure times, error count, configured capabilities and a short note. This is how the API stays transparent about where its data comes from.

Parameters

Code Example

javascript

const res = await fetch("https://railway-engine.apkscope.workers.dev/v1/provider/health", {
  headers: { "x-api-key": "YOUR_KEY" },
});

const { status, data, error } = await res.json();
if (status === "SUCCESS") {
  for (const provider of data.providers) {
    console.log(
      provider.name, provider.state,
      provider.latencyMs + "ms", "errors:", provider.errorCount,
      provider.note,
    );
  }
} else {
  console.error(status, error?.code, error?.message);
}

Notes

Errors: 401 for a missing or invalid key, 429 RATE_LIMITED. A provider in a degraded state explains elevated freshness ages and STALE_DATA responses elsewhere in the API.

Response Example

JSON response

200JSON