> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tronrental.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar regras de largura de banda

> Todas as regras de Recarga automática de largura de banda da sua conta

## Listar regras de largura de banda

Retorna todas as regras de Recarga automática de largura de banda da sua conta, das mais antigas para as mais recentes. Regras excluídas não são incluídas. Exige o escopo `view`.

### Resposta

**rules** `array`

As suas regras de largura de banda.

**objeto de regra**

**id** `number`

ID da regra — use-o nos caminhos de edição e exclusão

**target\_address** `string`

O endereço que a regra mantém abastecido

**label** `string | null`

O nome que você deu à regra

**threshold\_bandwidth** `number`

A regra compra quando a largura de banda disponível está abaixo deste valor

**add\_volume** `number`

Largura de banda comprada por recarga

**duration** `string`

Duração do aluguel de cada recarga — `1h` ou `1d`

**status** `string`

`active`, `paused` ou `stopped_insufficient_balance` — veja [Status da regra](/pt/api-reference/auto-refill/overview#status-da-regra)

**stopped\_reason** `string | null`

Por que a regra foi pausada ou parada: `insufficient_balance`, `order_failed`, `activation_failed` ou `invalid_params`. `null` quando não há motivo.

**consecutive\_failures** `number`

Recargas com falha seguidas. A regra é pausada quando este valor chega a 5; uma recarga bem-sucedida o redefine para 0.

**last\_checked\_at** `string | null`

Quando verificamos o endereço pela última vez (ISO 8601, UTC), com ou sem sucesso na leitura. `null` antes da primeira verificação.

**last\_available\_bandwidth** `number | null`

Largura de banda disponível no endereço na última verificação bem-sucedida, incluindo a gratuita. `null` antes da primeira leitura bem-sucedida.

**last\_read\_error\_at** `string | null`

Quando uma verificação falhou pela última vez ao ler o endereço (ISO 8601, UTC). `null` quando a última verificação teve sucesso. Enquanto estiver preenchido, `last_available_bandwidth` vem de uma verificação anterior e pode estar desatualizado. Uma verificação que não consegue ler o endereço não compra nada.

**last\_refill\_at** `string | null`

Quando foi feita a última recarga. `null` se ainda não houve nenhuma.

**refill\_count** `number`

Recargas bem-sucedidas desde a criação da regra

**total\_spent\_trx** `string`

Total de TRX gasto nessas recargas

**created\_at** `string`

Quando a regra foi criada (ISO 8601, UTC)

**estimated\_cost\_per\_refill\_trx** `string | null`

Preço total de uma recarga para a sua conta pelos preços atuais, taxa fixa incluída. A ativação do endereço, quando necessária, é cobrada à parte. `null` se o preço estiver temporariamente indisponível.

**volume\_below\_threshold** `boolean`

`true` quando `add_volume` é menor que `threshold_bandwidth`. Nesse caso, uma recarga pode não levar o endereço acima do limiar, e a regra compra de novo após cada gasto — veja o [aviso na visão geral](/pt/api-reference/auto-refill/overview#escolhendo-os-números).

### Exemplo

```bash cURL theme={null}
curl https://api.tronrental.com/v1/bandwidth/auto-refill \
  -H "X-API-Key: your_api_key"
```

```python Python theme={null}
import requests

resp = requests.get(
    "https://api.tronrental.com/v1/bandwidth/auto-refill",
    headers={"X-API-Key": "your_api_key"},
)
print(resp.json())
```

```javascript JavaScript theme={null}
const resp = await fetch("https://api.tronrental.com/v1/bandwidth/auto-refill", {
  headers: { "X-API-Key": "your_api_key" },
});
console.log(await resp.json());
```

```json Response theme={null}
{
  "rules": [
    {
      "id": 15,
      "target_address": "TYourRecipientAddress1234567890abc",
      "label": "Payouts",
      "threshold_bandwidth": 1000,
      "add_volume": 5000,
      "duration": "1h",
      "status": "active",
      "stopped_reason": null,
      "consecutive_failures": 0,
      "last_checked_at": "2026-10-14T09:41:02Z",
      "last_available_bandwidth": 3655,
      "last_read_error_at": null,
      "last_refill_at": "2026-10-14T09:12:30Z",
      "refill_count": 4,
      "total_spent_trx": "1.480000",
      "created_at": "2026-10-14T08:15:00Z",
      "estimated_cost_per_refill_trx": "0.370000",
      "volume_below_threshold": false
    }
  ]
}
```

### Erros

| Status | Código | Quando |
| - | - | - |
| `403` | `FORBIDDEN` | A chave de API não tem o escopo `view` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.