margin-trading

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

KuCoin Margin Trading Skill

KuCoin杠杆交易Skill

Margin trading on KuCoin using authenticated API endpoints. Supports cross margin and isolated margin market data, HF order queries, stop order queries, OCO order queries, borrow/repay history queries, lending queries, and risk limits. Requires API Key, API Secret, and Passphrase for authenticated endpoints. Return the result in JSON format.

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

通过已认证的API端点进行KuCoin杠杆交易。支持cross margin、isolated margin的市场数据查询、HF订单查询、stop order查询、OCO订单查询、借还历史查询、出借查询以及风险额度查询。已认证的端点需要API Key、API Secret和Passphrase。返回结果为JSON格式。

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

Quick Reference

快速参考

Classic Margin Market Data

Classic杠杆市场数据

Endpoint	Description	Required	Optional	Authentication
`/api/v3/margin/symbols` (GET)	Get Symbols - Cross Margin (trading pair config)	None	symbol	No
`/api/v1/isolated/symbols` (GET)	Get Symbols - Isolated Margin (trading pair config)	None	None	No
`/api/v3/etf/info` (GET)	Get ETF Info (leveraged token info)	None	currency	No
`/api/v1/margin/config` (GET)	Get Margin Config (cross margin config, currency list)	None	None	No
`/api/v3/mark-price/all-symbols` (GET)	Get Mark Price List (current mark price for all margin pairs)	None	None	No
`/api/v3/margin/collateralRatio` (GET)	Get Margin Collateral Ratio	None	currencyList	No
`/api/v3/margin/available-inventory` (GET)	Get Market Available Inventory (platform borrowable amount)	None	currency	No

端点	描述	必填参数	可选参数	认证要求
`/api/v3/margin/symbols` (GET)	获取交易对 - Cross Margin（交易对配置）	无	symbol	否
`/api/v1/isolated/symbols` (GET)	获取交易对 - Isolated Margin（交易对配置）	无	无	否
`/api/v3/etf/info` (GET)	获取ETF信息（杠杆代币信息）	无	currency	否
`/api/v1/margin/config` (GET)	获取杠杆配置（cross margin配置、币种列表）	无	无	否
`/api/v3/mark-price/all-symbols` (GET)	获取标记价格列表（所有杠杆交易对当前标记价格）	无	无	否
`/api/v3/margin/collateralRatio` (GET)	获取杠杆抵押率	无	currencyList	否
`/api/v3/margin/available-inventory` (GET)	获取市场可借额度（平台可出借金额）	无	currency	否

Classic Margin HF Order Queries

Classic杠杆HF订单查询

Endpoint	Description	Required	Optional	Authentication
`/api/v3/hf/margin/orders/{orderId}` (GET)	Get Order By OrderId	orderId (path), symbol (query)	None	Yes
`/api/v3/hf/margin/orders/client-order/{clientOid}` (GET)	Get Order By ClientOid	clientOid (path), symbol (query)	None	Yes
`/api/v3/hf/margin/order/active/symbols` (GET)	Get Symbols With Open Order	tradeType	None	Yes
`/api/v3/hf/margin/orders/active` (GET)	Get Open Orders	symbol, tradeType	None	Yes
`/api/v3/hf/margin/orders/done` (GET)	Get Closed Orders	symbol, tradeType	side, type, lastId, limit, startAt, endAt	Yes
`/api/v3/hf/margin/fills` (GET)	Get Trade History	symbol, tradeType	orderId, side, type, lastId, limit, startAt, endAt	Yes

端点	描述	必填参数	可选参数	认证要求
`/api/v3/hf/margin/orders/{orderId}` (GET)	通过orderId查询订单	orderId（路径参数）, symbol（查询参数）	无	是
`/api/v3/hf/margin/orders/client-order/{clientOid}` (GET)	通过clientOid查询订单	clientOid（路径参数）, symbol（查询参数）	无	是
`/api/v3/hf/margin/order/active/symbols` (GET)	获取存在未成交订单的交易对	tradeType	无	是
`/api/v3/hf/margin/orders/active` (GET)	获取未成交订单	symbol, tradeType	无	是
`/api/v3/hf/margin/orders/done` (GET)	获取已成交订单	symbol, tradeType	side, type, lastId, limit, startAt, endAt	是
`/api/v3/hf/margin/fills` (GET)	获取交易历史	symbol, tradeType	orderId, side, type, lastId, limit, startAt, endAt	是

Classic Margin Stop Order Queries

Classic杠杆Stop Order查询

Endpoint	Description	Required	Optional	Authentication
`/api/v3/hf/margin/stop-orders` (GET)	Get Stop Orders List (paginated, untriggered)	None	symbol, side, type, tradeType, startAt, endAt, currentPage, orderIds, pageSize, stop	Yes
`/api/v3/hf/margin/stop-order/orderId` (GET)	Get Stop Order By OrderId	orderId	None	Yes
`/api/v3/hf/margin/stop-order/clientOid` (GET)	Get Stop Order By ClientOid	clientOid	None	Yes

端点	描述	必填参数	可选参数	认证要求
`/api/v3/hf/margin/stop-orders` (GET)	获取止损订单列表（分页，未触发）	无	symbol, side, type, tradeType, startAt, endAt, currentPage, orderIds, pageSize, stop	是
`/api/v3/hf/margin/stop-order/orderId` (GET)	通过orderId查询止损订单	orderId	无	是
`/api/v3/hf/margin/stop-order/clientOid` (GET)	通过clientOid查询止损订单	clientOid	无	是

Classic Margin OCO Order Queries

Classic杠杆OCO订单查询

Endpoint	Description	Required	Optional	Authentication
`/api/v3/hf/margin/oco-order/orderId` (GET)	Get OCO Order By OrderId	orderId	None	Yes
`/api/v3/hf/margin/oco-order/clientOid` (GET)	Get OCO Order By ClientOid	clientOid	None	Yes
`/api/v3/hf/margin/oco-order/detail/orderId` (GET)	Get OCO Order Detail By OrderId (includes sub-orders)	orderId	None	Yes
`/api/v3/hf/margin/oco-orders` (GET)	Get OCO Order List (paginated)	pageSize, currentPage	symbol, startAt, endAt, orderIds, tradeType	Yes

端点	描述	必填参数	可选参数	认证要求
`/api/v3/hf/margin/oco-order/orderId` (GET)	通过orderId查询OCO订单	orderId	无	是
`/api/v3/hf/margin/oco-order/clientOid` (GET)	通过clientOid查询OCO订单	clientOid	无	是
`/api/v3/hf/margin/oco-order/detail/orderId` (GET)	通过orderId查询OCO订单详情（包含子订单）	orderId	无	是
`/api/v3/hf/margin/oco-orders` (GET)	获取OCO订单列表（分页）	pageSize, currentPage	symbol, startAt, endAt, orderIds, tradeType	是

Classic Debit Queries (Borrowing and Repaying)

Classic借还记录查询

Endpoint	Description	Required	Optional	Authentication
`/api/v3/margin/borrowRate` (GET)	Get Borrow Interest Rate	None	vipLevel, currency	Yes
`/api/v3/margin/borrow` (GET)	Get Borrow History	currency	isIsolated, symbol, orderNo, startTime, endTime, currentPage, pageSize	Yes
`/api/v3/margin/repay` (GET)	Get Repay History	currency	isIsolated, symbol, orderNo, startTime, endTime, currentPage, pageSize	Yes
`/api/v3/margin/interest` (GET)	Get Interest History	None	currency, isIsolated, symbol, startTime, endTime, currentPage, pageSize	Yes

端点	描述	必填参数	可选参数	认证要求
`/api/v3/margin/borrowRate` (GET)	获取借款利率	无	vipLevel, currency	是
`/api/v3/margin/borrow` (GET)	获取借款历史	currency	isIsolated, symbol, orderNo, startTime, endTime, currentPage, pageSize	是
`/api/v3/margin/repay` (GET)	获取还款历史	currency	isIsolated, symbol, orderNo, startTime, endTime, currentPage, pageSize	是
`/api/v3/margin/interest` (GET)	获取利息历史	无	currency, isIsolated, symbol, startTime, endTime, currentPage, pageSize	是

Classic Credit Queries (Lending)

Classic出借查询

Endpoint	Description	Required	Optional	Authentication
`/api/v3/project/list` (GET)	Get Loan Market (currencies available for lending)	None	currency	Yes
`/api/v3/project/marketInterestRate` (GET)	Get Loan Market Interest Rate (past 7 days)	currency	None	Yes
`/api/v3/purchase/orders` (GET)	Get Purchase Orders (paginated)	status	currency, purchaseOrderNo, currentPage, pageSize	Yes
`/api/v3/redeem/orders` (GET)	Get Redeem Orders (paginated)	status	currency, redeemOrderNo, currentPage, pageSize	Yes

端点	描述	必填参数	可选参数	认证要求
`/api/v3/project/list` (GET)	获取出借市场（可出借币种）	无	currency	是
`/api/v3/project/marketInterestRate` (GET)	获取出借市场利率（过去7天）	currency	无	是
`/api/v3/purchase/orders` (GET)	获取出借订单（分页）	status	currency, purchaseOrderNo, currentPage, pageSize	是
`/api/v3/redeem/orders` (GET)	获取赎回订单（分页）	status	currency, redeemOrderNo, currentPage, pageSize	是

Classic Risk Limit

Classic风险额度

Endpoint	Description	Required	Optional	Authentication
`/api/v3/margin/currencies` (GET)	Get Margin Risk Limit (config and risk limit info per currency/symbol)	None	isIsolated, currency, symbol	Yes

端点	描述	必填参数	可选参数	认证要求
`/api/v3/margin/currencies` (GET)	获取杠杆风险额度（各币种/交易对的配置及风险额度信息）	无	isIsolated, currency, symbol	是

Parameters

参数

Common Parameters

通用参数

clientOid: Client Order ID. Unique identifier created by the user (UUID recommended). Max length: 40 characters.
symbol: Trading pair symbol (e.g.,
```
BTC-USDT
```
)
side: Order side filter:
```
buy
```
|
```
sell
```
type: Order type filter:
```
limit
```
|
```
market
```
orderId: Order ID for query
isIsolated:
```
true
```
for isolated margin,
```
false
```
for cross margin. Default is
```
false
```
.
tradeType: Transaction type:
```
MARGIN_TRADE
```
(cross margin),
```
MARGIN_ISOLATED_TRADE
```
(isolated margin)
stop: Stop order trigger condition filter:
```
loss
```
|
```
entry
```
lastId: The ID of the last data set from the previous batch. Used for cursor-based pagination.
limit: Number of results per page. Default: 20, Max: 100 (for order/fill queries).
currentPage: Current page number for paginated queries. Default: 1.
pageSize: Page size for paginated queries. Varies by endpoint (typical default: 50, max: 500).
startAt / startTime: Start time filter in milliseconds.
endAt / endTime: End time filter in milliseconds.
currency: Currency code (e.g.,
```
BTC
```
,
```
USDT
```
).
vipLevel: VIP level. If empty, defaults to current user VIP level.
orderNo: Order number for borrow/repay history queries.
purchaseOrderNo: Purchase order ID for lending operations.
redeemOrderNo: Redeem order ID for redemption queries.
status: Order status filter. Values depend on endpoint (e.g.,
```
DONE
```
,
```
PENDING
```
).
currencyList: Comma-separated currency list for collateral ratio query.

clientOid: 客户端订单ID。用户创建的唯一标识符（推荐使用UUID）。最大长度：40字符。
symbol: 交易对符号（例如：
```
BTC-USDT
```
）
side: 订单方向筛选：
```
buy
```
|
```
sell
```
type: 订单类型筛选：
```
limit
```
|
```
market
```
orderId: 用于查询的订单ID
isIsolated:
```
true
```
表示isolated margin，
```
false
```
表示cross margin。默认值为
```
false
```
。
tradeType: 交易类型：
```
MARGIN_TRADE
```
（cross margin）、
```
MARGIN_ISOLATED_TRADE
```
（isolated margin）
stop: 止损订单触发条件筛选：
```
loss
```
|
```
entry
```
lastId: 上一批数据的最后一条ID，用于基于游标分页。
limit: 每页结果数量。默认值：20，最大值：100（订单/成交记录查询）。
currentPage: 分页查询的当前页码。默认值：1。
pageSize: 分页查询的每页大小。根据端点不同而变化（典型默认值：50，最大值：500）。
startAt / startTime: 开始时间筛选（毫秒级时间戳）。
endAt / endTime: 结束时间筛选（毫秒级时间戳）。
currency: 币种代码（例如：
```
BTC
```
、
```
USDT
```
）。
vipLevel: VIP等级。若为空，默认使用当前用户的VIP等级。
orderNo: 借还历史查询的订单号。
purchaseOrderNo: 出借操作的订单ID。
redeemOrderNo: 赎回查询的订单ID。
status: 订单状态筛选。取值根据端点而定（例如：
```
DONE
```
、
```
PENDING
```
）。
currencyList: 抵押率查询的币种列表（逗号分隔）。

Enums

枚举值

side:
```
buy
```
|
```
sell
```
type:
```
limit
```
|
```
market
```
tradeType:
```
MARGIN_TRADE
```
(cross margin) |
```
MARGIN_ISOLATED_TRADE
```
(isolated margin)
stop:
```
loss
```
|
```
entry
```
purchase/redeem status:
```
DONE
```
|
```
PENDING
```
OCO order status:
```
NEW
```
|
```
DONE
```
|
```
TRIGGERED
```
|
```
CANCELLED
```
stop order status:
```
NEW
```
|
```
TRIGGERED
```
liquidity:
```
taker
```
|
```
maker
```

side:
```
buy
```
|
```
sell
```
type:
```
limit
```
|
```
market
```
tradeType:
```
MARGIN_TRADE
```
（cross margin） |
```
MARGIN_ISOLATED_TRADE
```
（isolated margin）
stop:
```
loss
```
|
```
entry
```
出借/赎回状态:
```
DONE
```
|
```
PENDING
```
OCO订单状态:
```
NEW
```
|
```
DONE
```
|
```
TRIGGERED
```
|
```
CANCELLED
```
止损订单状态:
```
NEW
```
|
```
TRIGGERED
```
流动性:
```
taker
```
|
```
maker
```

Authentication

认证

For endpoints that require authentication, you will need to provide KuCoin API credentials. Required credentials:

API Key: Your KuCoin API key (for header
```
KC-API-KEY
```
)
API Secret: Your KuCoin API secret (for signing)
Passphrase: Your KuCoin API passphrase (for header
```
KC-API-PASSPHRASE
```
)

Base URL:

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

对于需要认证的端点，您需要提供KuCoin API凭证。所需凭证：

API Key: 您的KuCoin API密钥（用于请求头
```
KC-API-KEY
```
）
API Secret: 您的KuCoin API密钥（用于签名）
Passphrase: 您的KuCoin API密码（用于请求头
```
KC-API-PASSPHRASE
```
）

基础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

api_key_value
api_secret_value
api_passphrase_value

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

bash

api_key_value
api_secret_value
api_passphrase_value

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
```
API Secret: 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
```
API Secret: 始终隐藏，仅显示最后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)
margin-keys (Production)

展示账户时，仅显示名称与环境——绝不显示密钥： KuCoin账户:

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

Transactions in Production

生产环境交易

When performing transactions in production, always confirm with the user before proceeding by asking them to write "CONFIRM" to proceed.

在生产环境执行交易时，必须先让用户输入"CONFIRM"进行确认，再继续操作。