TradeApi

TradeApi

Trade API

Constructor

new TradeApi()

Methods

(async) cancelOrder(注文ID) → {Promise}

注文をキャンセルします。

Parameters:
Name Type Description
注文ID string
Returns:
Type
Promise

(async) getBalance() → {Promise.<object>}

取引所の各通貨の残高を取得します。

結果は下記のようなオブジェクト形式となります。

{
  jpy: 100,
  btc: 3.5,
  eth: 10,
}
Returns:
Type
Promise.<object>

(async) getOHLCV(pair, duration) → {Promise}

OHLCVを取得します。

Parameters:
Name Type Description
pair string

通貨ペア

duration number

出来高を取得する期間。単位は分です。1, 5, 15, 30, 60のいずれかである必要があります。

Returns:
Type
Promise

(async) getOpenOrders() → {Promise}

自分の注文の一覧を取得します。

Returns:
Type
Promise

(async) getOrderBook(pair) → {Promise.<object>}

現在の売買注文情報を取得します。

結果は下記のようなオブジェクト形式となります。

{
  asks: [ [10500, 1.5], [11000, 3.5], ...],
  bids: [ [11500, 1.5], [12000, 3.5], ...]
}
Parameters:
Name Type Description
pair string

通貨ペア

Returns:
Type
Promise.<object>

(async) getTicker(pair) → {Promise}

ティッカーを取得します。

結果は下記のようなオブジェクト形式となります。

{
  last: 1000,
  high: 500,
  low: 500,
  volume: 1000,
  bid: 500,
  ask: 500
}
Parameters:
Name Type Description
pair string

通貨ペア

Returns:
Type
Promise

(async) getVolume(pair, duration) → {Promise}

(Deprecated) 出来高をを取得します。

この関数はまもなく削除されます。代わりにgetOHLCV() を使用してください。

Parameters:
Name Type Description
pair string

通貨ペア

duration number

出来高を取得する期間。単位は分です。1, 5, 15, 30, 60のいずれかである必要があります。

Returns:
Type
Promise

(async) order(order) → {Promise}

注文を行います。

orderオブジェクトは下記のプロパティを設定します。

  • pair: 通貨ペア
  • action: 'buy' または 'sell'
  • price: 金額
  • amount: 数量
Parameters:
Name Type Description
order object

注文内容

Returns:
Type
Promise

withExchange()

指定の取引所との通信を行うTradeApiインスタンスを返します