Skip to content

prakharmosesOK/Trading_Bot

Repository files navigation

Trade Bot

📖 Introduction

Welcome to our Trade Bot, a powerful tool designed to perform real-time trades in the market using advanced algorithms powered by Machine Learning. This README will guide you through the setup, features, and usage of our Trade Bot.

📝 Table of Contents

  1. Overview
  2. Features
  3. Installation
  4. Usage
  5. Algorithm Details
  6. Risk Management
  7. Contributing
  8. Authors
  9. License

📝 Overview

Our Trade Bot leverages cutting-edge algorithms to analyze market trends, identify potential trading opportunities, and execute trades in real time. The goal is to maximize profits while minimizing risks, making it an invaluable tool for both novice and experienced traders.

✨ Features

  • Cutting Edge Strategies: The bot employs sophisticated strategies to analyze market data and make informed trading decisions.
  • Machine Learning Algorithms: The devised strategies to leverage Machine Learning to yield optimal outcomes.
  • Real-Time Trading: Execute trades in real-time to capitalize on market fluctuations.
  • Risk Management: Implement robust risk management techniques to protect your investments.

📲 Installation

Follow these steps to set up the Trade Bot on your system:

  1. Clone the repository:

    git clone https://github.com/codeclubiittp/Trading_bot.git
  2. Install dependencies:

    cd Trading_bot
    pip install -r requirements.txt
  3. Set up API keys:

    • Obtain API keys from your preferred stock exchange. We recommend Alpaca.
  4. Navigate to frontend and install dependencies and then start:

    cd frontend
    npm install
    npm start

🧑🏽‍💻 Usage

Run the bot with the following command in the root folder: bash uvicorn main:app --reload --host 0.0.0.0 --port:8000

Monitor the bot's output for real-time updates, trade executions, and performance metrics.

Using the Trading Bot Web Service

This document outlines how to interact with the trading bot web service, which is built using Python, FastAPI, and SwaggerUI.

🚀 Live Link:

Live link to our web service.

📜 Accessing the API Documentation:

Visit the live link provided above. You'll be presented with the SwaggerUI interface, which provides interactive documentation for the API endpoints. The window may look like below: image

Authentication (if applicable):

🎬 If you are a new user then register using the POST request as shown in the video below.

Register.User.mp4

🎬 If already registered then authenticate as shown.

Login.User.mp4

🎬 Demo Video of the site

https://youtu.be/n2K_I6KyXKw?si=Qo0uuGHkcFWSYW3Z

📎 Available Endpoints:

  1. GET /strategies:
  • Description: Get a list of all available trading strategies supported by the bot.
  • Status code: 200 (OK)
  • Response model: List[Strategy] (an array containing information about each strategy, including strategy name, description, and key parameters)
  1. POST /orders:
  • Description: Place a new trade order for the bot to execute.
  • Body: Order (containing details like symbol, order type, amount, price)
  • Status code: 201 (Created)
  • Response model: Order (confirmation of the submitted order, including order ID and estimated execution time)
  1. GET /status:
  • Description: Check the current status and performance of the trading bot.
  • Status code: 200 (OK)
  • Response model: BotStatus (providing information like current positions, open orders, account balance, total profit/loss, and key performance indicators)

Additional Information:

Please use it at your own risk.

Contact Information:

For any related queries contact: [email protected]

📋 Algorithm Details

Our algorithms are designed using Machine Learning, historical market data, technical indicators, and other relevant factors to make perfect trading signals.

🦟 Risk Management

The investments are protected by implementing effective risk management strategies. Risk thresholds, stop-loss parameters, and other useful settings to align with your risk tolerance.

👷 Contributing

We welcome contributions from the community. Feel free to submit bug reports, feature requests, or even pull requests to help improve the Trade Bot.

🎓 Author

Adnan Abbas Rizvi (Team Leader)

Prakhar Moses

Nandhavardhan

📰 License

This Trade Bot is licensed under the MIT License. Feel free to use, modify, and distribute it as per the terms of the license.

Happy trading! 🚀

About

A repository to test our trading bot

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors