Skip to main content

blockapi

Library to interact with numerous cryptocurrency data APIs to get the basic info about account balance, transactions, staking informations, etc. List of supported coins:

coin API name supported operations
XTZ TzscanAPI balance, transactions, activations, originations, delegations, endorsements, bakings
TzStatsAPI staking (balance, rewards)
ATOM CosmosAPI balance, transactions, rewards, delegates, votes
DCR DcrdataAPI balance, transactions
ADA CardanoExplorerAPI balance, transactions
ZEC ChainSoAPI balance, transactions
MercerweissAPI balance
ZchainAPI balance
ETC BlockscoutAPI balance
NEO NeoscanAPI balance, transactions
ZEN ZensystemAPI balance
DASH ChainSoAPI balance, transactions
CryptoIDAPI balance
DOGE ChainSoAPI balance, transactions
BNB BinanceAPI balance,transactions
EOS EosparkAPI balance, transactions
GreymassAPI balance
BCH BtcAPI balance
XLM StellarAPI balance
RVN RavencoinAPI balance
TRX TronscanAPI balance
LTC BlockcypherAPI balance
ChainSoAPI balance, transactions
CryptoIDAPI balance
Ltc1TrezorAPI balance, transactions
BTC BlockchainInfoAPI balance, transactions
BlockonomicsAPI balance, transactions
ChainSoAPI balance, transactions
Btc1TrezorAPI balance, transactions
Btc2TrezorAPI balance, transactions
BitpayAPI balance
GRS CryptoIDAPI balance
ETH AlethioAPI balance, transactions, events
EtherscanAPI balance, transactions
EthplorerAPI balance
ONT OntioAPI balance, transactions
VET DigonchainAPI balance
BOS BlockchainosAPI balance, transactions
LUNA TerraMoneyAPI balance, transactions, delegations
DOT SubscanPolkaAPI balance, transactions, staking (locked, rewards)
KSM SubscanKusamaAPI balance, transactions, staking (locked, rewards)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Python 3.x, PIP (if you'd like to install it this way).

Installing

Library can be installed simply with pip:

pip install blockapi

or by running:

make install

Usage examples

Example usage to get account balance:

import blockapi
myobj = blockapi.api.BlockchainInfoAPI("bitcoin-address-here")
myobj.get_balance()

For some coins there are multiple APIs available. With get_random_api_class_for_coin it is possible to randomly pick any of the available APIs:

myapi = blockapi.get_random_api_class_for_coin('BTC')('1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX')
myapi.get_balance()

To directly pick first random working API and ask it for the account balance:

>>> blockapi.get_balance_from_random_api('BTC','16ftSEQ4ctQFDtVZiUBusQUjRrGhM3JYwe')
0.010034040000000001

It is possible to ask for a list of working APIs for a coin. They are automatically checked first if they work (test is done with asking for a balance). Only APIs which pass this check are returned:

>>> blockapi.get_working_apis_for_coin('BTC')
(<class 'blockapi.api.blockchaininfo.BlockchainInfoAPI'>, <class 'blockapi.api.blockonomics.BlockonomicsAPI'>, <class 'blockapi.api.insight.BitpayAPI'>, <class 'blockapi.api.trezor.Btc2TrezorAPI'>, <class 'blockapi.api.trezor.Btc1TrezorAPI'>)

During the API instance creation the supplied address is being checked for validity, if the address is not valid, ValueError exception is being raised:

>>> import blockapi
>>> blockapi.api.CosmosAPI('blahblah')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/srv/apps/blockapi/src/blockapi/blockapi/services.py", line 195, in __init__
self.check_validity()
File "/srv/apps/blockapi/src/blockapi/blockapi/services.py", line 201, in check_validity
self.symbol, self.address_info.address
ValueError: Not a valid ATOM address: b'blahblah'

It is possible to display the result of the address validation with included details like validity, network type, address type, or the info whether the supplied address is an extended one. Not for all coins all the details are available though:

>>> import blockapi
>>> myapi = blockapi.api.TzscanAPI('valid tezos address here')
>>> myapi.address_info
ValidationResult(name='tezos', ticker='xtz', address=b'valid tezos-address here', valid=True, network='both', is_extended=False, address_type='originated_account')

Running the tests

To run the included tests simply issue:

make test

Contributing

TBD

Authors

  • **Devmons s.r.o. - Initial work - crypkit

See also the list of contributors who participated in this project.

Credits

  • **Chris Priest - moneywagon library we took many ideas from - moneywagon
  • **Joe Black - Address validation library - coinaddr

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Metadata

Release files for blockapi 2.13.0

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

Source distribution (sdist)

Source distribution for blockapi 2.13.0
File Size Uploaded Provenance Actions
blockapi-2.13.0.tar.gz 101.4 kB Without provenance Details for blockapi-2.13.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for blockapi 2.13.0
File Interpreter ABI Platform Actions
blockapi-2.13.0-py3-none-any.whl Python 3 none any Details for blockapi-2.13.0-py3-none-any.whl

Total release size: 237.6 kB

Release files / blockapi-2.13.0.tar.gz

Download URL blockapi-2.13.0.tar.gz
Size 101.4 kB
Tags Source
SHA-256 checksum
How to use checksums
cd8292f7460248e6cf8022f48f20ceaeef9943521749e532181b34622a1d0e01
BLAKE2b-256 checksum
How to use checksums
a8322fd19af62427006ff9298be5afea89a50ed806f8fca1af234c6555c9911d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / blockapi-2.13.0-py3-none-any.whl

Download URL blockapi-2.13.0-py3-none-any.whl
Size 136.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
864d15b1c9587d5c25b8cc7e5b9831b7942019fa52b45f9e28f8defd7807b536
BLAKE2b-256 checksum
How to use checksums
092a65063b256c804e2f04c4f72da7e548c3d0f014596de8e279717e2593f9e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for blockapi 2.13.0

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

2.13.0 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