Skip to content

A trader’s trusted sidekick for navigating financial markets. Designed to cut through complexity, it empowers all traders to make data-driven decisions with ease. Our intuitive platform simplifies charts and metrics, providing clear, actionable insights. Say goodbye to overwhelm and hello to confident trading

License

Notifications You must be signed in to change notification settings

ayeniswe/TraderCompanion

Repository files navigation

128x128@2x

    TraderCompanion

🎉 Demo

TraderCompanion.mp4

✅ Getting Started

Prerequisites

  • A valid email address
  • An Alpaca account (you'll create one in the steps below)

Step 1: Create Your Alpaca Account

  1. Go to the Alpaca Website.

  2. Click on the # button located in the top-right corner of the page.

  3. Follow the on-screen instructions to complete the registration process.

    You will receive a confirmation email to verify your email address. Follow the instructions in the email to complete the verification.

Step 2: Access Your API Key and Secret

  1. Once logged in, navigate to Home on the left-hand sidebar.

    On mobile, you may need to click the three-line menu button in the top-left corner to access the sidebar.

  2. Scroll down until you find the option to Generate New API Key.

    If you don't see it right away, keep scrolling.

  3. Click the button to generate your API Key and Secret Key.

    Important: Be sure to copy both the API Key and Secret Key for later use with TraderCompanion, as the Secret Key will only be shown once.

Step 3: Activate TraderCompanion

  1. Install/Open the application

    Important: If you prefer not to install the application on your device, we offer standalone options:

    • Linux: Use the .appimage file
    • Windows: Use the .zip file

    This allows you to run the application without needing a full installation!

  2. Wait for activation screen to show

  3. Enter your API Key into the first input box.

  4. Enter your Secret Key into the second input box.

  5. If the activation screen goes away you have now finish activation and may move to the Usage Guide

📖Usage Guide

Ticker Trend Overview

This app provides a quick, at-a-glance representation of the trends for any stock ticker in three different time frames: Long-term, Medium-term, and Short-term. The trends are visualized using icons composed of three circles, each representing one of the time frames.

Icons and Color Representation

The icon consists of three circles in the following order:

Icon Explanation

  1. Left Circle: Long-term trend
  2. Middle Circle: Medium-term trend
  3. Right Circle: Short-term trend

Colors Explanation

  • Green: The trend is upward (bullish).
  • Red: The trend is downward (bearish).
  • Yellow: The trend is in a range (neutral or sideways movement).
  • White: The trend is unknown (insufficient data or indeterminate).

Ideal Scenario

  • The ideal combination to look for is: Green - Green - Red.
    • Long-term (green): The stock is trending upward in the long run.
    • Medium-term (green): The stock continues its upward trend in the medium run.
    • Short-term (red): There may be a short-term pullback or correction, but it is potentially an opportunity to enter at a better price.

Usage Instructions

  1. Select the Ticker: Select + New enter the stock ticker symbol you want to analyze.
  2. Review the Icon: The app will generate an icon with the color-coded trends for the three trend terms.
  3. Interpret the Trends:
    • Green-Green-Red: Long-term and medium-term trends are upward, but there might be a short-term dip. This is usually considered an optimal setup.
    • Other combinations: Use the color indicators to judge whether the stock is in an uptrend, downtrend, or range in different time periods.

Legend

Icon Explanation
🟢 🟢 🔴 Ideal Scenario - Long-term and medium-term trends are up, short-term correction.
🟡 🔴 🟢 Long-term in range, medium-term downtrend, short-term uptrend.
🔴 🔴 🟡 Bearish in both long-term and medium-term, neutral short-term movement.

Additional Notes

  • White circles indicate a lack of data for the corresponding time frame. If the trend is unknown, further analysis or waiting for more data might be necessary.
  • The app automatically updates trend data based on real-time market analysis to keep your insights current.

About

A trader’s trusted sidekick for navigating financial markets. Designed to cut through complexity, it empowers all traders to make data-driven decisions with ease. Our intuitive platform simplifies charts and metrics, providing clear, actionable insights. Say goodbye to overwhelm and hello to confident trading

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published