Skip to main content

A python api wrapper to access the available enpoints from the blockscan.com ecosystem

Project description

blockscan-python

This package was created in the hope to provide a multi-chain API wrapper for the blockscan.com endpoints and reduce the overhead of using multiple single chain wrapper.

Note

The following blockchains from blockscout.com are also provided BUT it’s because blockscout offers the API for developers transitioning their applications from Etherscan to BlockScout. If they deprecate those API in the future so will this package.

  • Gnosis (100)

  • Ethereum Classic (61)

  • Ethereum Classic Mordor (63)

  • Ethereum Classic Kotti (6)

  • POA Core (99)

  • POA Sokol (77)

  • Artis Sigma1 (246529)

  • RSK (30)

  • Hoo Smart Chain (70) (This one is technicaly part of blockscan.com but is built on top of blockscout)

Installation

Blockscan-python can be installed using pip as follows:

$ pip install blockscan-python

Usage

Refer to the full documentation for the list of endpoints and the specific blockscan provider for compatibility. This package doesn’t filter the endpoints on a per-chain basis. This means that some calls will fails if the provider doesn’t support it.

Prerequisite

  • The chain ID you want to connect to.

    Refer to chainlist if unknown

  • Specific chain API Token provided by blockscan

    (i.e: An etherscan.io token for Ethereum)

    Exception: Any Blockscout chain takes an empty string “”, No token required

Create a connection client

The connection can be created as Sync:

>>> from blockscan import Blockscan

# Sync connection to etherscan.io
>>> client = blockscan(1, "MYAPITOKEN", is_async=False)
>>> client.accounts.get_currency_balance(
        "0x0000000000000000000000000000000000000000"
        )
'11400022397988649428803'

But will default to Async if no parameter is provided:

>>> from blockscan import BlockScan

#Async connection to bscscan.com
>>> client = Blockscan(56, "MYAPITOKEN")
>>> bal = await client.accounts.get_currency_balance(
                "0x0000000000000000000000000000000000000000"
                )
>>> print(bal)
'1073557893975925234717'

The full list of parameters is available in the documentation

Credits

Credits to @pcko1 for making the bscscan-python that was used as the base for this package

TO-DOs

  • Add a reference table of the available Chain ID to the docs

History

0.0.1 (2022-07-02)

  • First release on PyPI.

1.1.0 (2022-07-03)

  • CI tests and deployment added

  • Packaging build tested and beta ready

1.1.1 (2022-07-26)

  • Preloaded modules for easier IDE usage

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blockscan-python-1.1.1.tar.gz (117.2 kB view details)

Uploaded Source

Built Distribution

blockscan_python-1.1.1-py2.py3-none-any.whl (26.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file blockscan-python-1.1.1.tar.gz.

File metadata

  • Download URL: blockscan-python-1.1.1.tar.gz
  • Upload date:
  • Size: 117.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for blockscan-python-1.1.1.tar.gz
Algorithm Hash digest
SHA256 2669852f5366f85e85e6cd72e8181f16f7f60690e8af34e1a94111aba98ba286
MD5 f8ce6abda4407e417adfd3e21c2be09f
BLAKE2b-256 d2bf51ef94e301a3044c05e92765f59c92302743268a94ad4764f2b7dc2ece6b

See more details on using hashes here.

File details

Details for the file blockscan_python-1.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for blockscan_python-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fa724cf9112630f462ad880330c03efd38ebd7efea94864abad5b1e6490297ca
MD5 744b752b981b60567746d08ffa513edf
BLAKE2b-256 7a15f8ec91b3c80298731607f6cc3f34ea4594d57796cfc010d873edc3c7a68e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page