README.md

Program Trading Based on Webull

Market data from Webull and Yahoo! Build your own strategy, and let the program trade for you with your Webull account.

⚠️ 0. Disclaimer and Security

• This App is not affiliated with Webull Financial LLC.
• The Webull API used in this App is from:
  • https://pypi.org/project/webull/ (Pypi.org)
  • https://github.com/tedchou12/webull (Github, by tedchou12)
  • Simply speaking, this API is like simulating you are using the Webull web platform.
• The official Webull API is still under testing. This App will switch to the official API when it is ready.
• The App GUI is developed via Tkinter-Designer, an easy and fast way to create a Python GUI.
• Feel free to fork and edit the code to customize the App for your own use.

• For security:
  • Do NOT save your password and PID locally. Type it when you log in.
  • Do NOT upload or share the credential JSON files generated by the App.
  • The access_token will expire weekly for your account security, you need to re-login to set up a new one.

• If you don't have Webull account, feel free to use my referral link to sign up, you can get 12 free stocks after depositing $0.01 or more.

• Give repository a star if it helps~

🤖 1. Install

🐍 1.1 Install Python

Use the link below to download and install Python. (Make sure to add Python to your system PATH during the installation)

https://www.python.org/downloads/

💾 1.2 Clone this repository

git clone https://github.com/LukeWang01/Program-Trading-Based-on-Webull.git

or,

Download the Zip file and unzip to a folder.

💽 1.3 Install the required packages:

pip install -r requirements.txt

or,

pip3 install -r requirements.txt

If got errors when installing (click here)

🚀 2. Run

2.1 Launch the App

Go to the Program-Trading-Based-on-Webull folder, open the terminal,

python app.py

or,

Double-click the app_launcher.bat to run. (Windows only)

2.2 First-time launch setup (Setup only once for the Authentication)

Instructions for the first run setup (click here)

💲 3. Build your own strategy

You can create your strategy following the example strategy:

Program-Trading-Based-on-Webull/strategy/My_Strategy.py (Click here to open)

Just override the strategy_decision() function in the My_Strategy class, and add any attributes you need.

Run your strategy and make tradings after logging in:

🖥️ 4. App Features

4.1 Log in

4.2 Account Dashboard

4.3 Select and run strategy, monitor the market and strategy

4.4 Edit your profile settings, add notification email account

4.5 View the trading orders and transaction history

4.6 View the performance of your strategy or account

4.7 View the App running log

4.8 Edit the notification email account settings

4.9 Download the stock intraday and history data, saving as csv file

4.10 Safe exit the App

Feel free to edit the code to customize the App for your own use.

Good luck to all traders!

Luke

🦋 Supporting Me