Saltar al contenido
Referencia de API
Referencia de API

Recuperar el saldo

Recuperar el saldo de pago y bonificación restante, más los totales de uso actuales.

Ver Markdown

Recuperar el saldo de pago y bonificación restante, más los totales de uso actuales.

Endpoint

GET /api/v1/me/balance
URL base
https://runapi.ai
Versión de la API
v1
Autenticación
Authorization: Bearer YOUR_API_KEY
Autorización
Devuelve el saldo de la cuenta vinculada a la Clave de API estándar presentada.
02

Respuesta de éxito

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

Respuesta de error (401)

HTTP 401
Esquema de respuesta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

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

Respuesta de error (403)

HTTP 403
Esquema de respuesta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

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

Ejemplo de cURL

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