> ## 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 无缝集成到您的产品中。

<Note>
  开始之前！<br />
  您应该创建一个免费的 Blockradar 账户，用于测试 API。我们将为您提供测试密钥，用于进行 API 调用。
</Note>

<Card title="Postman 集合" icon="leaf" href="https://documenter.getpostman.com/view/7709133/2s93eSYaVs">
  查看 Postman 集合
</Card>

Blockradar API 让您可以访问控制面板上几乎所有可用的功能，并允许您在产品中扩展使用这些功能。它力求遵循 RESTful 规范，围绕您将要交互的主要资源进行组织——有少数例外情况。

### 示例请求

我们在每个方法旁边提供[使用 cURL](https://curl.se/) 的示例 API 调用。您只需插入您的特定参数，即可从命令行测试调用。请参阅此教程了解[如何将 cURL 与 API 结合使用](https://www.baeldung.com/curl-rest)。

如果您不熟悉 cURL，也可以[使用 Postman](https://www.postman.com/downloads/)。Postman 是一个易于使用的 API 开发和测试平台。您可以探索 [Blockradar Postman 集合](https://documenter.getpostman.com/view/7709133/2s93eSYaVs)来了解我们的 API 如何工作。

### 请求和响应

请求体数据和响应数据都以 JSON 格式化。响应的内容类型始终为 application/json。通常，所有响应都采用以下格式：

```json theme={null}
{
  "statusCode": "[number]",
  "message": "[string]",
  "data": "[object]"
}
```

### 键

| 属性         | 类型     | 描述                                                                                                                        |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------- |
| statusCode | number | 这是请求状态码，让您知道请求是否成功。我们建议您使用此值来确定 API 调用的结果。                                                                                |
| message    | string | 这是响应及其状态的摘要。例如，当尝试检索客户列表时，message 可能显示"Transactions fetched successfully"。如果发生错误，message 键将包含错误描述，如上述授权头情况。这是所有请求中唯一通用的键。 |
| data       | object | 这包含您请求的结果。根据发出的请求，它可以是对象或数组。例如，检索单个交易的请求将在 data 键中返回交易对象，而请求列表时该键将是交易数组。                                                  |

### Meta 对象

meta 键用于为 data 键的内容提供上下文。例如，如果正在检索客户执行的交易列表，可以传递分页参数来限制结果集。meta 键将包含具有以下属性的对象：

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

| 属性           | 描述                                  |
| ------------ | ----------------------------------- |
| totalItems   | 可用项目的总数。这表示所有页面中项目的完整计数。            |
| itemCount    | 当前页面上的项目数。这表示当前响应中返回的项目数量。          |
| itemsPerPage | 每页的最大项目数。这定义了每个页面的分页限制。**默认值: 100** |
| totalPages   | 可用的总页数。这是根据项目总数和每页项目数计算的。           |
| currentPage  | 当前页码。这表示当前响应中返回的是哪一页分页结果。**默认值: 1** |