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: "")
    • Min. Liquidity (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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tokenfinderbot-1.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 716ef887cf6ba4d3dbcdd65d650d1800e5d3eec030b83f8b6b2d81937ef1eb97
MD5 33d3415175b38a5d3819917e13950aec
BLAKE2b-256 0315421684c36d509997f44ce77ba6995c2b1c8eb551ed00f414016bf084017f

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