robin_stocks

Robin Stocks is a pure Python interface designed to provide simple-to-use functions for interacting with the Robinhood API. It requires Python 3. The library is intended for users who want to build automated robo-investors or view real-time stock information.

CRITICAL WARNING: The functions in this library make real-time calls to your Robinhood account. Unlike the official Robinhood mobile app, these commands do not provide warnings before executing a buy, sell, or cancel order. You are responsible for the commands you execute.

The library provides separate modules for each supported API. You can import them as follows:

• robin_stocks.robinhood for Robinhood interactions.
• robin_stocks.gemini for Gemini cryptocurrency interactions.
• robin_stocks.tda for TD Ameritrade interactions.

To secure your API credentials, robin_stocks encrypts them in a local pickle file using a passcode. You must generate this passcode once and store it securely (e.g., in a .env file) to use for all future logins.

To generate a new passcode, use tda.generate_encryption_passcode().

import robin_stocks.tda as tda
passcode = tda.generate_encryption_passcode()
print("my secret passcode is ", passcode)

To use the library, import robin_stocks. It is recommended to use import robin_stocks rather than from robin_stocks import * to avoid namespace collisions.

To authenticate, use robin_stocks.robinhood.login(username, password). If you have Multi-Factor Authentication (MFA) enabled, you can provide the MFA code programmatically using the mfa_code parameter.

If you want to modify the package or experiment with local changes, clone the repository and install it in editable mode using pip install ..

git clone https://github.com/jmfernandes/robin_stocks.git
cd robin_stocks
pip install .

The tda.login_first_time() function must be called exactly once in the lifetime of your setup. It saves your authentication and refresh tokens to a pickle file in your home directory. After running this once, you should remove the code from your scripts.

You will need:

1. Your encryption passcode.
2. Your application consumer key (from the TDA developer dashboard).
3. An authorization token.
4. A refresh token.

Warning: Do not call this function every time you run a script. It is recommended to run it once from a Python interpreter in your terminal.

import robin_stocks.tda as tda
tda.login_first_time("my-encryption-passcode", "my-application-consumer-key",
    "my-authroization-token", "my-refresh-token") # ONLY CALL ME ONCE. EVER.

If you use Time-based One-Time Passwords (TOTP), you can automate the login process using the pyotp library.

1. In your Robinhood account settings, enable 2FA and select "other" to get an alphanumeric secret code.
2. Use pyotp to generate the current token using that secret.
3. Pass the token to the mfa_code parameter in r.login().

Note: It is highly recommended to add this secret to an authenticator app (like Google Authenticator) on your phone so you can access your account if you are away from your computer.

import pyotp
import robin_stocks.robinhood as r

# Replace 'My2factorAppHere' with your alphanumeric secret code
totp = pyotp.TOTP("My2factorAppHere").now()
login = r.login('joshsmith@email.com','password', mfa_code=totp)

The simplest way to install the robin_stocks library is using pip. You can install it globally or within a virtual environment by running the following command in your terminal:

$ pip install robin_stocks