Introduction

• This project aims to scrape crypto token's information from some of the most popular exchanges or cryptocurrency data aggregator

Setup

• Run the following command to install the necessary dependencies

pipenv install

1. Token Info Generator

• Retrieve token's information based on either SYMBOL, NAME or ADDRESS
• Chains and Networks covered currently:

1. Arbitrum
2. Astar
3. Aurora
4. Avalanche
5. Binance Smart Chain
6. Celo
7. Cronos
8. DeFi Kingdoms
9. Ethereum
10. Fantom
11. Fuse
12. Harmony
13. Heco
14. Iotex
15. Kucoin
16. Metis
17. Milkomeda
18. Moonbeam
19. Moonriver
20. Oasis
21. OEC
22. OPtimisim
23. Polygon
24. Telos
25. Velas

Information Generated

Field	Example
Token details	name, network, address, symbol, decimals, holders count, total supply
Pricing details	price, volume, liquidity
Gas details	gas price, cumulative gas used
Pairing details	pairing address, exchange, pair type, base and target token's info

Usage

>>> from src.data_aggregator import TokenInfoGenerator

>>> MyTokenInfoGenerator = TokenInfoGenerator()
... search_string = "APE"
... for index,token in enumerate(MyTokenInfoGenerator.get_tokens(search_string)):
...     # print all token's address with "APE" as symbol or similar
...     print(f"({index}) {token["name"]}; {token["network"]}; {token["address"]}")

(0) ApeCoin; ethereum; 0x4d224452801aced8b2f0aebe155379bb5d594381
(1) APE MOON; bsc; 0xf5b21a18a510cd315dd9f46d3c117321f1851d51
(2) BORD APE NIKE TOKEN; polygon; 0x9a575498ce240fe43504f53d68eef6440f0cf280
(3) Ape-X; avalanche; 0xd039c9079ca7f2a87d632a9c0d7cea0137bacfb5
...

Parameteres

1. search_string: str, token's name, symbol, or address that wanted to be searched

2. Honeypot Validator

• Determine if a token is a honeypot (crypto scam)
• Chains and Networks supported currently:

1. Binance Smart Chain
2. Ethereum
3. Fantom
4. Polygon

Usage

>>> from utils.honeypot import HoneypotValidator

>>> MyHoneypotValidator = HoneypotValidator()
... network = "Binance Smart Chain"
... address = "0x7ccE94C0B2C8aE7661f02544E62178377Fe8cF92"
... honeypot_result = MyHoneypotValidator.check_honey(network = network,address = address )

# based on 2 honeypot sources, 2 failed to detected honeypot, 0 detected honeypot
{'message': 'Checked 2 honeypot source(s)', 'non_honeypot': 2, 'is_honeypot': 0}

Parameteres

1. network: str, must be either of one of the 4 networks above
2. address: str, token's address that would like to check for honeypot

3. GameFi Token Info Generator

By Category

• Retrieve GameFi token's info based on CATEGORY
• Example of GameFi token's category:

1. 2D PvP battler
2. 3D
3. Action
4. Adventure
5. Battle
6. Card
7. Collectibles
8. Combat
9. Idle Game
10. Fantasy
11. Metaverse
12. MOBA
13. MMORPG
14. NFTs
15. Party Game
16. Play to Earn
17. Puzzle
18. Racing
19. Real-Time Strategy
20. Role Playing
21. Simulation
22. Strategy
23. Tower Defense
......
and more

Information Generated

Field	Example
GameFi Token details	game name, network, address, category, description, etc.
IGO details	IGO date, type, IGO link, IGO price, IGO ROI
Pricing details	price, price changed 24h, price volume_24h, market capitalization
Important Links	offical website link, android link, IOS link, web game link
Social Media	twitter, medium, discord, telegram
Coin Market Cap	CMD ID, CMC slug, CMC rank

Usage

>>> from utils.gamefi import GameFiScraper

>>> MyGameFiScraper = GameFiScraper()
... category_list = ["3D","Card"]
... for index, gamefi_token in enumerate(MyGameFiScraper.search_by_category(category_list)):
...     print(f"({index}) {gamefi_token["game_name"]}; 
...         {gamefi_token["category"]}; {gamefi_token["description"]}")

(0) Splintershards; Card,Collectibles; Splinterlands is a unique digital trading card game that allows players to truly own their cards and other in-game assets.
(1) Gods Unchained; Card,Collectibles,Metaverse; Gods Unchained is a free-to-play tactical card game that gives players true ownership of their in-game items.
(2) Mytheria - Clash of Pantheons; Card,Turn-Based Strategy,Strategy; Mytheria is the first NFT game offering an exclusive Create to Earn feature for artists all over the world, with the name GodForge
...

Parameteres

1. category: list, list of GameFi tokens category to filter (input is NOT case sensitive, eg: if we feed "2D" it will return filter results for "2D PvP battler" as well)

4. NFT Info Generator

• Retrieve NFTs related information (NFT Collection, NFT User, Hot & Trending NFTs etc.)

Categories

(A) NFT Collection

1. Collection Activity (Sell,Buy,Mint,etc)
2. Collection Assets
3. Collection Details
4. Collection Holders

(B) NFT User

1. User Activity (Sell,Buy,Mint,etc)
2. User NFT Collection
3. User Gallery

(C) NFT Gas

1. Get current Gas price
NFT Whales (category):
1. Smart Money 
2. Famous
3. Art Blocks
4. Bored Ape Yacht Club
5. Crypto Punks

(D) Hot & Trending NFTS

1. Hot Selling Ranking
2. Volume Ranking
3. Smart Money Buys Ranking
4. Hot Minting Ranking
5. Whales Minting Ranking
6. Gainers Ranking
7. Discounts Ranking

Usage

>>> from utils.nft import NftScraper

>>> MyNftScraper = NftScraper()
... for index, nft in enumerate(MyNftScraper.get_hot_minting_ranking(limit =10)):
...     print(f"({index}) {nft["name"]}; {nft["minters"]}; {nft["volume_in_24h"]}")

(0) McLaren MSO LAB Genesis; 44; 16.544000000000004
(1) Hedgies; 11; 9.0534
(2) GENE_SIS: The Girls of Armament; 8; -18.3
...

Parameteres

1. user_address: str, target NFTs user_address that wish to scraped
2. collection_id: str, target NFTs collection_id that wish to scraped
3. proxy_dict: dict, proxies to used to when scraping
4. limit_per_page: int, maximum number of records to return when making GET request to API endpoint everytime, default is set to 20
5. limit: int, maximum number of records wanted to scrape, default is set to 50

• for other parameters please refer to the relevant function guides