Back to Details

kucoin-openapi-skill

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

KuCoin Unified API Skill

KuCoin 统一API Skill

Use this skill to run KuCoin public market-data operations through 
uxc
+ OpenAPI.
Reuse the 
uxc
skill for shared execution, auth, and error-handling guidance.
使用本Skill通过
uxc
+ OpenAPI执行KuCoin公开市场数据操作。
复用
uxc
Skill以获取共享执行、认证和错误处理指引。

Prerequisites

前提条件

  • uxc
    is installed and available in 
    PATH
    .
  • Network access to 
    https://api.kucoin.com
    .
  • Access to the curated OpenAPI schema URL: 
    • https://raw.githubusercontent.com/holon-run/uxc/main/skills/kucoin-openapi-skill/references/kucoin-public.openapi.json
  • 已安装
    uxc
    且其可在
    PATH
    中访问。
  • 可访问
    https://api.kucoin.com
    的网络权限。
  • 可访问经过精选的OpenAPI Schema URL： 
    • https://raw.githubusercontent.com/holon-run/uxc/main/skills/kucoin-openapi-skill/references/kucoin-public.openapi.json

Scope

适用范围

This skill covers a curated KuCoin public market surface for:
  • symbol discovery
  • all tickers
  • order book snapshots
  • candlestick reads
This skill does not cover:
  • private account or order endpoints in v1
  • websocket, margin, or broader platform products
本Skill涵盖经过精选的KuCoin公开市场场景，支持：
  • 交易对发现
  • 全部行情数据
  • 订单簿快照
  • K线数据查询
本Skill不支持：
  • v1版本中的私有账户或订单接口
  • WebSocket、杠杆或更广泛的平台产品

Authentication

认证方式

Public market endpoints in this skill do not require credentials.
KuCoin private REST auth uses provider-specific headers and signing rules including passphrase handling. Keep this v1 skill public-data-only until a reusable KuCoin signer flow exists in 
uxc
.
本Skill中的公开市场接口无需凭证。
KuCoin私有REST认证使用特定于服务商的请求头和签名规则，包括密码短语处理。在
uxc
中实现可复用的KuCoin签名流程之前，本v1版本Skill仅支持公开数据操作。

Core Workflow

核心工作流程

  1. Use the fixed link command by default:
    • command -v kucoin-openapi-cli
    • If missing, create it: 
      uxc link kucoin-openapi-cli https://api.kucoin.com --schema-url https://raw.githubusercontent.com/holon-run/uxc/main/skills/kucoin-openapi-skill/references/kucoin-public.openapi.json
    • kucoin-openapi-cli -h
  2. Inspect operation help before execution:
    • kucoin-openapi-cli get:/api/v1/symbols -h
    • kucoin-openapi-cli get:/api/v1/market/allTickers -h
  3. Prefer narrow symbol reads first:
    • kucoin-openapi-cli get:/api/v1/market/orderbook/level2_20 symbol=BTC-USDT
    • kucoin-openapi-cli get:/api/v1/market/candles symbol=BTC-USDT type=1hour
  1. 默认使用固定链接命令：
    • command -v kucoin-openapi-cli
    • 若不存在，则创建： 
      uxc link kucoin-openapi-cli https://api.kucoin.com --schema-url https://raw.githubusercontent.com/holon-run/uxc/main/skills/kucoin-openapi-skill/references/kucoin-public.openapi.json
    • kucoin-openapi-cli -h
  2. 执行前查看操作帮助：
    • kucoin-openapi-cli get:/api/v1/symbols -h
    • kucoin-openapi-cli get:/api/v1/market/allTickers -h
  3. 优先选择特定交易对查询：
    • kucoin-openapi-cli get:/api/v1/market/orderbook/level2_20 symbol=BTC-USDT
    • kucoin-openapi-cli get:/api/v1/market/candles symbol=BTC-USDT type=1hour

Operations

支持的操作

  • get:/api/v1/symbols
  • get:/api/v1/market/allTickers
  • get:/api/v1/market/orderbook/level2_20
  • get:/api/v1/market/candles
  • get:/api/v1/symbols
  • get:/api/v1/market/allTickers
  • get:/api/v1/market/orderbook/level2_20
  • get:/api/v1/market/candles

Guardrails

注意事项

  • Keep automation on the JSON output envelope; do not use 
    --text
    .
  • Parse stable fields first: 
    ok
    , 
    kind
    , 
    protocol
    , 
    data
    , 
    error
    .
  • Treat this v1 skill as read-only.
  • KuCoin symbols use dash-separated names such as 
    BTC-USDT
    .
  • kucoin-openapi-cli <operation> ...
    is equivalent to 
    uxc https://api.kucoin.com --schema-url <kucoin_public_openapi_schema> <operation> ...
    .
  • 自动化操作请基于JSON输出格式，不要使用
    --text
    参数。
  • 优先解析稳定字段：
    ok
    、
    kind
    、
    protocol
    、
    data
    、
    error
    。
  • 将本v1版本Skill视为只读工具。
  • KuCoin交易对使用短横线分隔命名，例如
    BTC-USDT
    。
  • kucoin-openapi-cli <operation> ...
    等同于 
    uxc https://api.kucoin.com --schema-url <kucoin_public_openapi_schema> <operation> ...
    。

References

参考资料