Skip to Content
API-ReferenzHealth Check

Health Check

Überprüfen Sie den Betriebsstatus des SharpAPI-Dienstes und wie aktuell seine Quotendaten sind.

GET /api/v1/health

AuthentifizierungPermalink zu diesem Abschnitt

Keine Authentifizierung erforderlich. Dies ist ein öffentlicher Endpoint. (Eine HEAD-Anfrage liefert nur den Statuscode, ohne Body.) Nur GET und HEAD werden akzeptiert — siehe Andere Methoden.

BeispielanfragenPermalink zu diesem Abschnitt

curl -X GET "https://api.sharpapi.io/api/v1/health"

AntwortPermalink zu diesem Abschnitt

Die Antwort ist ein flaches Objekt mit genau zwei Feldern, status und newest_odds_age_s. Es gibt keinen checks/timestamp-Wrapper, und es werden keine Build- oder Backend-Diagnosedaten zurückgegeben.

Healthy (200)Permalink zu diesem Abschnitt

{ "status": "ok", "newest_odds_age_s": 1 }

Degraded (200)Permalink zu diesem Abschnitt

Der Dienst läuft, hat aber keine aktuellen Quotendaten (die letzte abgeschlossene Aktualisierung ist älter als 60 s, oder es wurde noch keine abgeschlossen). Der HTTP-Code bleibt 200, damit Load Balancer bei einem Upstream-Datenvorfall weiterhin hierher routen:

{ "status": "degraded", "newest_odds_age_s": 142 }

Starting (503)Permalink zu diesem Abschnitt

Der Prozess läuft und nimmt Verbindungen an, aber der Start (Laden der Quoten, Befüllen der Caches) ist noch nicht abgeschlossen. Versuchen Sie es in Kürze erneut:

{ "status": "starting", "newest_odds_age_s": -1 }

Down (503)Permalink zu diesem Abschnitt

Eine zentrale Backend-Abhängigkeit ist nicht erreichbar:

{ "status": "down", "newest_odds_age_s": 9 }

Antwort-HeaderPermalink zu diesem Abschnitt

X-Request-Id: 1782526326424224-82519

Der Health-Endpoint gibt keine Rate-Limit-Header oder Tier-Header zurück, da keine Authentifizierung erforderlich ist.

AntwortfelderPermalink zu diesem Abschnitt

FeldTypBeschreibung
statusstringGesamtstatus: ok, degraded, starting oder down
newest_odds_age_sintegerSekunden seit der letzten abgeschlossenen Aktualisierung der Quotendaten durch die API. -1, solange noch keine Quotendaten geladen sind. Gemessen wird der Aktualisierungszyklus, nicht das Alter einzelner Quoten.

Frühere Versionen dieses Endpoints lieferten zusätzlich eine Build-Kennung und Backend-Diagnosedaten. Diese sind nicht mehr Teil der öffentlichen Antwort — lesen Sie nur status und newest_odds_age_s.

StatuswertePermalink zu diesem Abschnitt

StatusHTTP-CodeBedeutung
ok200Aktuelle Quotendaten sind geladen (letzte Aktualisierung vor höchstens 60 s)
degraded200Dienst läuft, aber keine aktuellen Quotendaten (letzte Aktualisierung vor mehr als 60 s, oder keine geladen)
starting503Prozess läuft, aber der Start ist noch nicht abgeschlossen
down503Eine zentrale Backend-Abhängigkeit ist nicht erreichbar

StatuslogikPermalink zu diesem Abschnitt

Der Gesamt-status wird in dieser Reihenfolge bestimmt:

  1. Start nicht abgeschlossen → starting (503).
  2. Zentrale Backend-Abhängigkeit nicht erreichbar → down (503).
  3. Veraltete oder fehlende Quotendaten (die letzte Aktualisierung ist älter als 60 Sekunden, oder es wurde noch keine abgeschlossen) → degraded (200).
  4. Andernfalls → ok (200).

Andere MethodenPermalink zu diesem Abschnitt

Jede andere Methode als GET oder HEAD liefert 405 Method Not Allowed mit dem Header Allow: GET, HEAD:

curl -i -X POST "https://api.sharpapi.io/api/v1/health"
HTTP/1.1 405 Method Not Allowed Allow: GET, HEAD X-Error-Code: method_not_allowed
{ "error": { "code": "method_not_allowed", "message": "Method not allowed" } }

Siehe HTTP-Fehlercodes.

AnwendungsfällePermalink zu diesem Abschnitt

Monitoring und AlarmierungPermalink zu diesem Abschnitt

Verwenden Sie den Health-Endpoint in Ihrem Monitoring-Stack (Prometheus, Datadog, UptimeRobot usw.), um Probleme zu erkennen:

# Simple health check for monitoring scripts STATUS=$(curl -s https://api.sharpapi.io/api/v1/health | jq -r '.status') if [ "$STATUS" != "ok" ]; then echo "ALERT: SharpAPI status is $STATUS" fi

Health-Prüfung vor AnfragenPermalink zu diesem Abschnitt

Überprüfen Sie die Verfügbarkeit, bevor Sie kritische Anfragen stellen:

async function safeRequest(endpoint) { const health = await fetch('https://api.sharpapi.io/api/v1/health') .then(r => r.json()); if (health.status === 'down' || health.status === 'starting') { throw new Error(`SharpAPI is not ready (status: ${health.status})`); } if (health.status === 'degraded') { console.warn('SharpAPI is degraded - data may be stale'); } return fetch(`https://api.sharpapi.io/api/v1${endpoint}`, { headers: { 'X-API-Key': 'YOUR_API_KEY' } }).then(r => r.json()); }

Uptime-DashboardPermalink zu diesem Abschnitt

import requests response = requests.get('https://api.sharpapi.io/api/v1/health') health = response.json() print(f"SharpAPI Status: {health['status'].upper()}") print(f"Newest odds: {health['newest_odds_age_s']}s old")

Verwandte EndpointsPermalink zu diesem Abschnitt

Last updated on