Blockfacts-sdk NPM

BlockFacts NodeJS SDK

Official BlockFacts Node.js SDK including Rest and WebSocket API support.

Features

REST API client with function wrapper for easy API access
WebSocket API client for real-time data gathering

Note: In order to read more and get richer details regarding our REST and WebSocket APIs, please refer to https://docs.blockfacts.io.

Installation

$ npm install blockfacts-sdk

Quick start

To start using our SDK just require the package and pass the API-KEY and API-SECRET in the constructor.

const Blockfacts = require('blockfacts-sdk');
const key = 'your-api-key';
const secret = 'your-api-secret';

var restClient = new Blockfacts.RestClient(key, secret);
var websocketClient = new Blockfacts.WebSocketClient(key, secret);

Using Rest API Client

In the examples below, you can see which method is mapped to call it's predefined endpoint. You can also read more about authorization and how to obtain an API Key here: https://docs.blockfacts.io/#authorization

Note: All of the functions are Promise based.

Asset endpoints

List all assets

Get all assets that we support.

listAllAssets()

restClient.assets.listAllAssets().then(response => console.log(response))

Get specific asset

Get specific asset by ticker ID.

getSpecificAsset(tickerId)

restClient.assets.getSpecificAsset("BTC").then(response => console.log(response))

BlockFacts endpoints

Exchanges in normalization

List exchanges that go into the normalization for specific asset-denominator pair.

getExchangesInNormalization(pair)

restClient.blockfacts.getExchangesInNormalization(["BTC-USD", "ETH-USD"]).then(response => console.log(response))

// OR

restClient.blockfacts.getExchangesInNormalization("BTC-USD, ETH-USD").then(response => console.log(response))

Current data

Get current normalization data for specific asset-denominator pair.

getCurrentData(assets, denominators)

restClient.blockfacts.getCurrentData(["BTC", "ETH"], ["USD", "EUR"]).then(response => console.log(response))

// OR

restClient.blockfacts.getCurrentData("BTC, ETH", "USD, EUR").then(response => console.log(response))

Snapshot data

Get last 600 BLOCKFACTS normalized prices for provided asset-denominator pairs.

getSnapshotData(assets, denominators)

restClient.blockfacts.getSnapshotData(["BTC", "ETH"], ["USD", "EUR"]).then(response => console.log(response))

// OR

restClient.blockfacts.getSnapshotData("BTC, ETH", "USD, EUR").then(response => console.log(response))

OHLCV Snapshot data

Get the snapshot of Blockfacts OHLCV data for provided asset-denominator pairs and intervals.

getOHLCVSnapshotData(assets, denominators, intervals)

restClient.blockfacts.getOHLCVSnapshotData(["BTC", "ETH"], ["USD", "EUR"], ["1m", "3m", "1h"]).then(response => console.log(response))

// OR

restClient.blockfacts.getOHLCVSnapshotData("BTC, ETH", "USD, EUR", "1m, 3m, 1h").then(response => console.log(response))

Note: You can find all supported intervals on our official documentation here: https://docs.blockfacts.io/#data-snapshot-ohlcv-blockfacts

Historical data

Get historical normalization data by asset-denominator, date, time and interval.

getHistoricalData(asset, denominator, date, time, interval, page)

restClient.blockfacts.getHistoricalData("BTC", "USD", "2.9.2019", "14:00:00", 20).then(response => console.log(response))

// OR with page parameter (optional)

restClient.blockfacts.getHistoricalData("BTC", "USD", "2.9.2019", "14:00:00", 20, 3).then(response => console.log(response))

OHLCV Historical data

Get historical OHLCV data by asset-denominator, date, time and interval.

getHistoricalOHLCVData(asset, denominator, interval, dateStart, timeStart, dateEnd, timeEnd, page)

restClient.blockfacts.getHistoricalOHLCVData("BTC", "USD", "1d", "5.8.2020", "14:00:00", "10.8.2020", "14:00:00").then(response => console.log(response))

// OR with page parameter (optional)

restClient.blockfacts.getHistoricalOHLCVData("BTC", "USD", "1d", "5.8.2020", "14:00:00", "10.8.2020", "14:00:00", 2).then(response => console.log(response))

Specific historical data

Get historical normalized price by specific point in time.

getSpecificHistoricalData(asset, denominator, date, time)

restClient.blockfacts.getSpecificHistoricalData("BTC", "USD", "2.9.2019", "14:00:00").then(response => console.log(response))

Normalization pairs

Get all running normalization pairs. Resulting in which asset-denominator pairs are currently being normalized inside our internal system.

getNormalizationPairs()

restClient.blockfacts.getNormalizationPairs().then(response => console.log(response))

Period movers

Get the moving percentage, and difference in price over a certain time period.

getPeriodMovers(denominator, date, interval, sort)

restClient.blockfacts.getPeriodMovers("USD", "11.8.2020", "sevenDay", -1).then(response => console.log(response))

Exchange endpoints

List all exchanges

List all exchanges that we support.

listAllExchanges()

restClient.exchanges.listAllExchanges().then(response => console.log(response))

Specific exchange data

Get information about a specific exchange by its name. Returns information such as which assets are supported, asset ticker info, etc.

getSpecificExchangeData(exchange)

restClient.exchanges.getSpecificExchangeData("kraken").then(response => console.log(response))

Pair info

Get the Blockfacts pair representation of the provided exchange pair.

getPairInfo(exchange, pair)

restClient.exchanges.getPairInfo("BITSTAMP", "BTCUSD").then(response => console.log(response))

Current trade data

Get current trade data for specific asset-denominator pair, from specific exchange(s).

getCurrentTradeData(assets, denominators, exchanges)

restClient.exchanges.getCurrentTradeData(["BTC", "ETH"], ["USD", "GBP"], ["kraken", "coinbase"]).then(response => console.log(response))

// OR

restClient.exchanges.getCurrentTradeData("BTC, ETH", "USD, GBP", "kraken, coinbase").then(response => console.log(response))

Snapshot trade data

Get 600 latest trades that happened on the requested exchanges and pairs.

getSnapshotTradeData(assets, denominators, exchanges)

restClient.exchanges.getSnapshotTradeData(["BTC", "ETH"], ["USD", "GBP"], ["kraken", "coinbase"]).then(response => console.log(response))

// OR

restClient.exchanges.getSnapshotTradeData("BTC, ETH", "USD, GBP", "kraken, coinbase").then(response => console.log(response))

OHLCV Snapshot data

Get the snapshot of provided exchange(s) OHLCV data for provided asset-denominator pairs and intervals.

getOHLCVSnapshotData(assets, denominators, exchanges, intervals)

restClient.exchanges.getOHLCVSnapshotData(["BTC", "ETH"], ["USD", "GBP"], ["kraken", "coinbase"], ["1m", "3m", "1h"]).then(response => console.log(response))

// OR

restClient.exchanges.getOHLCVSnapshotData("BTC, ETH", "USD, GBP", "kraken, coinbase", "1m, 3m, 1h").then(response => console.log(response))

Note: You can find all supported intervals on our official documentation here: https://docs.blockfacts.io/#data-snapshot-ohlcv-exchange

Historical trade data

Get exchange historical price by asset-denominator, exchange, date, time and interval.

getHistoricalTradeData(asset, denominator, exchanges, date, time, interval, page)

restClient.exchanges.getHistoricalTradeData("BTC", "USD", ["kraken", "coinbase"], "2.9.2019", "14:00:00", 20).then(response => console.log(response))

// OR with page parameter (optional)

restClient.exchanges.getHistoricalTradeData("BTC", "USD", "kraken, coinbase", "2.9.2019", "14:00:00", 20, 3).then(response => console.log(response))

OHLCV Historical data

Get historical OHLCV data by asset-denominator, exchange, date, time and interval

getHistoricalOHLCVData(asset, denominator, exchanges, interval, dateStart, timeStart, dateEnd, timeEnd, page)

restClient.exchanges.getHistoricalOHLCVData("BTC", "USD", ["kraken", "coinbase"], "1d", "5.8.2020", "14:00:00", "10.8.2020", "14:00:00").then(response => console.log(response))

// OR with page parameter (optional)

restClient.exchanges.getHistoricalOHLCVData("BTC", "USD", "kraken, coinbase", "1d", "5.8.2020", "14:00:00", "10.8.2020", "14:00:00", 2).then(response => console.log(response))

Specific trade data

Get historical exchange trades in specific second.

getSpecificTradeData(asset, denominator, exchanges, date, time)

restClient.exchanges.getSpecificTradeData("BTC", "USD", ["kraken", "coinbase"], "2.9.2019", "14:00:00").then(response => console.log(response))

// OR

restClient.exchanges.getSpecificTradeData("BTC", "USD", "kraken, coinbase", "2.9.2019", "14:00:00").then(response => console.log(response))

Total trade volume

Get the total traded volume on all exchanges by asset-denominator and interval.

getTotalTradeVolume(asset, denominator, interval)

restClient.exchanges.getTotalTradeVolume("BTC", "USD", "1d").then(response => console.log(response))

Period movers

Get the moving percentage, and difference in price over a certain time period.

getPeriodMovers(exchange, denominator, date, interval, sort)

restClient.exchanges.getPeriodMovers("KRAKEN", "USD", "11.8.2020", "sevenDay", -1).then(response => console.log(response))

Using WebSocket API Client

Our WebSocket feed provides real-time market data streams from multiple exchanges at once and the BlockFacts normalized price stream for each second. The WebSocket feed uses a bidirectional protocol, and all messages sent and received via websockets are encoded in a JSON format.

Note: Please refer to https://docs.blockfacts.io/#websocket-api in order to find out what types of subscriptions and requests you can send to our WebSocket server.

Subscribing

In order to subscribe to a specific channel or asset-pair you must send out a subscribe type message. Our SDK allows you to do just that with the following code example:

var subscribeMsg = JSON.stringify({
  "type":"subscribe",
  "X-API-KEY":`${key}`,
  "X-API-SECRET":`${secret}`,
  "channels": [
    {
      "name":"BLOCKFACTS",
      "pairs": [
        "BTC-USD"
      ]
    }
  ]
});

websocketClient.subscribe(subscribeMsg, (data) => {
  data = JSON.parse(data);
  console.log(data);

  if(data.type == 'subscribed') {
    // Handle subscribed event
  }

  if(data.type == 'ping') {
    websocketClient.pong();
  }

  if (data.type == 'error') {
    // Handle error
  }

  if (data.type == 'snapshot') {
    // Handle snapshot
  }

  if (data.type == 'heartbeat') {
    // Handle heartbeat
  }

  if(data.type == 'unsubscribed') {
    // Handle unsubscribe
  }

  if (data.type == 'exchangeTrade') {
    // Handle exchangeTrade
  }

  if (data.type == 'blockfactsPrice') {
    // Handle blockfactsPrice
  }

});

Unsubscribing

If you wish to unsubscribe from certain channels or pairs, you can do so by sending the unsubscribe type message.

var unsubscribeMsg = JSON.stringify({
  "type":"unsubscribe",
  "channels": [
    {
      "name":"BLOCKFACTS",
      "pairs": [
        "BTC-USD"
      ]
    }
  ]
});

websocketClient.unsubscribe(unsubscribeMsg);