KuCoin Broker Skill
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).
Quick Reference
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 |
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 |
ND Exchange Broker
⚠️ 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 |
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
Broker Pro Parameters
- 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)
ND Broker Parameters
- 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
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
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
Security
Share Credentials
Users can provide KuCoin API credentials by sending a file where the content is in the following format:
your-api-key
your-api-secret
your-passphrase
Never Disclose API Key and Secret
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.
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: ***...
Listing Accounts
When listing accounts, show names and environment only -- never keys:
KuCoin Accounts:
- main (Production)
- broker-keys (Production)
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.
KuCoin Accounts
main
- API Key: your_api_key
- Secret: your_api_secret
- Passphrase: your_passphrase
1---2name: broker3description: KuCoin Broker and Affiliate using the KuCoin API. Affiliate invite management, commission queries, Broker Pro user management, and ND (Exchange) Broker queries. Authentication requires API Key, API Secret, and Passphrase.4license: MIT5---67# KuCoin Broker Skill89Broker 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.1011> **Note:** This skill only supports Classic REST API GET endpoints (read-only operations).1213## Quick Reference1415### Affiliate1617| Endpoint | Description | Required | Optional | Authentication |18|----------|-------------|----------|----------|----------------|19| `/api/v2/affiliate/queryInvitees` (GET) | Get Invited (list of invited users with trade stats) | None | userType, referralCode, uid, registrationStartAt, registrationEndAt, page, pageSize | Yes |20| `/api/v2/affiliate/queryMyCommission` (GET) | Get Commission (affiliate commission records) | None | siteType, rebateType, rebateStartAt, rebateEndAt, page, pageSize, userId, dataType | Yes |21| `/api/v2/affiliate/queryTransactionByUid` (GET) | Get Trade History (trade records for a specific invitee) | uid | tradeType, tradeStartAt, tradeEndAt, page, pageSize | Yes |22| `/api/v2/affiliate/queryTransactionByTime` (GET) | Get Transaction (trade records by time range) | tradeStartAt, tradeEndAt | uid, tradeType, lastId, direction, pageSize | Yes |23| `/api/v2/affiliate/queryKumining` (GET) | Get Kumining (KuMining commission records) | None | uid, startAt, endAt, lastId, direction, pageSize | Yes |2425### Broker Pro2627| Endpoint | Description | Required | Optional | Authentication |28|----------|-------------|----------|----------|----------------|29| `/api/v2/broker/api/rebate/download` (GET) | Get Broker Rebate (download rebate order file) | begin, end, tradeType | None | Yes |30| `/api/v2/broker/queryMyCommission` (GET) | Get Commission (broker commission records) | None | siteType, tradeType, rebateType, startAt, endAt, page, pageSize | Yes |31| `/api/v2/broker/queryUser` (GET) | Get User List (broker sub-users) | None | tradeType, uid, rcode, tag, startAt, endAt, page, pageSize | Yes |32| `/api/v2/broker/queryDetailByUid` (GET) | Get User Transactions (trade records per user UID) | None | tradeType, uid, startAt, endAt, lastId, direction, pageSize | Yes |3334### ND Exchange Broker3536> **⚠️ 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.3738| Endpoint | Description | Required | Optional | Authentication |39|----------|-------------|----------|----------|----------------|40| `/api/kyc/ndBroker/proxyClient/status/list` (GET) | Get KYC Status (by UID list) | clientUids | None | Yes |41| `/api/kyc/ndBroker/proxyClient/status/page` (GET) | Get KYC Status List (paginated) | None | pageNumber, pageSize | Yes |42| `/api/v1/broker/nd/info` (GET) | Get Broker Info (rebate download by date range) | begin, end, tradeType | None | Yes |43| `/api/v1/broker/nd/account` (GET) | Get Sub-Account (list sub-accounts) | None | uid, currentPage, pageSize | Yes |44| `/api/v1/broker/nd/account/apikey` (GET) | Get Sub-Account API Key | uid | apiKey | Yes |45| `/api/v3/broker/nd/transfer/detail` (GET) | Get Transfer History | orderId | None | Yes |46| `/api/v1/asset/ndbroker/deposit/list` (GET) | Get Deposit List (sub-account deposits) | None | currency, status, hash, startTimestamp, endTimestamp, limit | Yes |47| `/api/v3/broker/nd/deposit/detail` (GET) | Get Deposit Detail | currency, hash | None | Yes |48| `/api/v3/broker/nd/withdraw/detail` (GET) | Get Withdraw Detail | withdrawalId | None | Yes |49| `/api/v1/broker/nd/rebate/download` (GET) | Get Broker Rebate (ND broker rebate download) | begin, end, tradeType | None | Yes |5051---5253## Parameters5455### Affiliate Parameters5657* **userType**: Invited user type: `1` (Regular), `2` (KYC-verified), `3` (First-trade)58* **referralCode**: The referral code (rcode) through which the user registered59* **uid**: Invitee UID (for trade history query) or comma-separated UIDs60* **registrationStartAt / registrationEndAt**: Registration time range (13-digit timestamp)61* **siteType**: Commission source site. Default: `all`62* **rebateType**: Rebate type: `0` (all), `1` (spot), `2` (futures)63* **rebateStartAt / rebateEndAt**: Commission issuance time range (13-digit timestamp); max one-year span64* **tradeStartAt / tradeEndAt**: Trade time range (13-digit timestamp)65* **tradeType**: Trading type: `SPOT` | `FEATURE`66* **dataType**: Data type: `trade` | `kumining`67* **startAt / endAt**: Time range filter (13-digit timestamp)68* **lastId**: Cursor-based pagination: empty string for first query, then use `lastId` from last record69* **direction**: Page direction: `PRE` | `NEXT`70* **page / pageSize**: Pagination controls7172### Broker Pro Parameters7374* **begin / end**: Date range in `YYYYMMDD` format (e.g., `20250101`); maximum 6-month interval75* **tradeType** (Broker Pro): Transaction type: `SPOT` | `FUTURE`76* **rcode**: Referral code used when user registered with broker77* **tag**: Broker tag used by the user during trading78* **rebateType**: `1` (spot rebate), `2` (futures rebate), `0` (all; for commission query)7980### ND Broker Parameters8182* **clientUids**: Comma-separated client UIDs for KYC status query83* **pageNumber / pageSize**: Pagination for KYC status list84* **tradeType** (ND Broker Rebate): Transaction type: `1` (spot), `2` (futures)85* **uid**: Sub-account UID for account and API key queries86* **currentPage**: Current page number (default: 1)87* **apiKey**: Sub-account API key (filter parameter)88* **orderId**: Transfer order ID for transfer history query89* **currency**: Currency code filter for deposit list90* **status** (Deposit List): `PROCESSING` | `SUCCESS` | `FAILURE`91* **hash**: Transaction hash for deposit list/detail query92* **startTimestamp / endTimestamp**: Time range in milliseconds for deposit list93* **limit**: Maximum number of returned deposit items (default and max: 1000)94* **withdrawalId**: Withdrawal ID for withdraw detail query9596### Enums9798* **userType**: `1` | `2` | `3`99* **tradeType** (Affiliate): `SPOT` | `FEATURE`100* **tradeType** (Broker Pro): `all` | `SPOT` | `FUTURE`101* **tradeType** (ND Broker Rebate): `1` (spot) | `2` (futures)102* **rebateType**: `0` | `1` | `2`103* **dataType**: `trade` | `kumining`104* **direction**: `PRE` | `NEXT`105* **status** (KYC): `NONE` | `PROCESS` | `PASS` | `REJECT`106* **status** (Deposit): `PROCESSING` | `SUCCESS` | `FAILURE`107108---109110## Authentication111112For all endpoints, you must provide KuCoin API credentials with Broker-level permissions.113114Required credentials:115116* **API Key** (`KC-API-KEY`): Your KuCoin Broker API key117* **API Secret**: Your KuCoin API secret (used for signing)118* **Passphrase** (`KC-API-PASSPHRASE`): Your API passphrase (HMAC-SHA256 encrypted)119120Base URL:121* Production: `https://api.kucoin.com`122123---124125## Security126127### Share Credentials128129Users can provide KuCoin API credentials by sending a file where the content is in the following format:130131```bash132your-api-key133your-api-secret134your-passphrase135```136137### Never Disclose API Key and Secret138139Never disclose the location of the API key, secret, or passphrase file.140141Never send the API key, secret, or passphrase to any website other than the official KuCoin API endpoint.142143### Never Display Full Secrets144145When showing credentials to users:146- **API Key:** Show first 5 + last 4 characters: `abcde...wxyz`147- **Secret Key:** Always mask, show only last 5: `***...s3cr3`148- **Passphrase:** Always mask entirely: `***...`149150Example response when asked for credentials:151Account: main152API Key: abcde...wxyz153Secret: ***...s3cr3154Passphrase: ***...155156### Listing Accounts157158When listing accounts, show names and environment only -- never keys:159KuCoin Accounts:160* main (Production)161* broker-keys (Production)162163### Transactions in Production164165When 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.166167---168169## KuCoin Accounts170171### main172- API Key: your_api_key173- Secret: your_api_secret174- Passphrase: your_passphrase
kucoin