# GET /v1/balance

Obtenir le solde

Solde actuel de l'éditeur : `available` est le montant pouvant être demandé en paiement, `pending` correspond aux revenus estimés (jours qu'AGIMone n'a pas encore finalisés ; non payables avant d'être définitifs), `requested` est le montant des demandes de paiement ouvertes, `paid_total` est le total déjà payé et `min_payout` est le montant minimal de paiement. Tous les montants sont des chaînes monétaires. Mêmes chiffres que le champ `balance` de GET /v1/earnings. Nécessite la portée `publisher:read` (clé API ou session web). Niveau de limite de débit : `read`.

- Portée requise: `publisher:read`
- Limite débit: `read` — 120 requêtes par fenêtre de 60 s par clé API ou session web

## Paramètres

Aucun paramètre.

## Réponse

```
{ available: string; held: string; min_payout: string; paid_total: string; pending: string; requested: string }
```

## Erreurs

Les routes soumises à une limite de débit renvoient `RateLimit-Limit`, `RateLimit-Remaining` et `RateLimit-Reset` (secondes avant la fin de la fenêtre) ; une réponse 429 contient aussi `Retry-After`. Ces en-têtes peuvent être absents lorsque le limiteur est temporairement indisponible (les requêtes sont alors acceptées).

| Statut | Sens |
|---|---|
| 401 | Clé API absente, invalide ou révoquée. |
| 403 | La clé n'a pas la portée requise, ou l'opération n'est pas autorisée pour cet acteur. |
| 429 | Limite de débit dépassée ; attendez `Retry-After` secondes. |

## Exemples

### cURL

```bash
#!/usr/bin/env bash
# GET /v1/balance: current balance (pending, available, requested, paid_total, min_payout).
# Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE.
set -euo pipefail
BASE="${AGIMONE_API_BASE:-https://app.agimone.com}"
curl -fsS -H "Authorization: Bearer $AGIMONE_API_KEY" "$BASE/v1/balance"
echo
```

### Node.js

```js
// GET /v1/balance: current balance (pending, available, requested, paid_total, min_payout). Node 18+, no dependencies.
// Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE.
const base = process.env.AGIMONE_API_BASE ?? 'https://app.agimone.com';

const res = await fetch(`${base}/v1/balance`, {
  headers: { Authorization: `Bearer ${process.env.AGIMONE_API_KEY}` },
});
if (!res.ok) {
  console.error(`HTTP ${res.status}: ${await res.text()}`);
  process.exit(1);
}
console.log(JSON.stringify(await res.json()));
```

### PHP

```php
<?php
// GET /v1/balance: current balance (pending, available, requested, paid_total, min_payout). PHP 8 with the curl extension, no other dependencies.
// Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE.
$base = getenv('AGIMONE_API_BASE') ?: 'https://app.agimone.com';

$ch = curl_init("$base/v1/balance");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('AGIMONE_API_KEY')],
    CURLOPT_TIMEOUT => 15,
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($body === false || $status >= 400) {
    fwrite(STDERR, "HTTP $status: " . ($body === false ? curl_error($ch) : $body) . "\n");
    exit(1);
}
curl_close($ch);
echo trim($body), "\n";
```

### Python

```python
# GET /v1/balance: current balance (pending, available, requested, paid_total, min_payout). Python 3.8+, standard library only.
# Needs: AGIMONE_API_KEY (create one at https://app.agimone.com/app/account/api-keys). Optional: AGIMONE_API_BASE.
import json
import os
import sys
import urllib.error
import urllib.request

base = os.environ.get("AGIMONE_API_BASE", "https://app.agimone.com")
req = urllib.request.Request(
    f"{base}/v1/balance",
    headers={"Authorization": f"Bearer {os.environ['AGIMONE_API_KEY']}"},
)
try:
    with urllib.request.urlopen(req, timeout=15) as res:
        print(json.dumps(json.load(res)))
except urllib.error.HTTPError as e:
    print(f"HTTP {e.code}: {e.read().decode()}", file=sys.stderr)
    sys.exit(1)
```

Documentation HTML: https://agimone.com/fr/developers/api/#get-balance
API 2026-10
