/CryptoWhitelistBuilder

This script automates the process of creating a whitelist for Freqtrade by comparing symbols available on Binance with those listed on CoinMarketCap and generating a Freqtrade-compatible whitelist file containing the common symbols found in both sources.

Primary LanguagePython

CryptoWhitelistBuilder

Introduction

CryptoWhitelistBuilder is a Python script designed to streamline the process of creating a whitelist file for Freqtrade, a cryptocurrency trading bot. The script fetches cryptocurrency symbols from two prominent sources Binance and CoinMarketCap, compares them and generates a Freqtrade-compatible whitelist file containing symbols common to both sources.

How is this useful? Using endpoints from CoinMarketCap you can automatically pull lists of caterogised symbols from established Capital portfolios like Fenbushi, Huobi or our friends at Kenetic. You could pull full lists of symbols relating to specific Cryptocurrency Ecosystems like Ethereum or Bitcoin. Heck you could use this script to create a whitelist of Meme or NFT symbols if thats your thing LOL!

In any event this tool aims to simplify the creation of a whitelist by automating the retrieval of symbols quoted in USDT from Binance and CoinMarketCap and identifying the overlapping symbols between the two datasets. By doing so, it facilitates the configuration process for Freqtrade users, enabling them to focus on optimizing their trading strategies.

Installation

Prerequisites

Ensure you have Python 3 installed on your system. This script also requires 'requests' However the script will check if its installed and automatically install it for you if its missing. All other libraries are part of Python 3 so thats all you should need to use this script.

Steps

  1. Clone the Repository:
    2.       git clone https://github.com/InfiniteEnd/CryptoWhitelistBuilder.git
  2. Update API Keys:

    3. Open the script file (CryptoWhitelistBuilder.py) in a text editor. Replace api_key with your CoinMarketCap API key.

    A CoinMarketCap API key is mandatory to use this script. Thankfully its completely free and you just need to create a CoinMarketCap developer account to get one.

    Follow the link below for a quickstart guide on how to do that

          https://coinmarketcap.com/api/documentation/v1/
  3. Run the Script:
    4.       python3 CryptoWhitelistBuilder.py
  4. Check Output:

    5. The script will attempt to fetch symbols from Binance and CoinMarketCap, find common symbols, and generate a new whitelist file named whitelist-binance.json in the script's directory.

  5. Usage Notes:
    • Ensure a stable internet connection during execution for proper API interactions.
    • Customize the script as needed for your specific Freqtrade setup or requirements.

License

"Software is like sex, it's better when it's free!" -Linus Torvalds