> ## 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 导览

> 快速了解 Blockradar API 的结构。

Blockradar API 是 RESTful 的，让您可以通过编程方式访问控制台上的所有功能。它围绕您交互的核心资源组织：钱包、地址、交易以及构建在其之上的产品。

<Note>
  在开始之前，[创建一个免费的 Blockradar 账户](https://dashboard.blockradar.co/signup)以获取您的 API 密钥。您可以在上线前使用我们的沙盒环境进行测试。
</Note>

## 基础 URL

所有 API 请求发送至：

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

## 请求和响应格式

所有请求体和响应均采用 JSON 格式。每个响应遵循以下结构：

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

| 属性           | 类型             | 描述                                |
| ------------ | -------------- | --------------------------------- |
| `statusCode` | number         | 表示成功或失败的 HTTP 状态码。使用此值来判断每次调用的结果。 |
| `message`    | string         | 人类可读的响应摘要。出错时，描述出了什么问题。           |
| `data`       | object 或 array | 请求的结果。单个资源返回对象；列表返回数组。            |

## 分页

列表端点在 `data` 旁返回一个 `meta` 对象：

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

| 属性             | 描述                 |
| -------------- | ------------------ |
| `totalItems`   | 所有页面的总项目数。         |
| `itemCount`    | 当前页面的项目数。          |
| `itemsPerPage` | 每页的分页限制。默认值：`100`。 |
| `totalPages`   | 可用的总页数。            |
| `currentPage`  | 当前返回的页码。默认值：`1`。   |

## Postman 集合

更喜欢可视化地探索 API？使用 [Blockradar Postman Collection](https://documenter.getpostman.com/view/7709133/2s93eSYaVs) 浏览并交互式测试每个端点。

<CardGroup cols={2}>
  <Card title="认证" icon="lock" href="/zh/about-the-api/authentication">
    了解如何验证您的 API 请求。
  </Card>

  <Card title="错误" icon="circle-exclamation" href="/zh/about-the-api/errors">
    了解错误代码及其处理方式。
  </Card>
</CardGroup>

***

## 钱包

<CardGroup cols={2}>
  <Card title="主钱包 API" icon="wallet" href="/zh/about-the-api/master-wallet">
    管理您的主钱包、余额和归集操作。
  </Card>

  <Card title="地址 API" icon="address-card" href="/zh/about-the-api/addresses">
    为您的用户生成和管理子地址。
  </Card>

  <Card title="Webhooks" icon="webhook" href="/zh/utilities/webhooks">
    接收存款、提现和链上事件的实时通知。
  </Card>

  <Card title="签名 API" icon="signature" href="/zh/about-the-api/signing">
    从任何 Blockradar 钱包签署消息和类型化数据。
  </Card>

  <Card title="交易 API" icon="receipt" href="/zh/about-the-api/transactions">
    检索、管理和重放您钱包中的交易。
  </Card>

  <Card title="资产管理 API" icon="sliders" href="/zh/about-the-api/asset-management">
    配置主钱包上哪些资产处于活跃状态。
  </Card>
</CardGroup>

## 收款

<CardGroup cols={2}>
  <Card title="虚拟账户 API" icon="building" href="/zh/about-the-api/virtual-accounts">
    发行与链上钱包关联的银行账号。
  </Card>
</CardGroup>

## 付款

<CardGroup cols={2}>
  <Card title="稳定币提现 API" icon="arrow-up-from-bracket" href="/zh/about-the-api/withdraw">
    从主钱包或子地址发送稳定币。
  </Card>

  <Card title="提取法币 API" icon="money-bill-transfer" href="/zh/about-the-api/withdraw-fiat">
    将稳定币转换为法币并发送到银行账户。
  </Card>

  <Card title="收款人 API" icon="address-book" href="/zh/about-the-api/beneficiaries">
    保存和管理常用的提现目标。
  </Card>
</CardGroup>

## 转换与管理

<CardGroup cols={2}>
  <Card title="Gateway API" icon="circle" href="/zh/about-the-api/gateway">
    使用 Circle 的 CCTP 协议原生跨链转移 USDC。
  </Card>

  <Card title="兑换 API" icon="arrows-rotate" href="/zh/about-the-api/swap">
    跨资产和跨链兑换稳定币。
  </Card>

  <Card title="自动结算 API" icon="swap" href="/zh/about-the-api/auto-settlements">
    配置规则以自动转换和路由资产。
  </Card>

  <Card title="流动性池 API" icon="droplet" href="/zh/about-the-api/liquidity-pool">
    管理基于通道结算的稳定币流动性费率。
  </Card>

  <Card title="杂项 API" icon="grid-2" href="/zh/about-the-api/miscellaneous">
    获取支持的资产、区块链和汇率。
  </Card>
</CardGroup>

## 合规与工具

<CardGroup cols={2}>
  <Card title="AML API" icon="shield-halved" href="/zh/about-the-api/aml">
    针对全球制裁和黑名单筛查钱包地址。
  </Card>

  <Card title="资产找回 API" icon="life-ring" href="/zh/about-the-api/asset-recovery">
    找回意外发送到不支持的钱包地址的代币。
  </Card>

  <Card title="智能合约 API" icon="file-contract" href="/zh/about-the-api/smart-contracts">
    从 Blockradar 钱包读取和写入任何智能合约。
  </Card>

  <Card title="收银台 API" icon="link" href="/zh/about-the-api/checkout">
    创建和管理稳定币支付链接。
  </Card>
</CardGroup>
