Skip to content

Bitcoin and other Cryptocurrencies Library for Python. Includes a fully functional wallet, Mnemonic key generation and management and connection with various service providers to receive and send blockchain and transaction information.



Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time

Python Bitcoin Library

Bitcoin, Litecoin and Dash Crypto Currency Library for Python.

Includes a fully functional wallet with multi-signature, multi-currency and multiple accounts. You this library at a high level and create and manage wallets for the command line or at a low level and create your own custom made transactions, keys or wallets.

The BitcoinLib connects to various service providers automatically to update wallets, transactions and blockchain information. It does currently not parse the blockchain itself.

Unittests PyPi RTD Coveralls Known Vulnerabilities


Read the full documentation at:


This library is still in development, please use at your own risk and test sufficiently before using it in a production environment.

Some Examples


The bitcoin library contains a wallet implementation using SQLAlchemy and SQLite3 to import, create and manage keys in a Hierarchical Deterministic way.

Example: Create wallet and generate new address (key) to receive bitcoins

>>> from bitcoinlib.wallets import Wallet
>>> w = Wallet.create('Wallet1')
>>> key1 = w.get_key()
>>> key1.address

Now send a small transaction to your wallet and use the scan() method to update transactions and UTXO's

>>> w.scan()
>>>  # Shows wallet information, keys, transactions and UTXO's

When your wallet received a payment and has unspent transaction outputs, you can send bitcoins easily. If successful a transaction ID is returned

>>> t = w.send_to('1PWXhWvUH3bcDWn6Fdq3xhMRPfxRXTjAi1', '0.001 BTC', offline=False)
>>>  # Shows transaction information and send results

Wallet from passphrase with accounts and multiple currencies

The following code creates a wallet with two Bitcoin and one Litecoin account from a Mnemonic passphrase. The complete wallet can be recovered from the passphrase, which is the masterkey.

from bitcoinlib.wallets import Wallet, wallet_delete
from bitcoinlib.mnemonic import Mnemonic

passphrase = Mnemonic().generate()
w = Wallet.create("Wallet2", keys=passphrase, network='bitcoin')
account_btc2 = w.new_account('Account BTC 2')
account_ltc1 = w.new_account('Account LTC', network='litecoin')

Multi-Signature Wallets

Create a Multisig wallet with 2 cosigners which both need to sign a transaction.

from bitcoinlib.wallets import Wallet
from bitcoinlib.keys import HDKey

NETWORK = 'testnet'
k1 = HDKey('tprv8ZgxMBicQKsPd1Q44tfDiZC98iYouKRC2CzjT3HGt1yYw2zuX2awTotzGAZQEAU9bi2M5MCj8iedP9MREPjUgpDEBwBgGi2C8eK'
            '5zNYeiX8', network=NETWORK)
k2 = HDKey('tprv8ZgxMBicQKsPeUbMS6kswJc11zgVEXUnUZuGo3bF6bBrAg1ieFfUdPc9UHqbD5HcXizThrcKike1c4z6xHrz6MWGwy8L6YKVbgJ'
            'MeQHdWDp', network=NETWORK)
w1 = Wallet.create('multisig_2of2_cosigner1', sigs_required=2,
                     keys=[k1, k2.public_master(multisig=True)], network=NETWORK)
w2 = Wallet.create('multisig_2of2_cosigner2',  sigs_required=2,
                     keys=[k1.public_master(multisig=True), k2], network=NETWORK)
print("Deposit testnet bitcoin to this address to create transaction: ", w1.get_key().address)

Create a transaction in the first wallet

t = w1.sweep('mwCwTceJvYV27KXBc3NJZys6CjsgsoeHmf', min_confirms=0)

And then import the transaction in the second wallet, sign it and push it to the network

t2 = w2.transaction_import(t)

Segregated Witness Wallet

Easily create and manage segwit wallets. Both native segwit with base32/bech32 addresses and P2SH nested segwit wallets with traditional addresses are available.

Create a native single key P2WPKH wallet:

>>> from bitcoinlib.wallets import Wallet
>>> w = Wallet.create('wallet_segwit_p2wpkh', witness_type='segwit')
>>> w.get_key().address

Or create a P2SH nested single key P2SH_P2WPKH wallet:

>>> from bitcoinlib.wallets import Wallet
>>> w = Wallet.create('wallet_segwit_p2sh_p2wpkh', witness_type='p2sh-segwit')
>>> w.get_key().address

Command Line Tool

With the command line tool you can create and manage a wallet without any Python programming.

To create a new Bitcoin wallet

$ clw newwallet
Command Line Wallet for BitcoinLib

Wallet newwallet does not exist, create new wallet [yN]? y

CREATE wallet 'newwallet' (bitcoin network)

Your mnemonic private key sentence is: force humble chair kiss season ready elbow cool awake divorce famous tunnel

Please write down on paper and backup. With this key you can restore your wallet and all keys

You can use clw to create simple or multisig wallets for various networks, manage public and private keys and managing transactions.

For the full command line wallet documentation please read

Mnemonic key generation

Allows you to use easy to remember passphrases consisting of a number of words to store private keys (BIP0039). You can password protect this passphrase (BIP0038), and use the HD Wallet structure to generate an almost infinite number of new private keys and bitcoin addresses (BIP0043 and BIP0044).

Example: Generate a list of words passphrase and derive a private key seed

>>> from bitcoinlib.mnemonic import Mnemonic
>>> from bitcoinlib.encoding import to_hexstring
>>> words = Mnemonic().generate()
>>> words
unique aisle iron extend earn cigar trust source next depart yard bind
>>> to_hexstring(Mnemonic().to_seed(words))

Service providers

Communicates with pools of bitcoin service providers to retrieve transaction, address, blockchain information. Can be used to push a transaction to the network, determine optimal service fee for a transaction or to update your wallet's balance.

When working with wallets, connections to service providers are automatically managed, so you don't have to worry about them. You can however easily use the Service object directly.

Example: Get estimated transaction fee in Sathosis per Kb for confirmation within 5 blocks

>>> from import Service
>>> Service().estimatefee(5)

Other Databases

Bitcoinlib uses the SQLite database by default, but other databases are supported as well. See for instructions on how to use MySQL or PostgreSQL.

More examples

For more examples see

Implements the following Bitcoin Improvement Proposals

  • Hierarchical Deterministic Wallets (BIP0032)
  • Passphrase-protected private key (BIP0038)
  • Mnemonic code for generating deterministic keys (BIP0039)
  • Purpose Field for Deterministic Wallets (BIP0043)
  • Multi-Account Hierarchy for Deterministic Wallets (BIP0044)
  • Structure for Deterministic P2SH Multisignature Wallets (BIP0045)
  • Bech32/base32 address format for native v0-16 witness outputs (BIP0173)
  • Native and P2SH nested Segregated Witness transactions (BIP0141 and BIP0143)
  • Bech32m format for v1+ witness addresses (BIP0350)
  • and many more...

Installing and updating

Pre-requirements Linux

sudo apt install build-essential python3-dev libgmp3-dev libssl-dev

To install OpenSSL development package on Debian, Ubuntu or their derivatives

sudo apt install libssl-dev

To install OpenSSL development package on Fedora, CentOS or RHEL

sudo yum install gcc openssl-devel

Pre-requirements Windows

This library requires a Microsoft Visual C++ Compiler. See

The fastecdsa library is not enabled at this moment on windows, the slower ecdsa library is installed.

Install with pip

pip install bitcoinlib

These packages will be installed * fastecdsa (or ecdsa on Windows) * sqlalchemy * requests * numpy * pycryptodome

If you want to use BIP38 encrypted private keys, you should also install the much faster scrypt library.

pip install scrypt

Install development environment

Required packages:

sudo apt install -y postgresql postgresql-contrib mysql-server libpq-dev libmysqlclient-dev

Create a virtual environment for instance on linux with virtualenv:

$ virtualenv -p python3 venv/bitcoinlib
$ source venv/bitcoinlib/bin/activate

Then clone the repository and install dependencies:

$ git clone
$ cd bitcoinlib
$ pip install -r requirements-dev.txt


When you experience issues with the scrypt package when installing, you can try to solve this by removing and reinstall scrypt:

$ pip uninstall scrypt
$ pip install scrypt

Please make sure you also have the Python development and SSL development packages installed, see 'Other requirements' above.

You can also use pyscrypt or pycryptodome instead of scrypt. Pyscrypt is a pure Python scrypt password-based key derivation library. It works but it is slow when using BIP38 password protected keys.

If you run into issues, do not hesitate to contact us or file an issue at

Update library

Update to the latest version of the library with

$ pip install bitcoinlib --upgrade

To upgrade make sure everything is backuped and run from the installation directory.

$ python -d [<link-to-database-if-not-standard>]

For more information on installing, updating and maintenance see

Future / Roadmap

  • Support advanced scripts
  • Fully support timelocks
  • Support for lightning network
  • Support for Trezor wallet


Bitcoin and other Cryptocurrencies Library for Python. Includes a fully functional wallet, Mnemonic key generation and management and connection with various service providers to receive and send blockchain and transaction information.








No packages published