> ## 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.

# API Tour

> A quick overview of how the Blockradar API is structured.

The Blockradar API is RESTful and gives you programmatic access to every feature available on the dashboard. It is organized around the core resources you interact with: wallets, addresses, transactions, and the products built on top of them.

<Note>
  Before you begin, [create a free Blockradar account](https://dashboard.blockradar.co/signup) to get your API keys. You can test against our sandbox environment before going live.
</Note>

## Base URL

All API requests are made to:

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

## Request and response format

All request bodies and responses are formatted as JSON. Every response follows this structure:

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

| Property     | Type            | Description                                                                                     |
| ------------ | --------------- | ----------------------------------------------------------------------------------------------- |
| `statusCode` | number          | HTTP status code indicating success or failure. Use this to determine the result of every call. |
| `message`    | string          | A human-readable summary of the response. On errors, this describes what went wrong.            |
| `data`       | object or array | The result of your request. A single resource returns an object; a list returns an array.       |

## Pagination

List endpoints return a `meta` object alongside `data`:

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

| Property       | Description                                    |
| -------------- | ---------------------------------------------- |
| `totalItems`   | Total number of items across all pages.        |
| `itemCount`    | Number of items on the current page.           |
| `itemsPerPage` | Pagination limit per page. Default: `100`.     |
| `totalPages`   | Total number of pages available.               |
| `currentPage`  | The current page being returned. Default: `1`. |

## Postman collection

Prefer exploring APIs visually? Use the [Blockradar Postman Collection](https://documenter.getpostman.com/view/7709133/2s93eSYaVs) to browse and test every endpoint interactively.

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock" href="/en/about-the-api/authentication">
    Learn how to authenticate your API requests.
  </Card>

  <Card title="Errors" icon="circle-exclamation" href="/en/about-the-api/errors">
    Understand error codes and how to handle them.
  </Card>
</CardGroup>

***

## Wallets

<CardGroup cols={2}>
  <Card title="Master Wallet API" icon="wallet" href="/en/about-the-api/master-wallet">
    Manage your master wallets, balances, and sweep operations.
  </Card>

  <Card title="Addresses API" icon="address-card" href="/en/about-the-api/addresses">
    Generate and manage child addresses for your users.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/en/utilities/webhooks">
    Receive real-time notifications for deposits, withdrawals, and on-chain events.
  </Card>

  <Card title="Signing API" icon="signature" href="/en/about-the-api/signing">
    Sign messages and typed data from any Blockradar wallet.
  </Card>

  <Card title="Transactions API" icon="receipt" href="/en/about-the-api/transactions">
    Retrieve, manage, and replay transactions across your wallets.
  </Card>

  <Card title="Asset Management API" icon="sliders" href="/en/about-the-api/asset-management">
    Configure which assets are active on your master wallet.
  </Card>
</CardGroup>

## Receive Payments

<CardGroup cols={2}>
  <Card title="Deposit Stablecoins API" icon="arrow-down-to-bracket" href="/en/about-the-api/deposit-stablecoins">
    Accept stablecoin deposits via dedicated blockchain addresses.
  </Card>

  <Card title="Checkout API" icon="link" href="/en/about-the-api/checkout">
    Create and manage stablecoin payment links.
  </Card>

  <Card title="Virtual Accounts API" icon="building" href="/en/about-the-api/virtual-accounts">
    Issue bank account numbers linked to on-chain wallets for fiat deposits.
  </Card>
</CardGroup>

## Send Payments

<CardGroup cols={2}>
  <Card title="Withdraw Stablecoins API" icon="arrow-up-from-bracket" href="/en/about-the-api/withdraw">
    Send stablecoins from master wallets or child addresses.
  </Card>

  <Card title="Withdraw Fiat API" icon="money-bill-transfer" href="/en/about-the-api/withdraw-fiat">
    Convert stablecoins to fiat and send to bank accounts.
  </Card>

  <Card title="Beneficiaries API" icon="address-book" href="/en/about-the-api/beneficiaries">
    Save and manage frequent withdrawal destinations.
  </Card>
</CardGroup>

## Convert & Manage

<CardGroup cols={2}>
  <Card title="Gateway API" icon="circle" href="/en/about-the-api/gateway">
    Move USDC natively across chains using Circle's CCTP protocol.
  </Card>

  <Card title="Swap API" icon="arrows-rotate" href="/en/about-the-api/swap">
    Swap stablecoins across assets and chains.
  </Card>

  <Card title="Auto Settlements API" icon="swap" href="/en/about-the-api/auto-settlements">
    Configure rules to automatically convert and route assets.
  </Card>

  <Card title="Liquidity Pool API" icon="droplet" href="/en/about-the-api/liquidity-pool">
    Manage stablecoin liquidity rates for corridor-based settlement.
  </Card>
</CardGroup>

## Compliance & Recovery

<CardGroup cols={2}>
  <Card title="AML API" icon="shield-halved" href="/en/about-the-api/aml">
    Screen wallet addresses against global sanctions and blocklists.
  </Card>

  <Card title="Asset Recovery API" icon="life-ring" href="/en/about-the-api/asset-recovery">
    Recover tokens accidentally sent to unsupported wallet addresses.
  </Card>
</CardGroup>

## Integrations

<CardGroup cols={2}>
  <Card title="Smart Contract API" icon="file-contract" href="/en/about-the-api/smart-contracts">
    Read and write to any smart contract from a Blockradar wallet.
  </Card>

  <Card title="Miscellaneous API" icon="grid-2" href="/en/about-the-api/miscellaneous">
    Retrieve supported assets, blockchains, and exchange rates.
  </Card>
</CardGroup>