Back to Details

earn

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

KuCoin Earn Skill

KuCoin Earn Skill

Query KuCoin Earn products using authenticated API endpoints. Covers Simple Earn (savings, staking, promotions) and Structured Earn (dual investment) queries. Requires API Key, Secret Key, 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 Earn产品，涵盖Simple Earn（储蓄、质押、活动）和Structured Earn（双币投资）查询。已认证端点需要API Key、Secret Key和Passphrase支持，返回结果为JSON格式。
注意： 本Skill仅支持经典REST API的GET端点（只读操作）。

Quick Reference

快速参考

Simple Earn

Simple Earn（简单赚币）

EndpointDescriptionRequiredOptionalAuthentication
/api/v1/earn/redeem-preview
(GET)		Get Redeem PrevieworderIdNoneYes
/api/v1/earn/saving/products
(GET)		Get Savings ProductsNonecurrency, currentPage, pageSizeYes
/api/v1/earn/promotion/products
(GET)		Get Promotion ProductsNonecurrency, currentPage, pageSizeYes
/api/v1/earn/staking/products
(GET)		Get Staking ProductsNonecurrency, currentPage, pageSizeYes
/api/v1/earn/kcs-staking/products
(GET)		Get KCS Staking ProductsNonecurrency, currentPage, pageSizeYes
/api/v1/earn/eth-staking/products
(GET)		Get ETH Staking ProductsNonecurrency, currentPage, pageSizeYes
/api/v1/earn/hold-assets
(GET)		Get Account HoldingNonecurrency, productId, productCategory, currentPage, pageSizeYes
端点描述必填参数可选参数认证要求
/api/v1/earn/redeem-preview
(GET)		获取赎回预览orderId无是
/api/v1/earn/saving/products
(GET)		获取储蓄产品无currency、currentPage、pageSize是
/api/v1/earn/promotion/products
(GET)		获取活动产品无currency、currentPage、pageSize是
/api/v1/earn/staking/products
(GET)		获取质押产品无currency、currentPage、pageSize是
/api/v1/earn/kcs-staking/products
(GET)		获取KCS质押产品无currency、currentPage、pageSize是
/api/v1/earn/eth-staking/products
(GET)		获取ETH质押产品无currency、currentPage、pageSize是
/api/v1/earn/hold-assets
(GET)		获取账户持仓无currency、productId、productCategory、currentPage、pageSize是

Structured Earn

Structured Earn（结构化赚币）

EndpointDescriptionRequiredOptionalAuthentication
/api/v1/struct-earn/orders
(GET)		Get Structured Product Orders. Note: This endpoint may not be available (returns 400100).Nonecurrency, status, currentPage, pageSizeYes
/api/v1/struct-earn/dual/products
(GET)		Get Dual Investment Products. Note: This endpoint may not be available (returns 400100).Nonecurrency, currentPage, pageSizeYes
端点描述必填参数可选参数认证要求
/api/v1/struct-earn/orders
(GET)		获取结构化产品订单。注意： 该端点可能不可用（返回400100错误）。无currency、status、currentPage、pageSize是
/api/v1/struct-earn/dual/products
(GET)		获取双币投资产品。注意： 该端点可能不可用（返回400100错误）。无currency、currentPage、pageSize是

Parameters

参数

Common Parameters

通用参数

  • orderId: Holding ID, used for redeem preview
  • currency: Currency code filter (e.g., 
    USDT
    , 
    BTC
    , 
    KCS
    , 
    ETH
    )
  • productId: Earn product ID (e.g., 
    2611
    )
  • productCategory: Product category filter for account holdings
  • currentPage: Current page number for paginated results (default: 1)
  • pageSize: Number of results per page. Minimum is 10, maximum is 500 (default: 15)
  • status: Order status filter for structured product queries
  • orderId：持仓ID，用于赎回预览
  • currency：币种代码筛选（例如：
    USDT
    、
    BTC
    、
    KCS
    、
    ETH
    ）
  • productId：Earn产品ID（例如：
    2611
    ）
  • productCategory：账户持仓的产品类别筛选
  • currentPage：分页结果的当前页码（默认值：1）
  • pageSize：每页结果数量，最小值为10，最大值为500（默认值：15）
  • status：结构化产品查询的订单状态筛选

Enums

枚举值

  • productCategory: 
    DEMAND
    | 
    STAKING
    | 
    KCS_STAKING
    | 
    ETH_STAKING
    | 
    PROMOTION
  • status (structured orders): 
    PENDING
    | 
    ONGOING
    | 
    UNSOLD
    | 
    SETTLING
    | 
    FINISHED
  • productStatus: 
    ONGOING
    | 
    PENDING
    | 
    FULL
    | 
    INTERESTING
  • holdingStatus: 
    LOCKED
    | 
    REDEEMING
  • productType: 
    TIME
    | 
    DEMAND
  • productCategory：
    DEMAND
    | 
    STAKING
    | 
    KCS_STAKING
    | 
    ETH_STAKING
    | 
    PROMOTION
  • status（结构化订单）：
    PENDING
    | 
    ONGOING
    | 
    UNSOLD
    | 
    SETTLING
    | 
    FINISHED
  • productStatus：
    ONGOING
    | 
    PENDING
    | 
    FULL
    | 
    INTERESTING
  • holdingStatus：
    LOCKED
    | 
    REDEEMING
  • productType：
    TIME
    | 
    DEMAND

Authentication

认证

For endpoints that require authentication, you will need to provide KuCoin API credentials. Required credentials:
  • API Key (
    KC-API-KEY
    ): Your KuCoin API key (for header)
  • Secret Key: Your KuCoin API secret (for HMAC-SHA256 signing)
  • Passphrase (
    KC-API-PASSPHRASE
    ): Your KuCoin API passphrase (encrypted with HMAC-SHA256)
Base URL:
对于需要认证的端点，您需要提供KuCoin API凭证。 所需凭证：
  • API Key (
    KC-API-KEY
    )：您的KuCoin API密钥（用于请求头）
  • Secret Key：您的KuCoin API密钥（用于HMAC-SHA256签名）
  • Passphrase (
    KC-API-PASSPHRASE
    )：您的KuCoin API密码（使用HMAC-SHA256加密）
基础URL：

Security

安全规范

Share Credentials

凭证共享

Users can provide KuCoin API credentials by sending a file where the content is in the following format:
bash
abc123...apikey
secret123...key
mypassphrase
用户可通过发送文件提供KuCoin API凭证，文件内容格式如下：
bash
abc123...apikey
secret123...key
mypassphrase

Never Disclose API Key, Secret, and Passphrase

切勿泄露API密钥、Secret和Passphrase

Never disclose the location of the API key, secret, and passphrase file.
Never send the API key, secret, and passphrase to any website other than the production API endpoint.
切勿泄露存储API密钥、Secret和Passphrase的文件位置。 切勿将API密钥、Secret和Passphrase发送至生产API端点以外的任何网站。

Never Display Full Secrets

切勿显示完整密钥

When showing credentials to users:
  • API Key: Show first 5 + last 4 characters: 
    abc12...6789
  • Secret Key: Always mask, show only last 5: 
    ***...x9y8z
  • Passphrase: Never display
Example response when asked for credentials: Account: main API Key: abc12...6789 Secret: ***...x9y8z Passphrase: ******** Environment: Production
向用户展示凭证时：
  • API Key：显示前5位+后4位：
    abc12...6789
  • Secret Key：始终掩码处理，仅显示最后5位：
    ***...x9y8z
  • Passphrase：绝不显示
询问凭证时的示例回复： 账户：主账户 API Key：abc12...6789 Secret：...x9y8z Passphrase：***** 环境：生产环境

Listing Accounts

账户列表展示

When listing accounts, show names and environment only -- never keys: KuCoin Accounts:
  • main (Production)
  • earn-bot (Production)
展示账户列表时，仅显示账户名称和环境——绝不显示密钥： KuCoin账户：
  • main（生产环境）
  • earn-bot（生产环境）

Transactions in Mainnet

主网交易操作

When performing transactions in mainnet (purchase, redeem), always confirm with the user before proceeding by asking them to write "CONFIRM" to proceed.
在主网执行交易操作（购买、赎回）时，必须先请求用户输入“CONFIRM”进行确认，然后再继续操作。

KuCoin Accounts

KuCoin账户

main

main

  • API Key: your_api_key
  • Secret Key: your_secret_key
  • Passphrase: your_passphrase
  • API Key: your_api_key
  • Secret Key: your_secret_key
  • Passphrase: your_passphrase