Skip to main content

A modern, reliable Python client for the Robinhood API

Project description

pyhood

pyhood logo

A modern, reliable Python client for the Robinhood API.

CI PyPI Docs Python 3.10+ License: MIT Coverage Security Code style: ruff

A modern, reliable Python client for the Robinhood API.

Built for automated trading — with auth that doesn't break, proper error handling, and sane defaults.

Why pyhood?

  • 🪙 Dual API support — The only Python library that wraps both Robinhood's unofficial stocks/options API and their official Crypto Trading API. One library, full coverage.

  • 🔐 Auth that just works — Login with timeouts, automatic token refresh, and session persistence. Authenticate once, stay connected for days. No more scripts that hang forever waiting for device approval.

  • 🔄 Automatic token refresh — pyhood uses OAuth refresh tokens to renew your session silently — no credentials, no device approval, no human in the loop. Built for unattended automation.

  • 🏷️ Type hints everywhere — Full type annotations, dataclass responses, IDE-friendly. No more guessing what's in a dict.

  • 🛡️ Built-in rate limiting — Automatic request throttling and retry logic so you don't get locked out.

  • 📊 Options-first — Deep options chain support with Greeks, volume/OI analysis, and earnings integration.

  • 🧪 Tested and maintained — 86+ tests, CI across Python 3.10-3.13, linted with ruff. If it breaks, we know immediately.

Quick Start

import pyhood
from pyhood.client import PyhoodClient

# Login (with timeout — never hangs)
session = pyhood.login(username="you@email.com", password="...", timeout=90)
client = PyhoodClient(session)

# Stock data
quote = client.get_quote("AAPL")
print(f"AAPL: ${quote.price:.2f} ({quote.change_pct:+.1f}%)")

# Options chains
chain = client.get_options_chain("AAPL", expiration="2026-04-17")
for option in chain.calls:
    print(f"  {option.strike} call | IV: {option.iv:.0%} | Delta: {option.delta:.2f}")

# Account
positions = client.get_positions()
balance = client.get_buying_power()

Authentication

Robinhood requires device approval on first login. After that, pyhood keeps your session alive automatically.

First Login

  1. Have the Robinhood mobile app open on your phone
  2. Call pyhood.login() — it will trigger a device approval request
  3. Tap "Yes, it's me" in the Robinhood app when prompted
  4. pyhood saves the session token to ~/.pyhood/session.json for reuse
import pyhood

# First login — will wait up to 90s for you to approve on phone
session = pyhood.login(
    username="you@email.com",
    password="your_password",
    timeout=90,  # seconds to wait for device approval
)

Staying Authenticated

Once you've approved the device, pyhood handles the rest:

# Reuses cached session — no approval needed
session = pyhood.login(username="you@email.com", password="your_password")

# Or refresh explicitly — no credentials needed at all
session = pyhood.refresh()

Sessions last several days (observed 5-8 days). When the access token expires, pyhood automatically refreshes it using the stored refresh token — no device approval, no credentials, no human interaction. This is what makes pyhood safe for automated scripts and cron jobs.

Device approval is only needed again if the refresh token itself expires (typically much longer than the access token).

Error Handling

pyhood raises specific exceptions so you know exactly what went wrong:

from pyhood.exceptions import (
    LoginTimeoutError,            # Timed out waiting for device approval
    DeviceApprovalRequiredError,  # Approval prompt sent but not completed
    MFARequiredError,             # SMS/email code needed — pass mfa_code parameter
    TokenExpiredError,            # Refresh token expired — full re-login needed
    AuthError,                    # Generic auth failure
)

try:
    session = pyhood.login(username="...", password="...", timeout=90)
except LoginTimeoutError:
    print("Open Robinhood app and approve the device, then try again")
except MFARequiredError:
    code = input("Enter the code from SMS/email: ")
    session = pyhood.login(username="...", password="...", mfa_code=code)
except AuthError as e:
    print(f"Login failed: {e}")

⚠️ Rate Limits

Robinhood aggressively rate-limits authentication. If login fails:

  • Do NOT retry immediately — wait at least 5 minutes
  • 2-3 failed attempts will lock out your account's API access for 5-10 minutes
  • Each login attempt generates a new device approval — old approvals don't carry over
  • See the Rate Limits documentation for details

Install

pip install pyhood

Crypto Trading (Official API)

pyhood also supports Robinhood's official Crypto Trading API — no device approval needed, just API keys.

from pyhood.crypto import CryptoClient

# API key auth — generate keys at robinhood.com/account/crypto
crypto = CryptoClient(api_key="rh-api-...", private_key_base64="...")

# Market data
quotes = crypto.get_best_bid_ask("BTC-USD", "ETH-USD")
price = crypto.get_estimated_price("BTC-USD", "buy", 0.001)

# Account & holdings
account = crypto.get_account()
holdings = crypto.get_holdings(account.account_number, "BTC")

# Place an order
order = crypto.place_order(
    account_number=account.account_number,
    side="buy",
    order_type="market",
    symbol="BTC-USD",
    order_config={"asset_quantity": "0.001"},
)

Generate your API keys at robinhood.com/account/crypto. See the Crypto documentation for full details.

Development Status

🚧 Early development

  • ✅ Stocks/options market data (unofficial API) — functional
  • ✅ Crypto trading (official API) — functional
  • ✅ Authentication with automatic token refresh — functional
  • ✅ Full order management for stocks/options — functional
  • ✅ Backtesting engine with built-in strategies — functional
  • 📋 Pine Script strategy integration — planned
  • 💡 Shared base client refactor — under consideration

Acknowledgments

pyhood stands on the shoulders of the community that figured out Robinhood's unofficial API:

  • robin_stocks by Josh Fernandes — The most widely used Python library for Robinhood. Its auth flow, endpoint mapping, and API patterns laid the groundwork that pyhood builds from.
  • pyrh by Robinhood Unofficial — An early Python client that pioneered OAuth token refresh and session management patterns for the Robinhood API.
  • Robinhood by Sanko — The original unofficial API documentation that mapped out Robinhood's endpoints and made all of these libraries possible.

These projects made Robinhood accessible to developers. pyhood continues that mission with a focus on reliability and automation.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyhood-0.2.0.tar.gz (6.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyhood-0.2.0-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

Details for the file pyhood-0.2.0.tar.gz.

File metadata

  • Download URL: pyhood-0.2.0.tar.gz
  • Upload date:
  • Size: 6.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for pyhood-0.2.0.tar.gz
Algorithm Hash digest
SHA256 65902576c6985ad247a915226200cb6e3c245aef86c785ec64d1231b7bf1e490
MD5 003c18c8f98c3b9720362d7e90b3ef7d
BLAKE2b-256 41012fc2f42106005d37b76991ba02ba195b3d03c87f6791a46b26730da4c674

See more details on using hashes here.

File details

Details for the file pyhood-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pyhood-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 36.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for pyhood-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf9625c90336ef4fbb0b7068e45e5c2a82617175e04a564deb3b48416dbe5978
MD5 97c59eb2854a24e5f2960821e3d4bd61
BLAKE2b-256 27d2ce5bdde6844b3422bf8041f3f3d9cde9c9df700519f0d2a62b490c39b7f1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page