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

# Indicadores públicos de transparência

> O endpoint público GET /transparency devolve totais consolidados da plataforma NyxPag, sem autenticação, cadastro nem consumo da cota de requisições.

`GET /transparency` expõe totais consolidados da plataforma NyxPag. Não exige API Key, cadastro nem sessão, e serve para exibir números agregados numa página pública.

```http theme={"dark"}
GET https://api.nyxpag.com.br/v1/transparency
```

É o único endpoint de dados que dispensa autenticação. Ele também **não consome** a cota de 100 requisições por minuto de nenhuma chave.

## Exemplo

<CodeGroup>
  ```bash cURL theme={"dark"}
  curl https://api.nyxpag.com.br/v1/transparency
  ```

  ```javascript JavaScript theme={"dark"}
  const res = await fetch("https://api.nyxpag.com.br/v1/transparency");
  const { data } = await res.json();
  console.log(data.transacoesConcluidas, data.volumeMovimentado);
  ```

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

  data = requests.get("https://api.nyxpag.com.br/v1/transparency", timeout=15).json()["data"]
  print(data["transacoesConcluidas"], data["volumeMovimentado"])
  ```

  ```php PHP theme={"dark"}
  <?php
  $data = json_decode(file_get_contents('https://api.nyxpag.com.br/v1/transparency'), true)['data'];
  echo $data['transacoesConcluidas'] . ' transações, R$ ' . $data['volumeMovimentado'];
  ```
</CodeGroup>

## Resposta

```json 200 OK theme={"dark"}
{
  "success": true,
  "data": {
    "transacoesConcluidas": 42,
    "contasCriadas": 18,
    "volumeMovimentado": 124.15,
    "moeda": "BRL",
    "atualizadoEm": "2026-10-03T14:00:00.000Z"
  }
}
```

| Campo | Tipo | Descrição |
| - | - | - |
| `transacoesConcluidas` | integer | Total de transações concluídas na plataforma |
| `contasCriadas` | integer | Total de contas criadas |
| `volumeMovimentado` | number | Volume movimentado, em reais |
| `moeda` | string | Sempre `BRL` |
| `atualizadoEm` | string | Última atualização, ISO 8601 UTC |

Os números acima são ilustrativos.

## Códigos de resposta

| Código | Significado |
| - | - |
| `200` | Indicadores atualizados |
| `503` | Indicadores temporariamente indisponíveis |

<Tip>
  Os dados são agregados e não sensíveis, então dá para chamar direto do frontend. Mesmo assim, guarde o resultado em cache por alguns minutos para não repetir a chamada a cada visita.
</Tip>

<Note>
  Apesar de público, o endpoint ainda está sujeito às proteções por IP da NyxPag, que podem devolver `429` em excesso de chamadas.
</Note>

<CardGroup cols={2}>
  <Card title="Consultar indicadores públicos" icon="code" href="/api-reference/transparência/consultar-indicadores-públicos">
    Referência completa do endpoint.
  </Card>

  <Card title="Visão geral da API" icon="layers" href="/guides/api-visao-geral">
    Convenções e mapa de todos os endpoints.
  </Card>
</CardGroup>


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