Aller au contenu
Référence API
Référence API

Récupérer le solde

Récupérer le solde payant et bonus restant ainsi que les totaux d'utilisation actuels.

Voir en Markdown

Récupérer le solde payant et bonus restant ainsi que les totaux d’utilisation actuels.

Point de terminaison

GET /api/v1/me/balance
URL de base
https://runapi.ai
Version de l'API
v1
Authentification
Authorization: Bearer YOUR_API_KEY
Autorisation
Retourne le solde du compte associé à la clé API Standard présentée.
02

Réponse de succès

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

Réponse d'erreur (401)

HTTP 401
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Réponse d'erreur (403)

HTTP 403
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Exemple cURL

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