Skip to main content

A simple bot for scanning new ERC-20 token pools created and filtering them based on the time created, liquidity and market cap

Project description

Token Pool Bot

TokenPoolBot is a simple bot for scanning new ERC-20 token pools created and filtering them based on the time created, liquidity and market cap. On each run it shows potential good token pools based on the filters.

Disclaimer: These markets are volatile and this bot just filters the new pools. If you want to take action on the output of this code, you have to check each pool by yourself and do your own research

How to use

Install the package

pip install tokenfinderbot

Basic usage (default settings)

from tokenfinderbot.tokenfinderbot import TokenBot

# bot instance
bot = TokenBot()

# run with default settings
bot.run()

Advanced usage (edit settings): See Settings Section

from tokenfinderbot.tokenfinderbot import TokenBot

# bot instance
bot = TokenBot()

# get bot settings
settings = bot.get_settings()

# change bot settings
settings.time_filter.hour = 6 # time filter hour edit
settings.liq_mc_filter.min_liq = 1000 # liquidity/market cap filter edit for min. liquidity
settings.db_name = "test" # change json db filename

# set new settings
bot.set_settings(settings)

# run with new settings
bot.run()

Notify on telegram (You should have a telegram bot token and a chat id which the bot is a member)

from tokenfinderbot.tokenfinderbot import TokenBot

# bot instance
bot = TokenBot()

# get bot settings
settings = bot.get_settings()

# change bot telegram settings
settings.telegram.notify = True
settings.telegram.bot_token = "YOUR TELEGRAM BOT TOKEN" # your telegram bot token
settings.telegram.chat_id = "xxxxxxxxxx" # chat id for chat, group or channel which the bot is a memeber of

# set new settings
bot.set_settings(settings)

# run with new settings
bot.run()

Settings

Bot settings:

  • DB Name (settings.db_name): Name of the json file used as database. This project makes use of tinydb for database. (default: "db")

  • Time Filter (settings.time_filter): Time filter is used to accept only the pools that have been created less than x hours and y minutes ago. This filter setting includes:

    • Hours (settings.time_filter.hours): Hours (default: 12)
    • Minutes (settings.time_filter.minutes): Minutes (default: 0)
  • Liquidity/Market Cap Filter (settings.liq_mc_filter): Filter based on liquidity and market cap which includes three settings:

    • MarketCap/Liquidity Ratio (settings.liq_mc_filter.mc_liq_ratio): The minimum accepted ratio of marketcap/liquidity for the pool to be accepted. for example, 2 means the market cap must be at least 2 times the liquidity. (default: 1.5)
    • Min. Market Cap (settings.liq_mc_filter.min_mc): The minimum accepted marketcap in USD (default: 100000)
    • Min. Liquidity (settings.liq_mc_filter.min_liq): The minimum accepted liquidity in USD (default: 1000)
  • Update Interval (settings.update_interval): Time interval between each update of the database and calling APIs. Its unit is minutes (default: 15)

  • Telegram (settings.telegram): Telegram bot settings to get notifications on telegram:

    • Notify (settings.telegram.notify): This should be True in order to activate the telegram notifications. (default: False)
    • Bot Token (settings.telegram.bot_token): Your telegram bot token (default: "")
    • Chat ID (settings.telegram.chat_id): Your telegram chat id. The bot should be a member of this chat. it can be a private chat, group or channel (default: "")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tokenfinderbot-1.0.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tokenfinderbot-1.0.1-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file tokenfinderbot-1.0.1.tar.gz.

File metadata

  • Download URL: tokenfinderbot-1.0.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.4 Windows/10

File hashes

Hashes for tokenfinderbot-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6ba0a1b5f5ab2b2afafb64657ab4fa53aaaa339504c251737e8dd3b66aa3cc1d
MD5 355a17bd7655da20b4d6474da0e5be7e
BLAKE2b-256 40ea62c2b780e431d858b03c421db3eadfb9f87c63ab0a875f9703ca955f8e79

See more details on using hashes here.

File details

Details for the file tokenfinderbot-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: tokenfinderbot-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.4 Windows/10

File hashes

Hashes for tokenfinderbot-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9059be961ec6d9e4d74fd3c208da41a1bbb8c688a9d0cf22b05e58d2f3f1f0e8
MD5 280feb3d6418c073ba7e0858d07d4344
BLAKE2b-256 dcc592f3fdfc7854af47950d50ca7e769419d09a7cf5b0b072fa04d08ff95996

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page