API Coinbase

Coinbase

 

サポートされている API

 

 

最も一般的な使用方法

 

WebSockets API

WebSocketフィードは公開されており、注文と取引のリアルタイムマーケットデータ更新を提供します。本番環境では2つのエンドポイントがサポートされています。

 

 

以下のチャンネルをサブスクライブできます:

 

メソッド Arguments 説明
SubscribeHeartBeat   すべての接続を開いたままにするためのリアルタイムサーバーPing
SubscribeStatus aProductId: 製品の ID すべての製品と通貨をプリセット間隔で送信します。
SubscribeCandles aProductId: 製品の ID 製品ローソク足のリアルタイム更新
SubscribeTicker aProductId: 製品の ID マッチが発生するたびにリアルタイムで価格が更新されます
SubscribeTickerBatch aProductId: 製品の ID 5000 ミリ秒ごとのリアルタイム価格更新
SubscribeLevel2 aProductId: 製品の ID オーダーブックスナップショットを維持するすべての更新と最も簡単な方法
SubscribeMarketTrades aProductId: 製品の ID 市場での取引が発生するたびにリアルタイム更新
SubscribeUser aProductId: 製品の ID 認証済みユーザーを含むメッセージのみを送信します
SubscribeFuturesBalanceSummary   ユーザーの先物残高が変わるたびにリアルタイム更新

 

User および FuturesBalanceSummary チャンネルには認証が必要です。まず Coinbase アカウントで API キーをリクエストし、コンポーネントのプロパティ Coinbase に値を設定してください。

 

 

認証を行うことで、いくつかのメリットが得られます。

  1. あなたが当事者の 1 つであるメッセージは展開されており、より有用なフィールドを持っています
  2. 発注したストップ注文のライフサイクル情報など、プライベートメッセージを受信します。

 

 

 

REST API

Private Endpoints

プライベートエンドポイントは、注文管理とアカウント管理に利用できます。

リクエストに署名する前に、Coinbase Pro の Web サイトで API キーを作成する必要があります。API キーは特定のプロファイルにスコープされます。キーの作成時に、以下の 3 つの情報を記録しておく必要があります:

 

 

キーとシークレットは Coinbase Pro によってランダムに生成および提供されます。パスフレーズは API アクセスをさらに保護するためにあなたが提供します。Coinbase Pro はパスフレーズのソルト付きハッシュを検証用に保存しますが、パスフレーズを忘れた場合は回復できません。

 

API キーの機能を制限できます。キーを作成する前に、キーに付与する権限を選択する必要があります。権限は次のとおりです:

 

 

Accounts

 

メソッド Arguments 説明
ListAccounts   API キーのプロフィールから取引アカウントのリストを取得します。
GetAccount aAccountId: アカウントの ID 単一アカウントの情報。account_id が分かっている場合にこのエンドポイントを使用します。API キーはアカウントと同じプロファイルに属している必要があります。

 

注文

 

メソッド Arguments 説明
PlaceNewOrder aOrder: 注文のすべての可能なフィールドを含むクラス 新しい注文を発注します。高度な注文オプションにアクセスする必要がある場合にのみ使用してください。
PlaceMarketOrder

aSide: buy または sell

aProductId: プロダクトの ID

aQuoteSize:取引ペアの2番目の資産の数量。

aBaseSize: 取引ペアの最初の資産の数量です

aClient_oid: 注文を識別するために選択した注文 ID。

新しい成行注文を発注します。
PlaceLimitOrder

aSide: buy または sell

aProductId: プロダクトの ID

aQuoteSize: 取引ペアの第2アセットの数量。

aBaseSize: 取引ペアの最初の資産の数量

aLimitPrice: 価格制限

Client_oid: 注文を識別するために選択した注文 ID

新しいリミット注文を発注します。
PlaceStopOrder

aSide: buy または sell

ProductId: 製品の ID

aBaseSize: 取引ペアの最初の資産の数量

StopPrice: ストップ注文の価格

aLimitPrice: 価格の上限

aStopDirection: loss または entry

Client_oid: 注文を識別するためにあなたが選択した注文ID

新しいストップオーダーを発注します
CancelOrder aOrderId: 注文の id 以前に発注した注文をキャンセルします。注文は API キーが属するプロファイルに属している必要があります。
EditOrder

aOrderId: 注文の id

aPrice: 価格

aSize: 数量

指定した新しいサイズまたは新しい価格で注文を編集します
EditOrderPreview

aOrderId: 注文の id

aPrice: 価格

aSize: 数量

指定した新しいサイズまたは新しい価格で注文変更リクエストをプレビューします。
ListOrders   オプションのクエリパラメータ (product_id、order_status など) でフィルタリングされた注文のリストを取得します。
GetOrder aOrderId: 注文の id 注文 ID で単一の注文を取得します。
PreviewOrder   注文をプレビューします。
ClosePosition

aOrderId: 注文の id

aProductId: 製品の ID

aSize: 数量

指定された product_id に対するすべてのオープンポジションをクローズする注文を発注します。

 

 

 

 

マーケットデータ

 

メソッド Arguments 説明
GetPublicProducts   取引に利用可能な通貨ペアの一覧を取得します。
GetPublicProduct

aProductId: 製品の ID

製品IDで単一の製品の情報を取得します。
GetPublicProductBook aProductId: 製品の ID 単一製品の板情報(bid/ask)を取得します。limitパラメータで表示する詳細の量をカスタマイズできます。
GetPublicProductCandles

aProductId: 製品の ID

aStart: 時間間隔の開始

aEnd: 時間間隔の終了です

aGranularity: 各ローソク足が表す時間枠。

バケット内でグループ化された単一プロダクトの製品 ID ごとのレートを取得します。
GetTrades aProductId: 製品の ID 製品IDごとに最新の取引(ティック)と最良の買値/売値のスナップショット情報を取得します。
GetTime

 

Coinbase Advanced API から現在の時刻を取得します。

 

 

約定

 

メソッド Arguments 説明
GetFillsByOrderId   注文IDでフィルタリングされた約定リストを取得します。
GetFillsByProductId

 

製品 ID でフィルタリングされたフィルのリストを取得します。
GetFillsByTradeId   取引 ID でフィルタリングされたフィルのリストを取得します

変換

メソッド Arguments 説明
CreateConvertQuote 通貨間の変換クォートを作成します。
CommitConvertTrade convert取引をコミットします。
GetConvertTrade コンバートトレードの詳細を取得します。

手数料

メソッド Arguments 説明
GetTransactionSummary 取引手数料のサマリーを取得します。

製品(認証済み)

メソッド Arguments 説明
ListProducts 利用可能な製品を一覧表示します。
GetProduct aProductId: 製品の ID 特定の製品を取得します。
GetProductBook aProductId: 製品の ID 製品のオーダーブックを取得します。
GetProductCandles aProductId: 製品の ID 製品の OHLCV ローソク足を取得します。
GetMarketTrades aProductId: 製品の ID 最近の市場取引を取得します。
GetBestBidAsk 最良の買い/売り価格を取得します。

ポートフォリオ

メソッド Arguments 説明
ListPortfolios すべてのポートフォリオを一覧表示します。
CreatePortfolio 新しいポートフォリオを作成します。
DeletePortfolio ポートフォリオを削除します。
GetPortfolioBreakdown ポートフォリオの内訳の詳細を取得します。
MovePortfolioFunds ポートフォリオ間で資金を移動します。

Perpetuals

メソッド Arguments 説明
GetPerpetualsPortfolioSummary 先物ポートフォリオサマリーを取得します。
ListPerpetualsPositions パーペチュアルポジションを一覧表示します。
GetPerpetualsPosition 特定の永久ポジションを取得します。