Welcome to ScanWatch 0.2.0ο
Noteο
This library is developed and maintained by EtWnn, feel free to drop your suggestions or remarks in the discussion tab. You are also welcome to contribute by submitting PRs.
- Source Code:
- Documentation:
Announcementο
π¨ π¨ π¨
If you previously used this library with a version inferior to 0.1.3, please head here to correct a potential bug in the database.
π¨ π¨ π¨
Quick Tourο
1. API Keysο
You will need to generate API tokens to use this library:
Ethereum chain: go on etherscan
Binance Smart chain: go on bscscan
Polygon chain: go on polygonscan
(If you want to use several chains, you will need an API token for each).
2. Installationο
ScanWatch
is available on PYPI, install with pip
:
pip install ScanWatch
You can also install the latest developments (not stable):
pip install git+https://github.com/EtWnn/ScanWatch.git@develop
3. Managerο
Example for Ethereum:
from ScanWatch.ScanManager import ScanManager
from ScanWatch.utils.enums import NETWORK
api_token = "<ETH_API_TOKEN>"
address = "<YOUR_ETH_ADDRESS>"
manager = ScanManager(address, NETWORK.ETHER, api_token)
Example for BSC:
from ScanWatch.ScanManager import ScanManager
from ScanWatch.utils.enums import NETWORK
api_token = "<BSC_API_TOKEN>"
address = "<YOUR_BSC_ADDRESS>"
manager = ScanManager(address, NETWORK.BSC, api_token)
Example for Polygon:
from ScanWatch.ScanManager import ScanManager
from ScanWatch.utils.enums import NETWORK
api_token = "<POLYGON_API_TOKEN>"
address = "<YOUR_POLYGON_ADDRESS>"
manager = ScanManager(address, NETWORK.POLYGON, api_token)
4. Transactions Updateο
Once the manager is setup, you can update the locally saved transactions:
manager.update_all_transactions()
# all transactions updated for address 0xaAC...748E8: 100%|ββββββββββββ| 4/4 [00:02<00:00, 1.86it/s]
This needs to be done only when new transactions have been made since the last time you called the update method.
5. Transactionsο
To fetch the transactions that have been previously saved, just use the methods below. (see the documentation for more details).
from ScanWatch.utils.enums import TRANSACTION
manager.get_transactions(TRANSACTION.NORMAL) # normal transactions
manager.get_transactions(TRANSACTION.ERC20) # erc20 transactions
manager.get_transactions(TRANSACTION.ERC721) # erc721 transactions
manager.get_transactions(TRANSACTION.INTERNAL) # internal transactions
6. Holdingsο
The manager can also give you the current tokens hold by an address:
For erc20 tokens:
manager.get_erc20_holdings()
{
'USDC': Decimal('50'),
'AllianceBlock Token': Decimal('12458.494516884'),
'Blockchain Certified Data Token': Decimal('75174'),
'Compound': Decimal('784.24998156'),
'ZRX': Decimal('3.1')
}
For erc721 tokens:
manager.get_erc721_holdings()
[
{
'contractAddress': '0x8azd48c9ze46azx1e984fraz4da9zz8dssad49ct',
'tokenID': '78941',
'count': 1,
'tokenName': 'SUPER NFT GAME',
'tokenSymbol': 'Hero'
},
{
'contractAddress': '0x6edd39bdba2fazs3db5fxd86908789cbd905f04d',
'tokenID': '33001',
'count': 1,
'tokenName': 'MY FAV NFT ARTIST HANDMADE THIS',
'tokenSymbol': 'dubious thing'
}
]
Main / test netsο
If you want to switch from main to test nets, you can specify the net name at the manager creation:
manager = ScanManager(address, <network>, api_token, <net_name>)
- Supported nets are:
For Ethereum: βmainβ, βgoerliβ, βkovanβ, βrinkebyβ, βropstenβ
For BSC: βmainβ, βtestβ
For Polygon: βmainβ, βtestβ
Donationο
BTC: 14ou4fMYoMVYbWEKnhADPJUNVytWQWx9HG
ETH, BSC, Polygon: 0xA20be1f02B1C9D4FF1442a0F0e7c089fcDd59407
LTC: LfHgc969RFUjnmyLn41SRDvmT146jUg9tE
EGLD: erd1qk98xm2hgztvmq6s4jwtk06g6laattewp6vh20z393drzy5zzfrq0gaefh