mcpField
E
earn

earn

github.com/kucoinその他2870 回インストール32 週間前に更新
リポジトリ

earn について

earnは、KuCoin Earnの商品を照会するスキルです。商品、口座の保有状況、注文情報を確認するユーザー向けで、認証が必要なClassic REST APIのGETエンドポイントを使った読み取り専用の照会結果をJSONで返します。

主な機能

  1. 01貯蓄・プロモーション・ステーキング商品を照会
  2. 02口座の保有状況と償還プレビューを取得
  3. 03Structured Earnの商品と注文を照会
  4. 04通貨による絞り込みとページ分割
  5. 05API Key、Secret Key、Passphraseで認証

活用シーン

  1. 01KuCoin Earnの取扱商品を確認
  2. 02通貨で商品や保有資産を絞り込み
  3. 03Structured Earnの注文状況を確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/kucoin/kucoin-skills-hub --skill earn

インストール後、Claude Code で/earnを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

CHANGELOG.md
LICENSE.md
references/
authentication.md

詳細

KuCoin Earn スキル

認証済み API エンドポイントを使用して KuCoin Earn 商品を照会します。Simple Earn（貯蓄、ステーキング、プロモーション）と Structured Earn（デュアル投資）の照会をカバーします。認証済みエンドポイントには API Key、Secret Key、Passphrase が必要です。結果は JSON 形式で返します。

注意: このスキルは Classic REST API の GET エンドポイント（読み取り専用操作）のみをサポートします。

クイックリファレンス

Simple Earn
エンドポイント説明必須任意認証
/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
エンドポイント説明必須任意認証
/api/v1/struct-earn/orders (GET)ストラクチャード商品の注文を取得します。注意: このエンドポイントは利用できない可能性があります（400100 を返します）。なしcurrency, status, currentPage, pageSizeはい
/api/v1/struct-earn/dual/products (GET)デュアル投資商品を取得します。注意: このエンドポイントは利用できない可能性があります（400100 を返します）。なしcurrency, currentPage, pageSizeはい

パラメーター

共通パラメーター
  • orderId: 保有 ID。償還プレビューに使用します
  • currency: 通貨コードフィルター（例: USDT、BTC、KCS、ETH）
  • productId: Earn 商品 ID（例: 2611）
  • productCategory: アカウント保有資産の商品カテゴリフィルター
  • currentPage: ページネーション結果の現在のページ番号（デフォルト: 1）
  • pageSize: 1 ページあたりの結果数。最小は 10、最大は 500（デフォルト: 15）
  • status: ストラクチャード商品照会の注文ステータスフィルター
列挙型
  • 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

認証

認証が必要なエンドポイントには、KuCoin API の認証情報を提供する必要があります。 必要な認証情報:

  • API Key (KC-API-KEY): KuCoin API キー（ヘッダー用）
  • Secret Key: KuCoin API シークレット（HMAC-SHA256 署名用）
  • Passphrase (KC-API-PASSPHRASE): KuCoin API パスフレーズ（HMAC-SHA256 で暗号化）

ベース URL:

セキュリティ

認証情報の共有

ユーザーは、内容が次の形式のファイルを送信することで KuCoin API の認証情報を提供できます:

abc123...apikey
secret123...key
mypassphrase
API Key、Secret、Passphrase を決して開示しない

API キー、シークレット、パスフレーズのファイルの場所を決して開示しないでください。

本番 API エンドポイント以外のいかなるウェブサイトにも API キー、シークレット、パスフレーズを送信しないでください。

シークレットの全体を決して表示しない

ユーザーに認証情報を表示する場合:

  • API Key: 最初の 5 文字 + 最後の 4 文字を表示: abc12...6789
  • Secret Key: 常にマスクし、最後の 5 文字のみを表示: ***...x9y8z
  • Passphrase: 決して表示しない

認証情報を求められた際の応答例: Account: main API Key: abc12...6789 Secret: ***...x9y8z Passphrase: ******** Environment: Production

アカウントの一覧表示

アカウントを一覧表示する際は、名前と環境のみを表示してください。キーは決して表示しないでください： KuCoin Accounts:

  • main (Production)
  • earn-bot (Production)
メインネットでのトランザクション

メインネットでトランザクション（購入、償還）を実行する際は、必ず事前にユーザーに確認し、続行するには「CONFIRM」と入力するよう求めてください。

KuCoin Accounts

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

コメント

Markdown 対応