1. Quickstart

Using the Bloxplorer package is easy and straightforward, as it should be.

1.1. Setup

To install the Bloxplorer package simply run this command in your favorite terminal:

>>> pip install bloxplorer

1.2. Usage

After installation, you can import and use the desired explorer and its methods. Both sync and async methods are available. For a full list of available methods click here. The available explorers are Bitcoin, Bitcoin Testnet, Bitcoin Signet and Liquid:

1.2.1. Bitcoin Explorer

from bloxplorer import bitcoin_explorer

result = bitcoin_explorer.blocks.get_last_height()
print(result.data)
'587840'

1.2.2. Bitcoin Testnet Explorer

from bloxplorer import bitcoin_testnet_explorer

result = bitcoin_testnet_explorer.blocks.get_last_height()
print(result.data)
'1571699'

1.2.3. Bitcoin Signet Explorer

from bloxplorer import bitcoin_signet_explorer

result = bitcoin_signet_explorer.blocks.get_last_height()
print(result.data)
'273464'

1.2.4. Liquid Explorer

from bloxplorer import liquid_explorer

result = liquid_explorer.blocks.get_last_height()
print(result.data)
'412287'

1.3. Timeouts

You can tell Bloxplorer to stop waiting for a response from the Blockstream API after a given number of seconds with the timeout parameter. By default the timeout is set to 5 seconds.

>>> bitcoin_explorer.blocks.get_blocks(start_height='587840', timeout=3)

1.4. Exceptions

There are 2 different types of exceptions that can be raised, Client and API exceptions.

1.4.1. Client Exceptions

BlockstreamClientNetworkError will be raised in the event of a network problem (e.g. DNS failure, refused connection, etc.)

BlockstreamClientTimeout will be raised in the event of a timeout.

BlockstreamClientError will be raised for anything else.

These exceptions will contain the error message, the resource url and the http method.

1.4.2. API Exceptions

BlockstreamApiError will be raised in the event of an API error (e.g. Invalid resource, Bad Request, etc.)

This exception will contain the same data as the Client exceptions, alongside the status code.

1.5. Source Code

Bloxplorer is available on GitHub.

Clone the public repository:

>>> git clone https://github.com/valinsky/bloxplorer.git

1.6. Dependencies

Bloxplorer uses httpx for the HTTP requests.