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

# Admin API

> Acesso programático aos dados de uso e faturamento do projeto via autenticação por chave de API.

A Admin API fornece acesso programático ao uso de créditos do seu projeto, detalhes de assinatura e contagens de solicitações por serviço. Use-a para criar painéis internos, automatizar alertas de uso ou integrar dados de faturamento Helius em seus próprios sistemas, tudo autenticado com sua chave de API padrão Helius.

**URL Base**: `https://admin-api.helius.xyz`

## Exemplo Rápido

Obtenha o uso do ciclo de faturamento atual para um projeto:

<CodeGroup>
  ```bash cURL theme={"system"}
  curl "https://admin-api.helius.xyz/v0/admin/projects/YOUR_PROJECT_ID/usage" \
    -H "X-Api-Key: YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={"system"}
  const response = await fetch(
    `https://admin-api.helius.xyz/v0/admin/projects/${PROJECT_ID}/usage`,
    { headers: { "X-Api-Key": API_KEY } }
  );
  const usage = await response.json();
  ```

  ```python Python theme={"system"}
  import requests

  response = requests.get(
      f"https://admin-api.helius.xyz/v0/admin/projects/{PROJECT_ID}/usage",
      headers={"X-Api-Key": API_KEY},
  )
  usage = response.json()
  ```
</CodeGroup>

### Resposta de Exemplo

```json theme={"system"}
{
  "creditsRemaining": 486100,
  "creditsUsed": 13900,
  "prepaidCreditsRemaining": 50000,
  "prepaidCreditsUsed": 0,
  "subscriptionDetails": {
    "billingCycle": {
      "start": "2026-04-01",
      "end": "2026-05-01"
    },
    "creditsLimit": 500000,
    "plan": "business"
  },
  "credits": {
    "rpc": 4500,
    "enhancedApi": 1200,
    "walletApi": 0,
    "das": 5000,
    "webhooks": 800,
    "laserstreamGrpc": 1500,
    "laserstreamWebsocket": 800,
    "preConfirmations": 100,
    "archival": 0,
    "photon": 0,
    "other": 0
  },
  "requests": {
    "rpc": 4500,
    "enhancedApi": 1200,
    "walletApi": 0,
    "das": 5000,
    "webhooks": 800,
    "preConfirmations": 50,
    "archival": 0,
    "photon": 0,
    "other": 0
  },
  "dataTransfer": {
    "laserstreamGrpc": 15000000,
    "laserstreamWebsocket": 8000000
  }
}
```

## Autenticação

Passe sua chave de API Helius como um cabeçalho (recomendado) ou parâmetro de consulta:

* **Cabeçalho**: `X-Api-Key: YOUR_API_KEY`
* **Parâmetro de consulta**: `?api-key=YOUR_API_KEY`

<Note>
  A chave de API deve pertencer ao projeto que você está consultando. Requisições onde o projeto da chave de API não corresponde ao ID do projeto no caminho retornarão um erro `400`.
</Note>

## Limites de Taxa

A Admin API tem um limite de taxa de **5 requisições por segundo** por projeto.

## Endpoints

<CardGroup cols={2}>
  <Card title="Obter Uso do Projeto" href="/docs/pt-BR/api-reference/admin/get-project-usage">
    Recupere o uso de crédito, detalhes de assinatura e contagens de solicitações por serviço para o ciclo de faturamento atual.
  </Card>
</CardGroup>