Skip to main content

AuthServiceProxy is an improved version of python-jsonrpc.

It includes the following generic improvements:

  • HTTP connections persist for the life of the AuthServiceProxy object

  • sends protocol ‘version’, per JSON-RPC 1.1

  • sends proper, incrementing ‘id’

  • uses standard Python json lib

  • can optionally log all RPC calls and results

  • JSON-2.0 batch support

It also includes the following bitcoin-specific details:

  • sends Basic HTTP authentication headers

  • parses all JSON numbers that look like floats as Decimal, and serializes Decimal values to JSON-RPC connections.

Installation

  1. change the first line of setup.py to point to the directory of your installation of python 2.*

  2. run setup.py

Note: This will only install bitcoinrpc. If you also want to install jsonrpc to preserve backwards compatibility, you have to replace ‘bitcoinrpc’ with ‘jsonrpc’ in setup.py and run it again.

Or simply install the library using pip:

pip install python-bitcoinrpc

Example

from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException

# rpc_user and rpc_password are set in the bitcoin.conf file
rpc_connection = AuthServiceProxy("http://%s:%s@127.0.0.1:8332"%(rpc_user, rpc_password))
best_block_hash = rpc_connection.getbestblockhash()
print(rpc_connection.getblock(best_block_hash))

# batch support : print timestamps of blocks 0 to 99 in 2 RPC round-trips:
commands = [ [ "getblockhash", height] for height in range(100) ]
block_hashes = rpc_connection.batch_(commands)
blocks = rpc_connection.batch_([ [ "getblock", h ] for h in block_hashes ])
block_times = [ block["time"] for block in blocks ]
print(block_times)

Logging all RPC calls to stderr

from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
import logging

logging.basicConfig()
logging.getLogger("BitcoinRPC").setLevel(logging.DEBUG)

rpc_connection = AuthServiceProxy("http://%s:%s@127.0.0.1:8332"%(rpc_user, rpc_password))
print(rpc_connection.getinfo())

Produces output on stderr like

DEBUG:BitcoinRPC:-1-> getinfo [] DEBUG:BitcoinRPC:<-1- {“connections”: 8, …etc }

Socket timeouts under heavy load

Pass the timeout argument to prevent “socket timed out” exceptions:

rpc_connection = AuthServiceProxy(
    "http://%s:%s@%s:%s"%(rpc_user, rpc_password, rpc_host, rpc_port),
    timeout=120)

Metadata

Release files for python-bitcoinrpc-2sat 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-bitcoinrpc-2sat 1.0.1
File Size Uploaded Provenance Actions
python_bitcoinrpc_2sat-1.0.1.tar.gz 15.7 kB Without provenance Details for python_bitcoinrpc_2sat-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for python-bitcoinrpc-2sat 1.0.1
File Interpreter ABI Platform Actions
python_bitcoinrpc_2sat-1.0.1-py3-none-any.whl Python 3 none any Details for python_bitcoinrpc_2sat-1.0.1-py3-none-any.whl

Total release size: 30.6 kB

Release files / python_bitcoinrpc_2sat-1.0.1.tar.gz

Download URL python_bitcoinrpc_2sat-1.0.1.tar.gz
Size 15.7 kB
Tags Source
SHA-256 checksum
How to use checksums
85469aae48f9fd67d3886f55b9908e4593f4d08267485f959862941ff312ab72
BLAKE2b-256 checksum
How to use checksums
aaf820f00726f392d344442c95845d88b505dc79cb801a740831988f9f2c38f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.13

Release files / python_bitcoinrpc_2sat-1.0.1-py3-none-any.whl

Download URL python_bitcoinrpc_2sat-1.0.1-py3-none-any.whl
Size 14.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0d75c404e3b5a3099ccfbd002990e5abf274065d31a20cc4408750327778f371
BLAKE2b-256 checksum
How to use checksums
7bff264052ba96c55a2b07d8c92e54651917209fb946f25ceda8b81db84620b6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.13

Security for python-bitcoinrpc-2sat 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page