Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Communicate with bitcoind via JSON-RPC

branch: master

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Readme.md

node-bitcoin

node-bitcoin is a simple wrapper for the Bitcoin client's JSON-RPC API.

The API is equivalent to the API document here. The methods are exposed as lower camelcase methods on the bitcoin.Client object, or you may call the API directly using the cmd method.

Install

npm install bitcoin

Setup

  1. Traverse to ~/.bitcoin or ~/Library/Application Support/Bitcoin and add a file called bitcoin.conf if it doesn't already exist.

  2. Add these lines to the file:

    rpcuser=username

    rpcpassword=password

You will use these to login to the server.

  1. Start your Bitcoin client with the -server argument or run bitcoind

  2. You should now be able to communicate with Bitcoin JSON-RPC API using the node-bitcoin library, try it out!

Examples

Create client

var bitcoin = require('bitcoin');
var client = new bitcoin.Client('localhost', 8332, 'username', 'password');

Create client with single object

var client = new bitcoin.Client({
  host: 'localhost',
  port: 8332,
  user: 'username',
  pass: 'password'
});

Get balance across all accounts with minimum confirmations of 6

client.getBalance('*', 6, function(err, balance) {
  if (err) return console.log(err);
  console.log('Balance:', balance);
});

Getting the balance directly using cmd

client.cmd('getbalance', '*', 6, function(err, balance){
  if (err) return console.log(err);
  console.log('Balance:', balance);
});
Something went wrong with that request. Please try again.