etherscan-python

A minimal, yet complete, python API for etherscan.io.

---

All of the free GET endpoints from the following modules are provided:

Accounts

• get_eth_balance
• get_eth_balance_multiple
• get_normal_txs_by_address
• get_normal_txs_by_address_paginated
• get_internal_txs_by_address
• get_internal_txs_by_address_paginated
• get_internal_txs_by_txhash
• get_internal_txs_by_block_range_paginated
• get_erc20_token_transfer_events_by_address
• get_erc20_token_transfer_events_by_contract_address_paginated
• get_erc20_token_transfer_events_by_address_and_contract_paginated
• get_erc721_token_transfer_events_by_address
• get_erc721_token_transfer_events_by_contract_address_paginated
• get_erc721_token_transfer_events_by_address_and_contract_paginated
• get_mined_blocks_by_address
• get_mined_blocks_by_address_paginated

Contracts

• get_contract_abi
• get_contract_source_code

Transactions

• get_contract_execution_status
• get_tx_receipt_status

Blocks

• get_block_reward_by_block_number
• get_est_block_countdown_time_by_block_number
• get_block_number_by_timestamp

GETH/Parity Proxy

• get_proxy_block_number
• get_proxy_block_by_number
• get_proxy_uncle_by_block_number_and_index
• get_proxy_block_transaction_count_by_number
• get_proxy_transaction_by_hash
• get_proxy_transaction_by_block_number_and_index
• get_proxy_transaction_count
• get_proxy_transaction_receipt
• get_proxy_call
• get_proxy_code_at
• get_proxy_storage_position_at
• get_proxy_gas_price
• get_proxy_est_gas

Tokens

• get_total_supply_by_contract_address
• get_acc_balance_by_token_and_contract_address

Gas Tracker

• get_est_confirmation_time
• get_gas_oracle

Stats

• get_total_eth_supply
• get_eth_last_price
• get_eth_nodes_size

Installation

Before proceeding, you should register an account on etherscan.io and generate a personal API key to use.

Assuming conda 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 .

Run unittests

Test that everything looks OK on your end before proceeding:

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

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

Usage

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

from etherscan import Etherscan

api_key = YOUR_API_KEY
config_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

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

{
  "method": "get_block_number_by_timestamp",
  "module": "blocks",
  "kwargs": {
    "timestamp": "1578638524",
    "closest": "before"
  },
  "log_timestamp": "2020-09-30-15:39:18",
  "res": "9251482"
}

where kwargs refer to the required arguments and res refers to the expected result if you run:

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

Disclaimer: Those examples blindly use the arguments originally showcased here 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.

Issues

For problems regarding installing or using the package please open an issue. If you think that a newly-added method is missing, also open an issue as a feature request and I will do my best to add it. Kindly avoid disclosing potentially sensitive information such as your API keys or your wallet addresses.

---

Powered by Etherscan.io APIs.