Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
uppusaikiran authored Aug 17, 2024
1 parent cfc911a commit 691eee8
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,40 @@ A comprehensive tool for analyzing stock transactions and portfolio performance,
- **Historical Data Visualization:** Fetch and plot historical stock prices, highlighting key buy/sell points and trends.
- **Integration with Robinhood:** Optionally generate transaction data from Robinhood using MFA authentication.

## Setting Up Multi-Factor Authentication (MFA) for Robinhood

### 1. Install a TOTP App
To enable MFA for your Robinhood account, you'll need a Time-based One-Time Password (TOTP) application, such as Google Authenticator, Authy, or any other TOTP-compatible app.

### 2. Enable MFA on Robinhood
1. **Log in to Robinhood**: Open the Robinhood app or website and log in to your account.
2. **Go to Security and Privacy Settings**: Navigate to your Account -> Settings -> Security and privacy.
3. **Enable Two-Factor Authentication**:
- Find the Two-Factor Authentication (2FA) or Multi-Factor Authentication (MFA) option.
- Follow the prompts to enable MFA with Authenticator App.
4. **Scan the QR Code**:
- Robinhood will show you a QR code.
- Open your TOTP app and scan the QR code to add your Robinhood account.
- The app will start generating time-based codes for Robinhood.

### 3. Retrieve Your TOTP Secret
- In the same security section where you enabled MFA, you should be able to see or generate a backup key or secret key (usually a 16-character string).
- Copy this secret key.

### 4. Add `robin_mfa` to `.env` File
1. **Create or Open the `.env` File**: If you don’t already have a `.env` file in your project directory, create one. This file will store your environment variables.
2. **Add Your Robinhood Credentials**:
- Open the `.env` file in a text editor.
- Add the following line, replacing `YOUR_TOTP_SECRET` with the secret key you copied earlier:


### 5. Using MFA in Your Application
When you run your application, the robin_mfa variable will be used to generate a TOTP code automatically, which is required for logging in to Robinhood.

### 6. Testing the MFA Setup
Run your application and verify that it logs in successfully using the generated TOTP code. If you encounter any issues, double-check that the robin_mfa value in your .env file is correct.


## Setup and Installation

1. **Clone the Repository:**
Expand Down

0 comments on commit 691eee8

Please sign in to comment.