# 简介

欢迎使用WEEX经纪商API！本文档是专为经纪商量身定制的API文档，帮助您快速接入WEEX交易平台， 实现自动化交易、用户管理和返佣结算。API功能将持续更新，请大家保持关注。

通过本文档，您将了解：
- 如何获取和配置经纪商ID
- 如何校验用户返佣资格
- 如何在下单时绑定经纪商ID
- 如何查询返佣数据和用户列表

## 接入准备

### 前置准备

拥有WEEX官网的账号，并已加入WEEX合伙人计划。

### API密钥

- 登录WEEX官网，进入【API管理】页面
- 创建API密钥，权限配置：
    - 只读
    - 现货交易
    - 合约交易
- 妥善保管API Secret，切勿泄露

### 申请流程

#### 提交申请：
访问WEEX官网，填写经纪商入驻[申请表](https://dsg39hlwl5ui.sg.larksuite.com/share/base/form/shrlgfwZgKPs8ydoQHdIQ455oub)

#### 资质审核：
WEEX商务团队将在3个工作日内完成审核

#### 获取凭证：
- 审核通过后，您将收到包含以下信息的邮件：
- 唯一经纪商ID（格式：WEEX + 6位数字，示例：WEEX123456）
- 初始返佣比例配置
- API接入文档链接
- 技术支持群邀请


## 校验用户返佣资格

更多细节请参考[获取用户返佣资格（仅支持经纪商查询）](/zh-CN/products/broker/api/CheckUserEligibility)。

## 下单绑定经纪商

### 现货下单

现货下单的接口结构与[现货下单 (TRADE)](/zh-CN/products/spot/orderApi/PlaceOrder) 保持一致，可在下单时按需附带经纪商ID。

**格式要求：** <br/>
newClientOrderId字段必须以 `b-{brokerId}` 开头 <br/>
示例：`b-WEEX123456-20260319001`      <br/>
总长度 ≤ 64个字符                   <br/>
### 合约下单

合约下单的请求与[下单 (TRADE)](/zh-CN/products/futures/Transaction_API/PlaceOrder) 相同，额外需求可通过自定义字段实现经纪商ID的绑定。

**格式要求：** <br/>
newClientOrderId字段必须以 `b-{brokerId}` 开头 <br/>
示例：`b-WEEX123456-20260319001`      <br/>
总长度 ≤ 64个字符                   <br/>

## 返佣查询接口

- [获取经纪商返佣数据（仅支持经纪商查询）](/zh-CN/products/broker/api/GetBrokerCommissionRecords)
- [获取经纪商返佣比例（仅支持经纪商查询）](/zh-CN/products/broker/api/GetBrokerRebateRatio)

## 经纪商限频率规则
   对REST API的访问有频率限制，当超出限制时，返回状态429：请求过于频繁。

- 限频说明
  需要携带APIKey进行访问的接口，以账号UID作为限速的基本单位；不需要携带APIKey进行访问的接口，以IP作为限速的基本单位。
  每个接口会标明是按照IP或者按照UID统计, 以及相应请求一次的权重值。不同接口拥有不同的权重，越消耗资源的接口权重就会越大。
  按IP和按UID两种模式分别统计, 两者互相独立。按IP权重限频的接口，所有接口共用500权重/10秒；按UID权重限频的接口，所有接口共用500权重/10秒。
- 超频报错
  收到429时，请停止发送请求，不得滥用API。