Nightly Perpetrated Mischief
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

node-red-contrib-binance

0.1.7 • Public • Published

node-red-contrib-binance

A Node-RED node wrapper to make API calls to the Binance exchange. The back-end node library used to communicate with the Binance exchange is one of the winner of the Binance API Competition. See: https://support.binance.com/hc/en-us/articles/115002103732-First-Winner-of-Binance-API-Competition.

github: https://github.com/binance-exchange/node-binance-api

npm: https://www.npmjs.com/package/node-binance-api

IMPORTANT

For buy/sell nodes, orders will be placed with the user specified parameters on node input. There will be no secondary confirmation. Orders on the exchange cannot be reversed once they have been completed/satisfied.

USE AT YOUR OWN RISK

Tutorials

FRED Cloud Node-RED and cryptocurrencies

Installation

  1. Install Node-RED
  2. Go to Node-RED user directory (default: /home/{USER}/.node-red)
  3. Run: npm install node-red-contrib-binance

Supported Functions

Nodes supported are a subset of the available functions in the API

getPrice

Getting latest price of a symbol.

Input:

  • tickerPair - required

Output:

  • current price

getAllPrices

Getting latest price of all symbols.

Input:

  • none

Output:

  • {object} map of all available ticker pair and their current prices

getBookTicker

Getting bid/ask prices for a symbol.

Input:

  • tickerPair - required

Output:

  • {object} info on latest book price

getDayStats

Get 24hr ticker price change statistics for a symbol.

Input:

  • tickerPair - required

Output:

  • {object} info latest 24 hour stats

getCandlesticks

Get Kline/candlestick data for a symbol.

Input:

  • tickerPair - required
  • time interval
  • start time
  • end time

Output:

  • {array} candlesticks/kline data specified by parameters

i.e.

[
  [
    1499040000000,      // Open time
    "0.01634790",       // Open
    "0.80000000",       // High
    "0.01575800",       // Low
    "0.01577100",       // Close
    "148976.11427815",  // Volume
    1499644799999,      // Close time
    "2434.19055334",    // Quote asset volume
    308,                // Number of trades
    "1756.87402397",    // Taker buy base asset volume
    "28.46694368",      // Taker buy quote asset volume
    "17928899.62484339" // Ignore
  ]
]

getOrders

Get open orders for a symbol.

Input:

  • API credentials - required
  • tickerPair - required

Output:

  • {Array} list of current orders

getBalance

Get list of current balances.

Input:

  • API credentials - required
  • tickerPair - required

Output:

  • {object} map of ticker symbols and quantity on the account

cancelOrders

Cancel all open orders of a ticker pair.

Input:

  • API credentials - required
  • tickerPair - required

Output:

  • {object} binance API response

getTradeHistory

Get trade history of a ticker pair.

Input:

  • API credentials - required
  • tickerPair - required

Output:

  • {array} list of previous orders

buy

Create a limit or market buy order.

USE AT YOUR OWN RISK

Input:

  • API credentials - required
  • tickerPair - required
  • order type (limit/market) - required
  • quantity - required
  • price - required

Output:

  • {object} binance API response

sell

Create a limit or market sell order.

USE AT YOUR OWN RISK

Input:

  • API credentials - required
  • tickerPair - required
  • order type (limit/market) - required
  • quantity - required
  • price - required

Output:

  • {object} binance API response

Response and error handling

Most responses are directly passed through from the API to the output payload. Errors are directed to the nodes status message as well as the debug console.

For more details on the responses please see the official Binance REST API documentation at: https://github.com/binance-exchange/binance-official-api-docs/blob/master/rest-api.md

install

npm i node-red-contrib-binance

Downloadsweekly downloads

18

version

0.1.7

license

Apache-2

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability