Giter Site home page Giter Site logo

mactone / ftx-exchange-telegram-bot Goto Github PK

View Code? Open in Web Editor NEW
0.0 0.0 8.0 156 KB

A telegram bot to compound lending & staking at every hour with a switch to start/stop and view high lending rates for supported coins without the need to search high & low with the unintuitive table on the FTX Pro mobile app.

License: MIT License

Shell 0.37% JavaScript 99.63%

ftx-exchange-telegram-bot's Introduction

FTX-Telegram Bot ReadMe

A readme on how to set up and use FTX-Telegram hourly auto compounding lending & staking bot.

Table of contents

Setup

(Back to top)

Environment Required

  • A machine with nodejs or docker installed

Create a telegram bot

  1. Chat with BotFather
  2. BotFather will give you a token, something like 123456789:AbCdfGhIJKlmNoQQRsTUVwxyZ.
  3. Paste the token under the .env file

Create a FTX API & enable spot margin trading

  1. Head over to https://ftx.com/profile
  2. Select the API tab
  3. Create API Key
  4. Copy both the key and paste it under the .env file
  5. Make sure none of the permissions are enabled
  6. Select the Margin tab
  7. Click on "Enable Spot Margin Trading"

*(Optional) - Create a sub account and specific it on the .env will allow you to segregate your lending.

Environment Variables

.env to be place in the same location as index.js

BOT_TOKEN=telegram-bot-token-here
FTX_KEY=ftx-api-key-here
FTX_SECRET=ftx-api-secret-here
FTX_SUB=ftx-sub-account-here        #Optional

Setting up

Setting up with docker

docker pull koodies/ftx-exchange-telegram-bot:1.2.0
docker run --env-file .env -d koodies/ftx-exchange-telegram-bot:1.2.0

Additional help: Set up docker on windows

Setting up with nodejs

Additional help: Setting up nodejs

Setting up on AWS [Coming Soon]

Ready to spin

  1. Start a chat with your bot, link to the chat can be found on bot creation with BotFather
  2. Enter /init to start populating your lending & staking list
  3. Run /startlend or /startstake to start compounding!

Menu

(Back to top)

Main

(Back to top) All commands under main are global commands

Command Description
/watch Enter the watch list scene
/lend Enter the lending scene.
/stake Enter the staking scene.
/update Update the local database of coins
/init Add coins with balance in current wallet into lending/staking list
/balance View your current balance in your FTX account.
/whois Query the full name of the coin.
/startlend Start the hourly lending cron job
/startstake Start the hourly staking cron job
/stoplend Stop the hourly lending cron job and remove all funds from the lending pool
/stopstake Stop the hourly staking cron job
/dispalylogs Display last 5 logs

Watchlist

(Back to top)

Command Description
/list list all the coins available for lending on FTX
/show Display current watchlist saved locally
/add [ticker] Issue a /add USD command to add coin to your watchlist
/remove [ticker] Issue a /remove USD command to remove coin from your watchlist
/back Head back to the main menu

Lending

(Back to top)

Command Description
/list List all the coins available for lending on FTX
/top10 List the first 10 highest rate coins inclusive of tokenize stocks
/top10crypto List the first 10 highest rates crypto coins
/watchlist List all the rates of the coins under your watchlist
/add [ticker] Issue a /add USD command to add USD into the lending list
/remove [ticker] Issue a /remove USD command to remove USD from the lending list
/show Display current staking list
/back Head back to the main menu

Staking

(Back to top)

Command Description
/list Issue a /list command to list the coins available for staking on FTX
/add [ticker] Issue a /add USD command to add USD into the staking list
/remove [ticker] Issue a /remove USD command to remove USD from the staking list
/show Display current staking list
/back Head back to the main menu

Troubleshooting

(Back to top)

Others

(Back to top)

Authors

Koodies

Tip me a Cup of Coffee

Use my referral FTX Referral
Tip me via FTX

References

FTX API

ftx-exchange-telegram-bot's People

Contributors

koodies avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.