# GET /v1/balance

Obter saldo

Saldo atual do publisher: `available` é o valor que pode ser solicitado para pagamento, `pending` é a receita estimada (dias que a AGIMone ainda não finalizou; não pagável até ficar final), `requested` é o valor em solicitações de pagamento abertas, `paid_total` é o total já pago e `min_payout` é o valor mínimo de pagamento. Todos os valores são strings monetárias. Os mesmos números do campo `balance` de GET /v1/earnings. Exige o escopo `publisher:read` (chave de API ou sessão web). Nível de limite de taxa: `read`.

- Escopo exigido: `publisher:read`
- Limite de taxa: `read` — 120 requisições por janela de 60 s por chave de API ou sessão web

## Parâmetros

Sem parâmetros.

## Resposta

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

## Erros

As rotas com limite de taxa retornam `RateLimit-Limit`, `RateLimit-Remaining` e `RateLimit-Reset` (segundos até o fim da janela); um 429 também traz `Retry-After`. Os headers podem estar ausentes enquanto o limitador estiver temporariamente indisponível (as requisições passam nesse caso).

| Status | Significado |
|---|---|
| 401 | Chave de API ausente, inválida ou revogada. |
| 403 | A chave não tem o escopo exigido, ou a operação não é permitida para este ator. |
| 429 | Limite de taxa excedido; aguarde `Retry-After` segundos. |

## Exemplos

### 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)
```

Documentação HTML: https://agimone.com/pt/developers/api/#get-balance
API 2026-10
