Repository files navigation

A minimal, yet complete, Python API forEtherscan.io.

All standard and pro endpoints are provided. Kovan, Rinkeby and Ropsten testnets are also supported.

Available onPyPI. Powered byEtherscan.io APIs.

The following endpoints are provided:

If you think that a newly-added method is missing, kindly open anissue as a feature request and I will do my best to add it.

Before proceeding, you should register an account onEtherscan.io andgenerate a personal API key to use.

If you wish to have access to the PRO endpoints, you should obtain elevated privileges via Etherscan's subscription service.

Install from source:

pip install git+https://github.com/pcko1/etherscan-python.git

Alternatively, install fromPyPI:

pip install etherscan-python

Inbash, test that everything looks OK on your end using yourYOUR_API_KEY (without quotation marks) before proceeding:

bash run_tests.sh YOUR_API_KEY

This will regenerate the logs underlogs/ with the most recent results and the timestamp of the execution.

The tests also include the PRO endpoints so if your key is not PRO, the correspondings tests are expected to fail.

Inpython, create a client with your personalEtherscan.io API key:

frometherscanimportEtherscaneth=Etherscan(YOUR_API_KEY)# key in quotation marks

Then you can call all available methods, e.g.:

eth.get_eth_balance(address="0xddbd2b932c763ba5b1b7ae3b362eac3e8d40121a")>'40891631566070000000000'

You can also choose one of the other testnets:

eth=Etherscan(YOUR_API_KEY,net="ropsten")# net name is case-insensitive, default is main

Examples (arguments and results) for all methods may be found as JSON fileshere. For example, if you want to use the methodget_block_number_by_timestamp, you can find the supported arguments and the format of its output in its respectiveJSON file:

{"method":"get_block_number_by_timestamp","module":"blocks","kwargs": {"timestamp":"1578638524","closest":"before"  },"log_timestamp":"2020-10-28-12:34:44","res":"9251482"}

wherekwargs refer to the required named arguments andres refers to the expected result if you were to run:

eth.get_block_number_by_timestamp(timestamp="1578638524",closest="before")>'9251482'

Disclaimer: Those examples blindly use the arguments originally showcasedhere and the selected wallets/contracts do not reflect any personal preference. You should refer to the same source for additional information regarding specific argument values.

For problems regarding installing or using the package please open anissue. Kindly avoid disclosing potentially sensitive information such as your API keys or your wallet addresses.

Kotsias, P. C., pcko1/etherscan-python.https://github.com/pcko1/etherscan-python (2020). doi:10.5281/zenodo.4306855

or inbibtex:

@misc{Kotsias2020,author ={Kotsias, P.C.},title ={pcko1/etherscan-python},year ={2020},publisher ={Zenodo},url ={https://github.com/pcko1/etherscan-python},doi ={10.5281/zenodo.4306855}}

Feel free to leave a ⭐ if you found this package useful.

Powered byEtherscan.io APIs.