Skip to content

Latest commit

 

History

History
 
 

Socket

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 

README.md

Blockchain.info Socket Module

Blockchain data delivered in real-time. View full API documentation.

Importing

var Socket = require('blockchain.info/socket');

Instantiating

An instance of Socket must be instantiated before using it:

var mySocket = new Socket();

Methods

close

mySocket.close();

onOpen

mySocket.onOpen(callback);

Parameters:

  • callback - function that will be called when the socket is opened

onClose

mySocket.onClose(callback);

Parameters:

  • callback - function that will be called when the socket is closed

onTransaction

mySocket.onTransaction(callback, options);

Parameters:

  • callback - function that will be called when a new transaction is broadcasted, gets passed a transaction json object

Options (optional):

  • addresses - array of bitcoin addresses to watch for new transactions
  • setTxMini - if set to true the websocket will respond with minimal transaction json objects

Minimal Tx:

{
  "time": 1449263035,
  "value": 4185461,
  "txIndex": 114394115,
  "hash": "a6deea4c335800fcc276002d12fd65d780a1d2b38f7a705b439eccf497931393"
}

onBlock

mySocket.onBlock(callback);

Parameters:

  • callback - function that will be called when a new block is written to the block chain, gets passed a block json object