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

# Tour pela API

> Uma visão geral rápida de como a API do Blockradar é estruturada.

A API do Blockradar é RESTful e oferece acesso programático a todos os recursos disponíveis no painel. Ela é organizada em torno dos recursos principais com os quais você interage: carteiras, endereços, transações e os produtos construídos sobre eles.

<Note>
  Antes de começar, [crie uma conta gratuita no Blockradar](https://dashboard.blockradar.co/signup) para obter suas chaves de API. Você pode testar no nosso ambiente sandbox antes de ir para produção.
</Note>

## URL Base

Todas as requisições de API são feitas para:

```
https://api.blockradar.co/v1
```

## Formato de requisição e resposta

Todos os corpos de requisição e respostas são formatados como JSON. Cada resposta segue esta estrutura:

```json theme={null}
{
  "statusCode": 200,
  "message": "Request successful",
  "data": {}
}
```

| Propriedade  | Tipo            | Descrição                                                                                          |
| ------------ | --------------- | -------------------------------------------------------------------------------------------------- |
| `statusCode` | number          | Código de status HTTP indicando sucesso ou falha. Use para determinar o resultado de cada chamada. |
| `message`    | string          | Um resumo legível da resposta. Em caso de erros, descreve o que deu errado.                        |
| `data`       | object ou array | O resultado da sua requisição. Um único recurso retorna um objeto; uma lista retorna um array.     |

## Paginação

Endpoints de listagem retornam um objeto `meta` junto com `data`:

```json theme={null}
{
  "meta": {
    "totalItems": 704,
    "itemCount": 100,
    "itemsPerPage": 100,
    "totalPages": 8,
    "currentPage": 1
  }
}
```

| Propriedade    | Descrição                                      |
| -------------- | ---------------------------------------------- |
| `totalItems`   | Número total de itens em todas as páginas.     |
| `itemCount`    | Número de itens na página atual.               |
| `itemsPerPage` | Limite de paginação por página. Padrão: `100`. |
| `totalPages`   | Número total de páginas disponíveis.           |
| `currentPage`  | A página atual sendo retornada. Padrão: `1`.   |

## Coleção Postman

Prefere explorar APIs visualmente? Use a [Coleção Postman do Blockradar](https://documenter.getpostman.com/view/7709133/2s93eSYaVs) para navegar e testar cada endpoint interativamente.

<CardGroup cols={2}>
  <Card title="Autenticação" icon="lock" href="/pt/about-the-api/authentication">
    Aprenda como autenticar suas requisições de API.
  </Card>

  <Card title="Erros" icon="circle-exclamation" href="/pt/about-the-api/errors">
    Entenda os códigos de erro e como tratá-los.
  </Card>
</CardGroup>

***

## Carteiras

<CardGroup cols={2}>
  <Card title="API de Carteira Master" icon="wallet" href="/pt/about-the-api/master-wallet">
    Gerencie suas carteiras master, saldos e operações de sweep.
  </Card>

  <Card title="API de Endereços" icon="address-card" href="/pt/about-the-api/addresses">
    Gere e gerencie endereços filhos para seus usuários.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/pt/utilities/webhooks">
    Receba notificações em tempo real para depósitos, saques e eventos on-chain.
  </Card>

  <Card title="API de Assinatura" icon="signature" href="/pt/about-the-api/signing">
    Assine mensagens e dados tipados de qualquer carteira Blockradar.
  </Card>

  <Card title="API de Transações" icon="receipt" href="/pt/about-the-api/transactions">
    Consulte, gerencie e reenvie transações em todas as suas carteiras.
  </Card>

  <Card title="API de Gestão de Ativos" icon="sliders" href="/pt/about-the-api/asset-management">
    Configure quais ativos estão ativos na sua carteira master.
  </Card>
</CardGroup>

## Pay-ins

<CardGroup cols={2}>
  <Card title="API de Contas Virtuais" icon="building" href="/pt/about-the-api/virtual-accounts">
    Emita números de conta bancária vinculados a carteiras on-chain.
  </Card>
</CardGroup>

## Pay-outs

<CardGroup cols={2}>
  <Card title="API de Saque de Stablecoins" icon="arrow-up-from-bracket" href="/pt/about-the-api/withdraw">
    Envie stablecoins a partir de carteiras master ou endereços filhos.
  </Card>

  <Card title="API de Saque em Fiat" icon="money-bill-transfer" href="/pt/about-the-api/withdraw-fiat">
    Converta stablecoins em fiat e envie para contas bancárias.
  </Card>

  <Card title="API de Beneficiários" icon="address-book" href="/pt/about-the-api/beneficiaries">
    Salve e gerencie destinos frequentes de saque.
  </Card>
</CardGroup>

## Converter e Gerenciar

<CardGroup cols={2}>
  <Card title="API Gateway" icon="circle" href="/pt/about-the-api/gateway">
    Mova USDC nativamente entre blockchains usando o protocolo CCTP da Circle.
  </Card>

  <Card title="API de Swap" icon="arrows-rotate" href="/pt/about-the-api/swap">
    Troque stablecoins entre ativos e blockchains.
  </Card>

  <Card title="API de Liquidação Automática" icon="swap" href="/pt/about-the-api/auto-settlements">
    Configure regras para converter e direcionar ativos automaticamente.
  </Card>

  <Card title="API de Pool de Liquidez" icon="droplet" href="/pt/about-the-api/liquidity-pool">
    Gerencie taxas de liquidez de stablecoins para liquidação baseada em corredores.
  </Card>

  <Card title="API Diversos" icon="grid-2" href="/pt/about-the-api/miscellaneous">
    Consulte ativos suportados, blockchains e taxas de câmbio.
  </Card>
</CardGroup>

## Conformidade e Ferramentas

<CardGroup cols={2}>
  <Card title="API AML" icon="shield-halved" href="/pt/about-the-api/aml">
    Verifique endereços de carteira contra sanções globais e listas de bloqueio.
  </Card>

  <Card title="API de Recuperação de Ativos" icon="life-ring" href="/pt/about-the-api/asset-recovery">
    Recupere tokens enviados acidentalmente para endereços de carteira não suportados.
  </Card>

  <Card title="API de Smart Contract" icon="file-contract" href="/pt/about-the-api/smart-contracts">
    Leia e escreva em qualquer smart contract a partir de uma carteira Blockradar.
  </Card>

  <Card title="API de Checkout" icon="link" href="/pt/about-the-api/checkout">
    Crie e gerencie links de pagamento com stablecoins.
  </Card>
</CardGroup>