bitrpcclient

Bitcoin RPC Client is a JSON-RPC simple client for bitcoind.

Usage

Scripting

    import bitrpcclient
    cl = bitrpcclient.BitRPCClient('<username>', '<password>', port=18332)
    print(cl.help())

Command Line Interface

$ python
>>> import bitrpcclient
>>> cl = bitrpcclient.BitRPCClient('<username>', '<password>', port=18332)
>>> cl.getinfo()
{u'connections': 8, u'errors': u'Warning: unknown new rules activated (versionbit 28)', u'blocks': 874973, u'paytxfee': 0.0, u'keypoololdest': 1466689788, u'walletversion': 60000, u'difficulty': 1, u'testnet': True, u'version': 120100, u'proxy': u'', u'protocolversion': 70012, u'timeoffset': -1, u'balance': 0.0, u'relayfee': 1e-05, u'keypoolsize': 101}
>>> cl.getblockhash(0)
u'000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943'

Run bitcoind

To run the above sample, run the bitcoind daemon:

bitcoind -server -rpcuser=<username> -rpcpassword=<password> -testnet

Methods

All BitRPCClient calls are dynamic, you can get a list with cl.help(). Documentation about the server could be found at bitcoin.org and also at the bitcoin wiki

Errors

A BitRPCException is raised if something wrong. On properly handled errors from the JSON-RPC server a BitRPCErrorResponse will be raise with the code and the message of the error. Otherwise a BitRPCException will be raised with a message.

Requirements

The only dependency is the requests library.

Tested with python 2.7 and python 3.5.

Install

To install just download the project and run python setup.py install

git clone https://github.com/fmontoto/bitrpcclient.git
cd bitrpcclient
pip install -r requirements.txt
python setup.py install

Contribute

If you want to contribute to the code, want a new feature or ask for help, do not hesitate to open an issue or send a pull request.

License

bitrpcclient is distributed under Apache License 2.0. See LICENSE file.