broker

KuCoin Broker Skill

認証済み API エンドポイントを使用した KuCoin でのブローカーおよびアフィリエイト操作。アフィリエイトの招待/コミッション管理、Broker Pro のリベートとユーザークエリ、ND Exchange Broker のクエリ(KYC ステータス、サブアカウント情報、入金、出金、リベート)を扱います。すべてのエンドポイントで API Key、API Secret、Passphrase が必要です。結果は JSON 形式で返します。

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

クイックリファレンス

アフィリエイト

エンドポイント	説明	必須	オプション	認証
/api/v2/affiliate/queryInvitees (GET)	招待ユーザーの取得(取引統計付きの招待ユーザー一覧)	なし	userType, referralCode, uid, registrationStartAt, registrationEndAt, page, pageSize	はい
/api/v2/affiliate/queryMyCommission (GET)	コミッションの取得(アフィリエイトのコミッション記録)	なし	siteType, rebateType, rebateStartAt, rebateEndAt, page, pageSize, userId, dataType	はい
/api/v2/affiliate/queryTransactionByUid (GET)	取引履歴の取得(特定の招待ユーザーの取引記録)	uid	tradeType, tradeStartAt, tradeEndAt, page, pageSize	はい
/api/v2/affiliate/queryTransactionByTime (GET)	取引の取得(期間指定による取引記録)	tradeStartAt, tradeEndAt	uid, tradeType, lastId, direction, pageSize	はい
/api/v2/affiliate/queryKumining (GET)	KuMining の取得(KuMining コミッション記録)	なし	uid, startAt, endAt, lastId, direction, pageSize	はい

Broker Pro

エンドポイント	説明	必須	オプション	認証
/api/v2/broker/api/rebate/download (GET)	ブローカーリベートの取得(リベート注文ファイルのダウンロード)	begin, end, tradeType	なし	はい
/api/v2/broker/queryMyCommission (GET)	コミッションの取得(ブローカーのコミッション記録)	なし	siteType, tradeType, rebateType, startAt, endAt, page, pageSize	はい
/api/v2/broker/queryUser (GET)	ユーザー一覧の取得(ブローカーのサブユーザー)	なし	tradeType, uid, rcode, tag, startAt, endAt, page, pageSize	はい
/api/v2/broker/queryDetailByUid (GET)	ユーザー取引の取得(ユーザー UID ごとの取引記録)	なし	tradeType, uid, startAt, endAt, lastId, direction, pageSize	はい

ND Exchange Broker

⚠️ Note: 以下の ND Exchange Broker エンドポイント(/api/v1/broker/nd/* および /api/kyc/ndBroker/*)は、非推奨または移行済みである可能性があります。これらのエンドポイントは現在 404 Not Found を返します。ND Broker レベルの API 権限が必要です。更新されたパスについては、最新の KuCoin API ドキュメントを参照してください。

エンドポイント	説明	必須	オプション	認証
/api/kyc/ndBroker/proxyClient/status/list (GET)	KYC ステータスの取得(UID リスト指定)	clientUids	なし	はい
/api/kyc/ndBroker/proxyClient/status/page (GET)	KYC ステータス一覧の取得(ページネーション)	なし	pageNumber, pageSize	はい
/api/v1/broker/nd/info (GET)	ブローカー情報の取得(期間指定によるリベートのダウンロード)	begin, end, tradeType	なし	はい
/api/v1/broker/nd/account (GET)	サブアカウントの取得(サブアカウント一覧)	なし	uid, currentPage, pageSize	はい
/api/v1/broker/nd/account/apikey (GET)	サブアカウントの API Key の取得	uid	apiKey	はい
/api/v3/broker/nd/transfer/detail (GET)	振替履歴の取得	orderId	なし	はい
/api/v1/asset/ndbroker/deposit/list (GET)	入金一覧の取得(サブアカウントの入金)	なし	currency, status, hash, startTimestamp, endTimestamp, limit	はい
/api/v3/broker/nd/deposit/detail (GET)	入金詳細の取得	currency, hash	なし	はい
/api/v3/broker/nd/withdraw/detail (GET)	出金詳細の取得	withdrawalId	なし	はい
/api/v1/broker/nd/rebate/download (GET)	ブローカーリベートの取得(ND ブローカーのリベートダウンロード)	begin, end, tradeType	なし	はい

---

パラメーター

アフィリエイトパラメータ

• userType: 招待ユーザータイプ: 1 (通常)、2 (KYC 認証済み)、3 (初回取引)
• referralCode: ユーザーが登録した紹介コード (rcode)
• uid: 招待されたユーザーの UID (取引履歴の照会に使用)、またはカンマ区切りの UID
• registrationStartAt / registrationEndAt: 登録時間範囲 (13桁のタイムスタンプ)
• siteType: コミッション発生元サイト。デフォルト: all
• rebateType: リベートタイプ: 0 (すべて)、1 (現物)、2 (先物)
• rebateStartAt / rebateEndAt: コミッション発行時間範囲 (13桁のタイムスタンプ)。最長1年間
• tradeStartAt / tradeEndAt: 取引時間範囲 (13桁のタイムスタンプ)
• tradeType: 取引タイプ: SPOT | FEATURE
• dataType: データタイプ: trade | kumining
• startAt / endAt: 時間範囲フィルター (13桁のタイムスタンプ)
• lastId: カーソルベースのページネーション: 最初のクエリでは空文字列、以降は最後のレコードの lastId を使用
• direction: ページ方向: PRE | NEXT
• page / pageSize: ページネーション制御

Broker Pro パラメータ

• begin / end: YYYYMMDD 形式の日付範囲 (例: 20250101)。最大6か月間
• tradeType (Broker Pro): 取引タイプ: SPOT | FUTURE
• rcode: ユーザーがブローカー経由で登録した際に使用した紹介コード
• tag: ユーザーが取引時に使用したブローカータグ
• rebateType: 1 (現物リベート)、2 (先物リベート)、0 (すべて、コミッション照会用)

ND Broker パラメータ

• clientUids: KYC ステータス照会用のカンマ区切りのクライアント UID
• pageNumber / pageSize: KYC ステータス一覧のページネーション
• tradeType (ND Broker Rebate): 取引タイプ: 1 (現物)、2 (先物)
• uid: アカウントおよび API キー照会用のサブアカウント UID
• currentPage: 現在のページ番号 (デフォルト: 1)
• apiKey: サブアカウントの API キー (フィルターパラメータ)
• orderId: 振替履歴照会用の振替注文 ID
• currency: 入金一覧の通貨コードフィルター
• status (入金一覧): PROCESSING | SUCCESS | FAILURE
• hash: 入金一覧/詳細照会用のトランザクションハッシュ
• startTimestamp / endTimestamp: 入金一覧の時間範囲 (ミリ秒)
• limit: 返される入金項目の最大数 (デフォルトおよび最大: 1000)
• withdrawalId: 出金詳細照会用の出金 ID

列挙型

• userType: 1 | 2 | 3
• tradeType (アフィリエイト): SPOT | FEATURE
• tradeType (Broker Pro): all | SPOT | FUTURE
• tradeType (ND Broker Rebate): 1 (現物) | 2 (先物)
• rebateType: 0 | 1 | 2
• dataType: trade | kumining
• direction: PRE | NEXT
• status (KYC): NONE | PROCESS | PASS | REJECT
• status (入金): PROCESSING | SUCCESS | FAILURE

---

認証

すべてのエンドポイントで、Broker レベルの権限を持つ KuCoin API 認証情報を提供する必要があります。

必要な認証情報:

• API キー (KC-API-KEY): KuCoin Broker API キー
• API シークレット: KuCoin API シークレット (署名に使用)
• パスフレーズ (KC-API-PASSPHRASE): API パスフレーズ (HMAC-SHA256 暗号化)

ベース URL:

• 本番環境: https://api.kucoin.com

---

セキュリティ

認証情報の共有

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

your-api-key
your-api-secret
your-passphrase

API キーとシークレットを決して開示しない

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

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

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

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

• API キー: 最初の5文字 + 最後の4文字を表示: abcde...wxyz
• シークレットキー: 常にマスクし、最後の5文字のみ表示: ***...s3cr3
• パスフレーズ: 常に全体をマスク: ***...

認証情報を求められた際の応答例: Account: main API Key: abcde...wxyz Secret: ***...s3cr3 Passphrase: ***...

アカウントの一覧表示

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

• main (Production)
• broker-keys (Production)

本番環境でのトランザクション

データを変更する操作（送金、サブアカウントの作成、API キーの更新）を実行する場合は、必ず事前にユーザーに確認し、続行するには「CONFIRM」と入力するよう依頼してください。

---

KuCoin アカウント

main

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