API reference JSON-RPC

               

Controlling Bitcoin

Run bitcoind or bitcoin-qt -server. You can control it via the command-line or byHTTP JSON-RPC commands.

You must create a bitcoin.conf configuration file setting an rpcuser and rpcpassword; seeRunning Bitcoin for details.

Now run:

 $ ./bitcoind -daemon bitcoin server starting $ ./bitcoind help # shows the help text

A list of RPC calls will be shown.

 $ ./bitcoind getbalance 2000.00000

JSON-RPC

Running Bitcoin with the -server argument (or running bitcoind) tells it to function as aHTTP JSON-RPC server, butBasic access authentication must be used when communicating with it, and, for security, by default, the server only accepts connections from other processes on the same machine. If your HTTP or JSON library requires you to specify which 'realm' is authenticated, use 'jsonrpc'.

Bitcoin supports SSL (https) JSON-RPC connections beginning with version 0.3.14. See therpcssl wiki page for setup instructions and a list of all bitcoin.conf configuration options.

Allowing arbitrary machines to access the JSON-RPC port (using the rpcallowip configuration option) is dangerous and strongly discouraged-- access should be strictly limited to trusted machines.

To access the server you should find a suitable library for your language.

Proper money handling

See the proper money handling page for notes on avoiding rounding errors when handling bitcoin values.

Python

python-jsonrpc is the official JSON-RPC implementation for Python.It automatically generates Python methods for RPC calls.However, due to its design for supporting old versions of Python, it is also rather inefficient.jgarzik has forked it asPython-BitcoinRPC and optimized it for current versions.Generally, this version is recommended.

While BitcoinRPC lacks a few obscure features from jsonrpc, software using only the ServiceProxy class can be written the same to work with either version the user might choose to install:

  from jsonrpc import ServiceProxy   access = ServiceProxy("http://user:password@127.0.0.1:8332")  access.getinfo()  access.listreceivedbyaddress(6)  #access.sendtoaddress("11yEmxiMso2RsFVfBcCa616npBvGgxiBX", 10)

The latest version of python-bitcoinrpc has a new syntax.

  from bitcoinrpc.authproxy import AuthServiceProxy

Ruby

require 'net/http'require 'uri'require 'json' class BitcoinRPC  def initialize(service_url)    @uri = URI.parse(service_url)  end   def method_missing(name, *args)    post_body = { 'method' => name, 'params' => args, 'id' => 'jsonrpc' }.to_json    resp = JSON.parse( http_post_request(post_body) )    raise JSONRPCError, resp['error'] if resp['error']    resp['result']  end   def http_post_request(post_body)    http    = Net::HTTP.new(@uri.host, @uri.port)    request = Net::HTTP::Post.new(@uri.request_uri)    request.basic_auth @uri.user, @uri.password    request.content_type = 'application/json'    request.body = post_body    http.request(request).body  end   class JSONRPCError < RuntimeError; endend if $0 == __FILE__  h = BitcoinRPC.new('http://user:password@127.0.0.1:8332')  p h.getbalance  p h.getinfo  p h.getnewaddress  p h.dumpprivkey( h.getnewaddress )  # also see: https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_listend

PHP

The JSON-RPC PHP library also makes it very easy to connect to Bitcoin. For example:

  require_once 'jsonRPCClient.php';   $bitcoin = new jsonRPCClient('http://user:password@127.0.0.1:8332/');   echo "<pre>\n";  print_r($bitcoin->getinfo()); echo "\n";  echo "Received: ".$bitcoin->getreceivedbylabel("Your Address")."\n";  echo "</pre>";

Note: The jsonRPCClient library uses fopen() and will throw an exception saying "Unable to connect" if it receives a 404 or 500 error from bitcoind. This prevents you from being able to see error messages generated by bitcoind (as they are sent with status 404 or 500). The EasyBitcoin-PHP library is similar in function to JSON-RPC PHP but does not have this issue.

Java

The easiest way to tell Java to use HTTP Basic authentication is to set a default Authenticator:

  final String rpcuser ="...";  final String rpcpassword ="...";   Authenticator.setDefault(new Authenticator() {      protected PasswordAuthentication getPasswordAuthentication() {          return new PasswordAuthentication (rpcuser, rpcpassword.toCharArray());      }  });

Once that is done, any JSON-RPC library for Java (or ordinary URL POSTs) may be used to communicate with the Bitcoin server.

Perl

The JSON::RPC package from CPAN can be used to communicate with Bitcoin. You must set the client's credentials; for example:

  use JSON::RPC::Client;  use Data::Dumper;   my $client = new JSON::RPC::Client;   $client->ua->credentials(     'localhost:8332', 'jsonrpc', 'user' => 'password'  # REPLACE WITH YOUR bitcoin.conf rpcuser/rpcpassword      );   my $uri = 'http://localhost:8332/';  my $obj = {      method  => 'getinfo',      params  => [],   };   my $res = $client->call( $uri, $obj );   if ($res){      if ($res->is_error) { print "Error : ", $res->error_message; }      else { print Dumper($res->result); }  } else {      print $client->status_line;  }

Go

The btcjson package can be used to communicate with Bitcoin. You must provide credentials to match the client you are communicating with.

 import "github.com/conformal/btcjson" msg, err := btcjson.CreateMessage("getinfo") if err != nil {    // Do your error handling } // Use your username and password here. reply, err := btcjson.RpcCommand("user", "password", "localhost:8332", msg)

.NET (C#)

The communication with rpc service can be achieved using the standard http request/response objects.A library for serialising and deserializing Json will make your life a lot easier:

Json.Net ( http://james.newtonking.com/json ) is a high performance JSON package for .Net. It is also available via NuGet from the package manager console ( Install-Package Newtonsoft.Json ).

The following example uses Json.Net:

 HttpWebRequest webRequest = (HttpWebRequest)WebRequest.Create("http://localhost.:8332"); webRequest.Credentials = new NetworkCredential("user", "pwd"); /// important, otherwise the service can't desirialse your request properly webRequest.ContentType = "application/json-rpc"; webRequest.Method = "POST";  JObject joe = new JObject(); joe.Add(new JProperty("jsonrpc", "1.0")); joe.Add(new JProperty("id", "1")); joe.Add(new JProperty("method", Method)); // params is a collection values which the method requires.. if (Params.Keys.Count == 0) {  joe.Add(new JProperty("params", new JArray())); } else {     JArray props = new JArray();     // add the props in the reverse order!     for (int i = Params.Keys.Count - 1; i >= 0; i--)     {        .... // add the params     }     joe.Add(new JProperty("params", props));     }      // serialize json for the request     string s = JsonConvert.SerializeObject(joe);     byte[] byteArray = Encoding.UTF8.GetBytes(s);     webRequest.ContentLength = byteArray.Length;     Stream dataStream = webRequest.GetRequestStream();     dataStream.Write(byteArray, 0, byteArray.Length);     dataStream.Close();       WebResponse webResponse = webRequest.GetResponse();      ... // deserialze the response

There is also a wrapper for Json.NET called Bitnet (https://sourceforge.net/projects/bitnet)implementing Bitcoin API in more convenient way:

     BitnetClient bc = new BitnetClient("http://127.0.0.1:8332");     bc.Credentials = new NetworkCredential("user", "pass");      var p = bc.GetDifficulty();     Console.WriteLine("Difficulty:" + p.ToString());      var inf = bc.GetInfo();     Console.WriteLine("Balance:" + inf["balance"]);

Node.js

• node-bitcoin (npm: bitcoin)

Example using node-bitcoin:

var bitcoin = require('bitcoin');var client = new bitcoin.Client({  host: 'localhost',  port: 8332,  user: 'user',  pass: 'pass'}); client.getDifficulty(function(err, difficulty) {  if (err) {    return console.error(err);  }   console.log('Difficulty: ' + difficulty);});

Example using Kapitalize:

var client = require('kapitalize')() client.auth('user', 'password') client.getInfo().getDifficulty(function(err, difficulty) {  console.log('Dificulty: ', difficulty)})

Command line (cURL)

You can also send commands and see results using cURL or some other command-line HTTP-fetching utility; for example:

  curl --user user --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getinfo", "params": [] }'     -H 'content-type: text/plain;' http://127.0.0.1:8332/

You will be prompted for your rpcpassword, and then will see something like:

  {"result":{"balance":0.000000000000000,"blocks":59952,"connections":48,"proxy":"","generate":false,     "genproclimit":-1,"difficulty":16.61907875185736,"error":null,"id":"curltest"}

Clojure

clj-btc is a Clojure wrapper for the bitcoin API.

user=> (require '[clj-btc.core :as btc])niluser=> (btc/getinfo){"timeoffset" 0, "protocolversion" 70001, "blocks" 111908, "errors" "", "testnet" true, "proxy" "", "connections" 4, "version" 80500, "keypoololdest" 1380388750, "paytxfee" 0E-8M, "difficulty" 4642.44443532M, "keypoolsize" 101, "balance" 0E-8M, "walletversion" 60000}

See Also

• API calls list
• Running Bitcoin
• Lazy API
• PHP developer intro
• Raw Transactions API
• Web Based JSON RPC interface.