Kucoinは国際的な多言語の暗号資産取引所です。KucoinのデータにアクセスするためのいくつかのAPIを提供しています。次のAPIがサポートされています。
Kucoin API には2種類のメソッドがあります：公開と非公開。公開メソッドは認証なしでアクセスでき、例として取引価格の取得があります。ユーザーデータに関する非公開メソッドには Kucoin API キーの使用が必要です。
特定のサーバーからチャネルメッセージにサブスクライブするには、クライアントサイドからサーバーにサブスクリプションメッセージを送信する必要があります。
サブスクリプションが成功すると、システムはあなたに ack メッセージを送信します。レスポンスが true に設定されているとき。
{
"id":"1545910660739",
"type":"ack"
}
トピックメッセージが生成されている間、システムはクライアント側に対応するメッセージを送信します。
以下のサブスクリプション/サブスクリプション解除メソッドがサポートされています。
| メソッド | パラメータ | 説明 |
| SubscribeSymbolTicker | 銘柄 | BBO の変更のプッシュを受け取るためにこのトピックをサブスクライブします。1秒以内に変更がない場合、プッシュされません。最新の BBO を100ms ごとにプッシュします。前回のデータから変更がない場合、プッシュされません。 |
| SubscribeAllSymbolsTicker | すべてのマーケットシンボルの BBO 変更のプッシュを受け取るためにこのトピックをサブスクライブしてください。 | |
| SubscribeSymbolSnapshot | 銘柄 | 単一のシンボルのスナップショットデータを取得するためにサブスクライブします。スナップショットデータは2秒間隔でプッシュされます。 |
| SubscribeMarketSnapshot | Market | このトピックをサブスクライブして、市場全体のスナップショットデータを取得します。スナップショットデータは2秒間隔でプッシュされます。 |
| SubscribeLevel2MarketData | 銘柄 | このトピックをサブスクライブすると Level2 の板情報データを取得できます。WebSocket サブスクリプションが成功すると、WebSocket 経由でプッシュされる増分変更データが送信されます。 |
| SubscribeLevel2_5BestAskBid | 銘柄 | システムは5件の最良の売値/買値注文データを返します。これは100ミリ秒ごとのスナップショットデータです（つまり、5件の最良の売値/買値注文データが100ミリ秒ごとにリアルタイムで返されます）。 |
| SubscribeLevel2_50BestAskBid | 銘柄 | システムは50件のベスト Ask/Bid 注文データを返します。これは100ミリ秒ごとのスナップショットデータです（つまり、50件のベスト Ask/Bid 注文データがリアルタイムで100ミリ秒ごとに返されます）。 |
| SubscribeKlines | 銘柄 | K ラインデータを取得するにはこのトピックにサブスクライブしてください。 |
| SubscribeMatchExecutionData | 銘柄 | このトピックにサブスクライブすると、Level 3 の一致イベントデータフローを取得します。約定された注文ごとに、システムは以下の形式で一致メッセージを送信します。 |
| SubscribeIndexPrice | 銘柄 | このトピックにサブスクライブしてマージン取引のインデックス価格を取得します。 |
| SubscribeMarkPrice | 銘柄 | 信用取引のマーク価格を取得するには、このトピックをサブスクライブしてください。 |
| SubscribeOrderBookChanged | 銘柄 | 信用取引のオーダーブックの変化を取得するには、このトピックをサブスクライブしてください。 |
| SubscribeLevel1 | 銘柄 | シンボルのレベル 1 最良気配値データをサブスクライブします。 |
ACK パラメータが True に設定されている場合、サブスクリプション/サブスクリプション解除が成功した後、クライアントはその旨のメッセージを受信します。
Kucoin アカウントから取得した有効な ApiKey が必要です。ApiKey、ApiSecret、Passphrase はクライアント API コンポーネントの Kucoin プロパティに設定する必要があります。
変化があるたびに次のデータがクライアントにプッシュされます。任意のメソッドをサブスクライブする必要はありません。有効な ApiKey が設定されていれば自動的に行われます。
| メソッド | 説明 |
| SubscribeTradeOrders | このトピックはお客様の注文のすべての変更イベントをプッシュします。 |
| SubscribeAccountBalance |
アカウント残高が変化したとき、このメッセージを受信します。メッセージには変化の詳細が含まれます。 |
| SubscribePositionStatus | ポジションステータスが変化すると、システムは変更イベントをプッシュします。 |
| SubscribeMarginTradeOrders | 注文がオーダーブックに入ると、システムはこのメッセージを貸し手にプッシュします。 |
| SubscribeStopOrder | システムがストップ注文を受け取ると、「open」タイプのメッセージを受信します。これは、この注文がシステムに入力され、トリガーされるのを待機していることを意味します。 |
| SubscribeTradeOrdersV2 | 強化された注文更新通知のためにトレード注文V2チャンネルにサブスクライブします。 |
| SubscribeCrossMarginPosition | クロスマージンポジションの更新にサブスクライブします。クロスマージンポジションが変化すると、システムが変更イベントをプッシュします。 |
| SubscribeIsolatedMarginPosition | 隔離マージンポジションの更新をサブスクライブします。隔離マージンポジションが変更されると、システムは変更イベントをプッシュします。 |
すべてのエンドポイントは JSON オブジェクトまたは配列を返します。
パブリック API エンドポイント
これらのエンドポイントには認証なしでアクセスできます。
汎用エンドポイント
| メソッド | パラメータ | 説明 |
| GetServiceStatus | Rest API への接続を確認し、サービスステータスを取得します。 | |
| GetServerTime | REST API への接続をテストして現在のサーバー時刻を取得します。 |
Market Data エンドポイント
| メソッド | パラメータ | 説明 |
| GetSymbolList | Market | 取引可能な通貨ペアの一覧を取得するには、このエンドポイントにリクエストします。取引シンボルの市場情報を取得する場合は |
| GetTicker | 銘柄 | このエンドポイントをリクエストしてレベル 1 のマーケットデータを取得します。返される値には、最良の買い値と数量、最良の売り値と数量、最終取引価格と最終取引数量が含まれます。 |
| GetAllTickers | マーケット内のすべての取引ペアのマーケットティッカーをリクエストします（24 時間取引量を含む）。 | |
| Get24hrStats | 銘柄 | このエンドポイントにリクエストして、過去 24 時間の指定されたティッカーの統計を取得してください。 |
| GetMarketList | このエンドポイントを介してリクエストし、取引市場全体のトランザクション通貨を取得します。 | |
| GetPartOrderBook20 | 銘柄 | このエンドポイントを介してリクエストし、シンボルのオープン注文のリストを取得します。レベル2のオーダーブックにはすべての買い気配と売り気配が含まれ（価格ごとに集約）、このレベルではアクティブな各価格に対して1つのサイズのみを返します（その価格に対して単一の注文しかないかのように）。システムはオーダーブックの20件のデータ（売り気配と買い気配のデータ）を返します。 |
| GetPartOrderBook100 | 銘柄 | このエンドポイントをリクエストして、シンボルのオープン注文リストを取得します。レベル 2 注文書にはすべての買い注文と売り注文が含まれます（価格ごとに集約）。このレベルでは、各アクティブな価格に対して 1 つのサイズのみが返されます（その価格に 1 つの注文しかない場合と同様）。システムは注文書のデータ（買い注文と売り注文のデータ）を 100 件返します。 |
| GetFullOrderBook | 銘柄 | このエンドポイントを通じてリクエストして、指定されたシンボルのオーダーブックを取得します。レベル2オーダーブックはすべての買い注文と売り注文を含みます（価格で集計）。このレベルは各価格に対して1つの集計サイズのみを返します（その価格に対して1つの注文のみがあるかのように）。このAPIはフルデプスのデータを返します。 |
| GetKLines | 銘柄 | 指定されたシンボルの Kライン（ローソク足）を取得するためにこのエンドポイントをリクエストしてください。データはリクエストされたタイプに基づいてグループ化されたバケットで返されます。 |
| GetCurrencies | このエンドポイントを使用して通貨リストを取得します。 | |
| GetCurrencyDetail | 通貨 | このエンドポイントにリクエストして指定された通貨の通貨詳細を取得します。 |
| GetFiatPrice | このエンドポイントにリクエストして指定された通貨の通貨詳細を取得します。 | |
| GetPartOrderBook1 | 銘柄 | このエンドポイントをリクエストして、シンボルのレベル 1 最良気配値（最良売買気配）を取得します。 |
プライベート API エンドポイント
サーバーによる認証を取得するために APIKey と APISecret が必要です。
User EndPoints
| メソッド | パラメータ | 説明 |
| GetAllSubAccounts | このインターフェースを通じてすべてのサブユーザーのユーザー情報を取得できます。 | |
| GetListAccounts | アカウントの一覧を取得します。 | |
| GetAccount | AccountId | 単一アカウントの情報。accountIdがわかっている場合にこのエンドポイントを使用してください。 |
| GetAccountBalanceSubAccount | SubUserId | このエンドポイントは subUserId で指定されたサブユーザーのアカウント情報を返します。 |
| InnerTransfer | この API エンドポイントは、アカウント間で内部的に資金を移動するために使用できます。ユーザーはメインアカウント、取引アカウント、クロスマージンアカウント、および分離マージンアカウント間で無料で資金を移動できます。メインアカウント、クロスマージンアカウント、および取引アカウントから先物アカウントへの資金移動はサポートされていますが、先物アカウントから他のアカウントへの資金移動はサポートされていません。 | |
| GetDepositAddresses | 通貨 | 通貨のデポジットアドレスを取得します。 |
| CreateDepositAddress | 通貨 | 通貨の新しい入金アドレスを作成します。 |
| GetDepositList | 入金履歴を取得します。 | |
| GetAccountLedgers | アカウント台帳のエントリを取得します。 | |
| GetTradeFees | シンボル | 指定したシンボルの取引手数料を取得します。 |
Withdraw EndPoints
| メソッド | パラメータ | 説明 |
| GetWithdrawalsList | 出金のリストを取得します。 | |
| GetHistoricalWithdrawalsList | KuCoin V1 の過去の出金一覧です。 | |
| GetWithdrawalsQuotas | 通貨 | 出金クォータを取得 |
| ApplyWithdraw | Currency, Address, Amount | Withdrawを作成する |
| CancelWithdraw | WithdrawalId | キャンセルできるのは、PROCESSINGステータスの出金要求のみです。 |
取引エンドポイント
| メソッド | パラメータ | 説明 |
| PlaceOrder | 2種類の注文を発注できます: 指値と成行。注文はアカウントに十分な資金がある場合にのみ発注できます。注文が発注されると、注文期間中アカウントの資金が保留されます。保留される資金の量と種類は、指定された注文タイプとパラメータによって異なります。 | |
| PlaceMarketOrder | 成行注文を発注します。 | |
| PlaceLimitOrder | 指値注文を発注します。 | |
| PlaceMarginOrder | マージン注文を発注します。 | |
| CancelOrder | 注文 ID で注文をキャンセルします。 | |
| CancelOrderByClientOid | クライアント注文 ID によって注文をキャンセルします。 | |
| CancelAllOrders | すべての未決注文をキャンセルします。 | |
| ListOrders | 現在の注文リストを取得するにはこのエンドポイントにリクエストしてください。アイテムはページ分割され、最新のものが最初に表示されるようにソートされています。 | |
| GetRecentOrders | このエンドポイントを通じて過去 24 時間の 1000 件の注文を取得するリクエストを行います。 | |
| GetOrder | このエンドポイントを介してリクエストし、order IDで単一の注文情報を取得します。 | |
| GetOrderByClientOid | このエンドポイントにリクエストして、クライアント注文 ID で単一の注文情報を取得してください。 | |
| ListFills | 最近の約定を取得するにはこのエンドポイントにリクエストしてください。 | |
| GetRecentFills | このエンドポイントを介してリクエストし、過去24時間の最大1000件の約定のリストを取得します。 | |
| PlaceStopOrder | ストップ注文を発注します。 | |
| PlaceStopMarketOrder | ストップマーケット注文を発注します。 | |
| PlaceStopLimitOrder | ストップリミット注文を発注します。 | |
| CancelStopOrder | 注文 ID でオープンストップ注文をキャンセルします。 | |
| CancelStopOrderByClientOid | クライアント注文 ID でオープンストップ注文をキャンセルします。 | |
| CancelAllStopOrders | すべてのストップ注文をキャンセル | |
| GetStopOrder | 注文 ID からストップ注文情報を取得するにはこのインターフェースにリクエストします。 | |
| GetStopOrderByClientOid | このインターフェイスを介してリクエストし、Client order IDでストップ注文情報を取得します。 | |
| ListStopOrders | このエンドポイントを介して要求すると、現在のトリガーされていないストップ注文の一覧を取得します。項目はページ分割され、最新のものが先頭に表示されるようにソートされます。 | |
| PlaceHFOrder | 高頻度注文を発注します。 | |
| CancelHFOrder | 注文 ID で高頻度注文をキャンセルします。 | |
| CancelHFOrderByClientOid | クライアント注文 ID で高頻度注文をキャンセルします。 | |
| CancelAllHFOrders | すべての高頻度注文をキャンセルします。 | |
| GetHFActiveOrders | アクティブな高頻度注文を取得します。 | |
| GetHFDoneOrders | 完了した高頻度注文を取得します。 | |
| GetHFOrder | 注文 ID で特定の高頻度注文を取得します。 |
Kucoin のメッセージは TsgcWebSocketClient コンポーネントで受信されます。以下のイベントを使用できます：
OnConnect
Kucoinサーバーへの接続が成功した後。
OnDisconnect
Kucoin サーバーからの切断後
OnMessage
サーバーからクライアントに送信されたメッセージは、このイベントで処理されます。
OnError
プロトコルにエラーがある場合、このイベントが呼び出されます。
OnException
未処理の例外がある場合、このイベントが呼び出されます。
さらに、Kucoin API コンポーネントには OnKucoinHTTPException という特定のイベントがあり、HTTP リクエスト（REST API または WebSocket フィード）の呼び出しでエラーが発生するたびに発生します。