Repository files navigation

A minimal, yet complete, python API foretherscan.io.

All of thefree GET endpoints from the following modules 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 and generate a personal API key to use.

Assumingconda is already installed on your system, first create the environment:

conda env create -f env.yml

Activate the environment:

conda activate etherscan-python

Then, install the package:

pip install.

Test that everything looks OK on your end before proceeding:

coverage run -m unittest discover&& coverage report -m

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

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

frometherscanimportEtherscanapi_key=YOUR_API_KEYconfig_path="etherscan/configs/stable.json"eth=Etherscan.from_config(config_path,api_key)

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

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

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-09-30-15:39:18","res":"9251482"}

wherekwargs refer to the required 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 views. 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.

Powered byEtherscan.io APIs.