broker

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

KuCoin Broker Skill

KuCoin Broker 技能

Broker and Affiliate operations on KuCoin using authenticated API endpoints. Covers Affiliate invite/commission management, Broker Pro rebate and user queries, and ND Exchange Broker queries (KYC status, sub-account info, deposits, withdrawals, and rebates). Requires API Key, API Secret, and Passphrase for all endpoints. Return the result in JSON format.

Note: This skill only supports Classic REST API GET endpoints (read-only operations).

通过已认证的API端点在KuCoin上执行经纪商（Broker）与联盟营销（Affiliate）操作。涵盖联盟邀请/佣金管理、Broker Pro返佣与用户查询，以及ND交易所经纪商查询（KYC状态、子账户信息、充值、提现和返佣）。所有端点均需API Key、API Secret和Passphrase。返回结果为JSON格式。

注意： 本技能仅支持Classic REST API的GET端点（只读操作）。

Quick Reference

快速参考

Affiliate

联盟营销（Affiliate）

Endpoint	Description	Required	Optional	Authentication
`/api/v2/affiliate/queryInvitees` (GET)	Get Invited (list of invited users with trade stats)	None	userType, referralCode, uid, registrationStartAt, registrationEndAt, page, pageSize	Yes
`/api/v2/affiliate/queryMyCommission` (GET)	Get Commission (affiliate commission records)	None	siteType, rebateType, rebateStartAt, rebateEndAt, page, pageSize, userId, dataType	Yes
`/api/v2/affiliate/queryTransactionByUid` (GET)	Get Trade History (trade records for a specific invitee)	uid	tradeType, tradeStartAt, tradeEndAt, page, pageSize	Yes
`/api/v2/affiliate/queryTransactionByTime` (GET)	Get Transaction (trade records by time range)	tradeStartAt, tradeEndAt	uid, tradeType, lastId, direction, pageSize	Yes
`/api/v2/affiliate/queryKumining` (GET)	Get Kumining (KuMining commission records)	None	uid, startAt, endAt, lastId, direction, pageSize	Yes

端点	描述	必填参数	可选参数	认证要求
`/api/v2/affiliate/queryInvitees` (GET)	获取受邀用户列表（包含交易统计数据的受邀用户清单）	无	userType, referralCode, uid, registrationStartAt, registrationEndAt, page, pageSize	是
`/api/v2/affiliate/queryMyCommission` (GET)	获取佣金记录（联盟营销的佣金记录）	无	siteType, rebateType, rebateStartAt, rebateEndAt, page, pageSize, userId, dataType	是
`/api/v2/affiliate/queryTransactionByUid` (GET)	获取交易历史（特定受邀用户的交易记录）	uid	tradeType, tradeStartAt, tradeEndAt, page, pageSize	是
`/api/v2/affiliate/queryTransactionByTime` (GET)	获取交易记录（按时间范围查询交易记录）	tradeStartAt, tradeEndAt	uid, tradeType, lastId, direction, pageSize	是
`/api/v2/affiliate/queryKumining` (GET)	获取KuMining佣金记录	无	uid, startAt, endAt, lastId, direction, pageSize	是

Broker Pro

Endpoint	Description	Required	Optional	Authentication
`/api/v2/broker/api/rebate/download` (GET)	Get Broker Rebate (download rebate order file)	begin, end, tradeType	None	Yes
`/api/v2/broker/queryMyCommission` (GET)	Get Commission (broker commission records)	None	siteType, tradeType, rebateType, startAt, endAt, page, pageSize	Yes
`/api/v2/broker/queryUser` (GET)	Get User List (broker sub-users)	None	tradeType, uid, rcode, tag, startAt, endAt, page, pageSize	Yes
`/api/v2/broker/queryDetailByUid` (GET)	Get User Transactions (trade records per user UID)	None	tradeType, uid, startAt, endAt, lastId, direction, pageSize	Yes

端点	描述	必填参数	可选参数	认证要求
`/api/v2/broker/api/rebate/download` (GET)	获取经纪商返佣（下载返佣订单文件）	begin, end, tradeType	无	是
`/api/v2/broker/queryMyCommission` (GET)	获取佣金记录（经纪商的佣金记录）	无	siteType, tradeType, rebateType, startAt, endAt, page, pageSize	是
`/api/v2/broker/queryUser` (GET)	获取用户列表（经纪商的子用户）	无	tradeType, uid, rcode, tag, startAt, endAt, page, pageSize	是
`/api/v2/broker/queryDetailByUid` (GET)	获取用户交易记录（按用户UID查询交易记录）	无	tradeType, uid, startAt, endAt, lastId, direction, pageSize	是

ND Exchange Broker

ND交易所经纪商

⚠️ Note: The ND Exchange Broker endpoints below (
/api/v1/broker/nd/*
and
/api/kyc/ndBroker/*
) may have been deprecated or migrated. These endpoints currently return 404 Not Found. They require ND Broker-level API permissions. Please consult the latest KuCoin API documentation for updated paths.

Endpoint	Description	Required	Optional	Authentication
`/api/kyc/ndBroker/proxyClient/status/list` (GET)	Get KYC Status (by UID list)	clientUids	None	Yes
`/api/kyc/ndBroker/proxyClient/status/page` (GET)	Get KYC Status List (paginated)	None	pageNumber, pageSize	Yes
`/api/v1/broker/nd/info` (GET)	Get Broker Info (rebate download by date range)	begin, end, tradeType	None	Yes
`/api/v1/broker/nd/account` (GET)	Get Sub-Account (list sub-accounts)	None	uid, currentPage, pageSize	Yes
`/api/v1/broker/nd/account/apikey` (GET)	Get Sub-Account API Key	uid	apiKey	Yes
`/api/v3/broker/nd/transfer/detail` (GET)	Get Transfer History	orderId	None	Yes
`/api/v1/asset/ndbroker/deposit/list` (GET)	Get Deposit List (sub-account deposits)	None	currency, status, hash, startTimestamp, endTimestamp, limit	Yes
`/api/v3/broker/nd/deposit/detail` (GET)	Get Deposit Detail	currency, hash	None	Yes
`/api/v3/broker/nd/withdraw/detail` (GET)	Get Withdraw Detail	withdrawalId	None	Yes
`/api/v1/broker/nd/rebate/download` (GET)	Get Broker Rebate (ND broker rebate download)	begin, end, tradeType	None	Yes

⚠️ 注意： 以下ND交易所经纪商端点（
/api/v1/broker/nd/*
和
/api/kyc/ndBroker/*
）可能已被弃用或迁移。这些端点当前返回404 Not Found。它们需要ND经纪商级别的API权限。请查阅最新的KuCoin API文档获取更新后的路径。

端点	描述	必填参数	可选参数	认证要求
`/api/kyc/ndBroker/proxyClient/status/list` (GET)	获取KYC状态（按UID列表查询）	clientUids	无	是
`/api/kyc/ndBroker/proxyClient/status/page` (GET)	获取KYC状态列表（分页）	无	pageNumber, pageSize	是
`/api/v1/broker/nd/info` (GET)	获取经纪商信息（按日期范围下载返佣）	begin, end, tradeType	无	是
`/api/v1/broker/nd/account` (GET)	获取子账户（列出子账户）	无	uid, currentPage, pageSize	是
`/api/v1/broker/nd/account/apikey` (GET)	获取子账户API Key	uid	apiKey	是
`/api/v3/broker/nd/transfer/detail` (GET)	获取转账历史	orderId	无	是
`/api/v1/asset/ndbroker/deposit/list` (GET)	获取充值列表（子账户充值记录）	无	currency, status, hash, startTimestamp, endTimestamp, limit	是
`/api/v3/broker/nd/deposit/detail` (GET)	获取充值详情	currency, hash	无	是
`/api/v3/broker/nd/withdraw/detail` (GET)	获取提现详情	withdrawalId	无	是
`/api/v1/broker/nd/rebate/download` (GET)	获取经纪商返佣（ND经纪商返佣下载）	begin, end, tradeType	无	是

Parameters

参数

Affiliate Parameters

联盟营销参数

userType: Invited user type:
```
1
```
(Regular),
```
2
```
(KYC-verified),
```
3
```
(First-trade)
referralCode: The referral code (rcode) through which the user registered
uid: Invitee UID (for trade history query) or comma-separated UIDs
registrationStartAt / registrationEndAt: Registration time range (13-digit timestamp)
siteType: Commission source site. Default:
```
all
```
rebateType: Rebate type:
```
0
```
(all),
```
1
```
(spot),
```
2
```
(futures)
rebateStartAt / rebateEndAt: Commission issuance time range (13-digit timestamp); max one-year span
tradeStartAt / tradeEndAt: Trade time range (13-digit timestamp)
tradeType: Trading type:
```
SPOT
```
|
```
FEATURE
```
dataType: Data type:
```
trade
```
|
```
kumining
```
startAt / endAt: Time range filter (13-digit timestamp)
lastId: Cursor-based pagination: empty string for first query, then use
```
lastId
```
from last record
direction: Page direction:
```
PRE
```
|
```
NEXT
```
page / pageSize: Pagination controls

userType: 受邀用户类型：
```
1
```
（普通用户）、
```
2
```
（已完成KYC验证）、
```
3
```
（首次交易用户）
referralCode: 用户注册时使用的推荐码（rcode）
uid: 受邀用户UID（用于交易历史查询）或逗号分隔的UID列表
registrationStartAt / registrationEndAt: 注册时间范围（13位时间戳）
siteType: 佣金来源站点，默认值：
```
all
```
rebateType: 返佣类型：
```
0
```
（全部）、
```
1
```
（现货）、
```
2
```
（期货）
rebateStartAt / rebateEndAt: 佣金发放时间范围（13位时间戳）；最大跨度为1年
tradeStartAt / tradeEndAt: 交易时间范围（13位时间戳）
tradeType: 交易类型：
```
SPOT
```
|
```
FEATURE
```
dataType: 数据类型：
```
trade
```
|
```
kumining
```
startAt / endAt: 时间范围筛选（13位时间戳）
lastId: 基于游标分页：首次查询为空字符串，后续查询使用上一次结果中的
```
lastId
```
direction: 分页方向：
```
PRE
```
|
```
NEXT
```
page / pageSize: 分页控制参数

Broker Pro Parameters

Broker Pro参数

begin / end: Date range in
```
YYYYMMDD
```
format (e.g.,
```
20250101
```
); maximum 6-month interval
tradeType (Broker Pro): Transaction type:
```
SPOT
```
|
```
FUTURE
```
rcode: Referral code used when user registered with broker
tag: Broker tag used by the user during trading
rebateType:
```
1
```
(spot rebate),
```
2
```
(futures rebate),
```
0
```
(all; for commission query)

begin / end: 日期范围，格式为
```
YYYYMMDD
```
（例如：
```
20250101
```
）；最大间隔为6个月
tradeType（Broker Pro）: 交易类型：
```
SPOT
```
|
```
FUTURE
```
rcode: 用户注册经纪商时使用的推荐码
tag: 用户交易时使用的经纪商标签
rebateType:
```
1
```
（现货返佣）、
```
2
```
（期货返佣）、
```
0
```
（全部；用于佣金查询）

ND Broker Parameters

ND经纪商参数

clientUids: Comma-separated client UIDs for KYC status query
pageNumber / pageSize: Pagination for KYC status list
tradeType (ND Broker Rebate): Transaction type:
```
1
```
(spot),
```
2
```
(futures)
uid: Sub-account UID for account and API key queries
currentPage: Current page number (default: 1)
apiKey: Sub-account API key (filter parameter)
orderId: Transfer order ID for transfer history query
currency: Currency code filter for deposit list
status (Deposit List):
```
PROCESSING
```
|
```
SUCCESS
```
|
```
FAILURE
```
hash: Transaction hash for deposit list/detail query
startTimestamp / endTimestamp: Time range in milliseconds for deposit list
limit: Maximum number of returned deposit items (default and max: 1000)
withdrawalId: Withdrawal ID for withdraw detail query

clientUids: 用于KYC状态查询的逗号分隔客户端UID列表
pageNumber / pageSize: KYC状态列表的分页参数
tradeType（ND经纪商返佣）: 交易类型：
```
1
```
（现货）、
```
2
```
（期货）
uid: 用于账户和API Key查询的子账户UID
currentPage: 当前页码（默认值：1）
apiKey: 子账户API Key（筛选参数）
orderId: 用于转账历史查询的转账订单ID
currency: 充值列表的币种筛选
status（充值列表）:
```
PROCESSING
```
|
```
SUCCESS
```
|
```
FAILURE
```
hash: 用于充值列表/详情查询的交易哈希
startTimestamp / endTimestamp: 充值列表的时间范围（毫秒级时间戳）
limit: 充值记录返回的最大数量（默认值和最大值：1000）
withdrawalId: 用于提现详情查询的提现ID

Enums

枚举值

userType:
```
1
```
|
```
2
```
|
```
3
```
tradeType (Affiliate):
```
SPOT
```
|
```
FEATURE
```
tradeType (Broker Pro):
```
all
```
|
```
SPOT
```
|
```
FUTURE
```
tradeType (ND Broker Rebate):
```
1
```
(spot) |
```
2
```
(futures)
rebateType:
```
0
```
|
```
1
```
|
```
2
```
dataType:
```
trade
```
|
```
kumining
```
direction:
```
PRE
```
|
```
NEXT
```
status (KYC):
```
NONE
```
|
```
PROCESS
```
|
```
PASS
```
|
```
REJECT
```
status (Deposit):
```
PROCESSING
```
|
```
SUCCESS
```
|
```
FAILURE
```

userType:
```
1
```
|
```
2
```
|
```
3
```
tradeType（联盟营销）:
```
SPOT
```
|
```
FEATURE
```
tradeType（Broker Pro）:
```
all
```
|
```
SPOT
```
|
```
FUTURE
```
tradeType（ND经纪商返佣）:
```
1
```
（现货） |
```
2
```
（期货）
rebateType:
```
0
```
|
```
1
```
|
```
2
```
dataType:
```
trade
```
|
```
kumining
```
direction:
```
PRE
```
|
```
NEXT
```
status（KYC）:
```
NONE
```
|
```
PROCESS
```
|
```
PASS
```
|
```
REJECT
```
status（充值）:
```
PROCESSING
```
|
```
SUCCESS
```
|
```
FAILURE
```

Authentication

认证

For all endpoints, you must provide KuCoin API credentials with Broker-level permissions.

Required credentials:

API Key (
```
KC-API-KEY
```
): Your KuCoin Broker API key
API Secret: Your KuCoin API secret (used for signing)
Passphrase (
```
KC-API-PASSPHRASE
```
): Your API passphrase (HMAC-SHA256 encrypted)

Base URL:

Production:
```
https://api.kucoin.com
```

所有端点均需提供具备经纪商级别权限的KuCoin API凭证。

必填凭证：

API Key (
```
KC-API-KEY
```
): 您的KuCoin经纪商API密钥
API Secret: 您的KuCoin API密钥（用于签名）
Passphrase (
```
KC-API-PASSPHRASE
```
): 您的API密码（经过HMAC-SHA256加密）

基础URL：

生产环境:
```
https://api.kucoin.com
```

Security

安全

Share Credentials

共享凭证

Users can provide KuCoin API credentials by sending a file where the content is in the following format:

bash

your-api-key
your-api-secret
your-passphrase

用户可通过发送文件提供KuCoin API凭证，文件内容格式如下：

bash

your-api-key
your-api-secret
your-passphrase

Never Disclose API Key and Secret

切勿泄露API密钥与密码

Never disclose the location of the API key, secret, or passphrase file.

Never send the API key, secret, or passphrase to any website other than the official KuCoin API endpoint.

切勿泄露API密钥、密码或凭证文件的存储位置。切勿将API密钥、密码或密码发送至KuCoin官方API端点以外的任何网站。

Never Display Full Secrets

切勿显示完整密钥

When showing credentials to users:

API Key: Show first 5 + last 4 characters:
```
abcde...wxyz
```
Secret Key: Always mask, show only last 5:
```
***...s3cr3
```
Passphrase: Always mask entirely:
```
***...
```

Example response when asked for credentials: Account: main API Key: abcde...wxyz Secret: ***...s3cr3 Passphrase: ***...

向用户展示凭证时：

API Key: 显示前5位+后4位：
```
abcde...wxyz
```
Secret Key: 始终掩码，仅显示最后5位：
```
***...s3cr3
```
Passphrase: 始终完全掩码：
```
***...
```

询问凭证时的示例回复：账户: main API Key: abcde...wxyz Secret: ***...s3cr3 Passphrase: ***...

Listing Accounts

账户列表展示

When listing accounts, show names and environment only -- never keys: KuCoin Accounts:

main (Production)
broker-keys (Production)

展示账户时，仅显示名称和环境——切勿显示密钥： KuCoin账户:

main（生产环境）
broker-keys（生产环境）

Transactions in Production

生产环境中的交易操作

When performing operations that modify data (transfers, creating sub-accounts, updating API keys), always confirm with the user before proceeding by asking them to write "CONFIRM" to proceed.

执行修改数据的操作（转账、创建子账户、更新API密钥）时，必须先让用户输入“CONFIRM”进行确认，然后再执行。