# WEEX 开发者文档

欢迎使用 WEEX 官方 API 文档。

本门户是面向开发者的核心参考文档，适用于构建与 WEEX 集成的应用、服务和交易系统。文档覆盖现货、合约和跟单交易，以及面向经纪商（Broker）和合伙人（Partner）的业务接口。

无论你是在编写简单脚本、生产级后端服务，还是交易与数据分析系统，都可以从这里了解可用能力、选择接入路径，并查看对应的接口要求。

## 如何使用本套文档

本套文档主要分为两个部分：

- **文档**：产品介绍、接入准备、接口类型、域名、签名、安全要求及更新日志。
- **API 参考**：接口定义、请求参数、响应结构、调用示例，以及现货和合约 WebSocket 数据流。

此外，[Agent 原生](/zh-CN/agent-native/overview)提供机器可读的文档索引和完整文档，方便 AI 编程助手与 Agent 加载接口上下文。

首次接入时，建议先阅读对应产品的指南；已明确产品或接口时，可直接进入 [API 参考](/zh-CN/catalog)。

## 选择你的起点

| 接入目标 | 推荐入口 |
| --- | --- |
| 首次使用 WEEX API | [现货快速开始](/zh-CN/products/spot/QuickStart)，了解密钥、权限和请求签名 |
| 获取行情、管理现货订单和账户 | [现货交易介绍](/zh-CN/products/spot/introduction/APIBriefIntroduction)与[现货 REST API](/zh-CN/catalog/core-trading-spot/api/rest-api/configapi) |
| 接入合约行情、交易和仓位管理 | [合约交易介绍](/zh-CN/products/futures/intro)与[合约 REST API](/zh-CN/catalog/core-trading-futures/api/rest-api/market-api) |
| 查询带单与跟单订单、管理跟单配置和仓位 | [跟单交易介绍](/zh-CN/products/copy/intro)与[跟单 REST API](/zh-CN/catalog/advanced-trading-copy-trading/api/rest-api/trader) |
| 接入经纪商业务、用户和子账户管理 | [经纪商介绍](/zh-CN/products/broker/intro)与[经纪商 REST API](/zh-CN/catalog/vip-institutional-broker/api/rest-api/api) |
| 查询返佣、受邀用户和下级合伙人业绩 | [合伙人介绍](/zh-CN/products/partner/intro)与[合伙人 REST API](/zh-CN/catalog/vip-institutional-partner/api/rest-api/rebate-endpoints) |
| 获取用户授权后为用户接入 API | [Broker OAuth 接入指南](/zh-CN/products/broker/oAuth) |
| 为 AI 工具加载文档 | [Agent 原生概览](/zh-CN/agent-native/overview) |

## 开始接入

推荐按照以下步骤完成首次集成：

1. 选择产品，阅读其介绍和接口要求，确认所需能力与账户资格。
2. 确认 [API 接口类型](/zh-CN/products/spot/QuickStart/InterfaceType)。公共行情接口无需认证；需要访问私有接口时，按[接入准备](/zh-CN/products/spot/QuickStart/IntegrationPreparation)创建 API Key 并配置权限。
3. 确认产品域名，阅读[签名](/zh-CN/products/spot/QuickStart/Signature)与[请求交互示例](/zh-CN/products/spot/QuickStart/RequestInteraction)，完成请求构造和时间戳校验。
4. 先验证公共接口，再在符合业务要求的账户与环境中验证私有接口、错误处理和限流行为。涉及交易的请求会影响账户，请控制验证范围。
5. 如需实时推送，阅读相应产品的 WebSocket 连接、订阅和心跳说明；上线前检查权限、重试策略及更新日志。

不同产品的密钥权限和接入流程可能不同。例如，跟单交易区分普通 API Key 与带单 API Key，Broker OAuth 还需要完成平台注册。请以对应产品文档为准。

## 你可以用 WEEX API 构建什么

结合各产品已提供的接口，你可以：

- 获取实时与历史行情，为图表、策略研究和分析系统提供数据。
- 以程序化方式下单、撤单、查询订单和成交记录。
- 查询账户余额、账单和合约仓位，构建账户监控与业务报表。
- 订阅 WebSocket 行情和私有账户事件，减少轮询并及时处理更新。
- 查询带单和跟单数据，管理跟单配置与仓位。
- 为经纪商和合伙人构建返佣查询、用户管理及业绩统计后台。
- 通过 OAuth 用户授权流程获取用于后续 API 调用的用户凭证。

具体操作范围、权限及参数以对应接口说明为准。

## API 类型

- **REST API**：基于 HTTP 的请求与响应接口，适用于行情查询、订单管理、账户操作以及经纪商、合伙人和跟单业务。
- **WebSocket 数据流**：基于持久连接推送行情和私有账户事件。现货和合约均提供公共、私有频道，并有各自的连接与订阅规则。

实时数据接入可从[现货 WebSocket 介绍](/zh-CN/products/spot/streams/websocket-intro)或[合约 WebSocket 介绍](/zh-CN/products/futures/streams/websocket-intro)开始，再查看对应的[现货数据流](/zh-CN/catalog/core-trading-spot/api/ws-streams/public)与[合约数据流](/zh-CN/catalog/core-trading-futures/api/ws-streams/public)。

## 鉴权与安全

公共行情与配置接口无需认证；私有交易和账户接口需要按产品要求提供 API Key 和请求签名。

现货与合约的签名文档说明了 HMAC-SHA256、Base64 编码以及时间戳、请求路径、查询参数和请求体的拼接规则。请保证参与签名的内容与实际发送的请求一致，并保持本地时间与服务时间同步。

- 妥善保管 API Key、Secret Key 和 Passphrase，避免在前端代码、日志或公共仓库中暴露凭证。
- 仅授予业务必需的读取、交易权限，并按接入指南配置 IP 绑定。
- Broker OAuth 有独立的客户端签名要求，请同时阅读 [OAuth 接入指南](/zh-CN/products/broker/oAuth)与[签名规则](/zh-CN/products/broker/sign)。

## 速率限制与可靠性

请求权重、频率限制和 WebSocket 连接限制因产品与接口而异。接入前请阅读对应限制说明，例如[现货访问限制](/zh-CN/products/spot/QuickStart/AccessRestrictions)。

生产系统应考虑：

- 按接口权重安排请求，监控响应中的限流信息。
- 收到限流响应时暂停请求并退避，避免连续重试。
- 对交易请求核对订单状态，防止重试造成重复操作。
- 按 WebSocket 文档处理订阅、心跳、断线重连和数据恢复。
- 记录 API 错误并监控连接状态，便于定位请求和服务异常。

## 域名与环境

REST 域名请查看[现货 API 域名](/zh-CN/products/spot/QuickStart/APIDomain)和[合约 API 域名](/zh-CN/products/futures/QuickStart/APIDomain)。WebSocket 地址请查看对应产品的连接说明。

各产品的 REST 与 WebSocket 域名分别配置。接入前请确认目标地址及其环境用途；本文档中的 REST 和 WebSocket 地址均为生产环境地址。请使用对应产品文档列出的地址，并在切换环境时重新确认凭证、权限与账户要求。

## Agent 原生

WEEX 提供静态文档文件，供 AI 编程助手、LLM 工具和 Agent 发现与加载 API 文档：

- **llms.txt**：包含文档标题、说明与链接的轻量索引。<a href="/zh-CN/llms.txt" target="_blank" rel="noopener noreferrer">打开中文文档索引</a>。
- **llms-full.txt**：将完整文档汇集到单个文件，便于加载上下文。<a href="/zh-CN/llms-full.txt" target="_blank" rel="noopener noreferrer">打开中文完整文档</a>。

使用方式与示例请查看 [Agent 原生概览](/zh-CN/agent-native/overview)。

## 调用示例与接口规范

[请求交互](/zh-CN/products/spot/QuickStart/RequestInteraction)提供签名和请求构造示例；API 参考中的各接口提供参数、响应结构及调用示例。开发时请结合接口说明核对实际请求。

请使用本门户已公开记录的接口、频道和参数。未记录的行为可能发生变化，不应作为生产集成的依赖。

## 产品级更新

API 变更、新功能和兼容性调整记录在对应产品的更新日志中：

- [现货更新日志](/zh-CN/products/spot/changelog)
- [合约更新日志](/zh-CN/products/futures/changelog)
- [跟单更新日志](/zh-CN/products/copy/changelog)
- [经纪商更新日志](/zh-CN/products/broker/changelog)
- [合伙人更新日志](/zh-CN/products/partner/changelog)

部署或升级集成前，请检查所依赖产品的最新文档，并关注[更新公告](/zh-CN/products/spot/introduction/UpdateFollow)。

## 获取帮助

遇到接入问题时，先核对接口参数、权限、签名和限流规则，并查看对应产品的示例及更新日志。

- 加入官方 [Telegram 群组](https://t.me/+7jac6zttXxZjOTRl)咨询接入或域名访问问题。
- 通过 [WEEX 帮助中心](https://weexsupport.zendesk.com/hc/zh-cn)查看公告与帮助信息。
- 关注 [WEEX 中文官方 X](https://x.com/WeexCn)获取官方动态。

文档会随产品与 API 更新持续完善。调整生产集成前，请重新确认对应产品的要求。