Zum Inhalt springen
API-Referenz
API-Referenz

Das Guthaben abrufen

Das verbleibende bezahlte und Bonusguthaben sowie die aktuellen Nutzungsgesamtwerte abrufen.

Markdown anzeigen

Das verbleibende bezahlte und Bonusguthaben sowie die aktuellen Nutzungsgesamtwerte abrufen.

Endpunkt

GET /api/v1/me/balance
Basis-URL
https://runapi.ai
API-Version
v1
Authentifizierung
Authorization: Bearer YOUR_API_KEY
Autorisierung
Gibt das Guthaben für das Konto zurück, das an den präsentierten Standard-API-Schlüssel gebunden ist.
02

Erfolgsantwort

HTTP 200

GET /api/v1/me/balance

JSON 
{
  "balance_cents": 1200,
  "bonus_balance_cents": 200,
  "paid_balance_cents": 1000,
  "spent_cents_today": 75,
  "spent_cents_total": 4300
}
03

Fehlerantwort (401)

HTTP 401
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Authentication required"
}
04

Fehlerantwort (403)

HTTP 403
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Standard API key required"
}
05

cURL-Beispiel

CURL 
curl -X GET https://runapi.ai/api/v1/me/balance \
  -H 'Authorization: Bearer YOUR_API_KEY'