Welcome to PyAlpacaAPI Documentation

PyAlpacaAPI is a modern Python wrapper for the Alpaca Trading API that provides complete trading operations, market data access, and stock analysis tools with full type safety.

Features

• 🔒 Full Type Safety: Complete type annotations with mypy strict mode

• 📊 Trading Operations: Orders, positions, and account management

• 📈 Market Data: Historical data, real-time quotes, and news

• 🤖 Analysis Tools: Stock screeners, ML predictions, sentiment analysis

• 🚀 High Performance: Built-in caching with LRU and Redis support

• 📦 Batch Operations: Automatic batching for multi-symbol data fetching

• 🔄 Feed Management: Automatic subscription detection and fallback

Getting Started

• Installation
  • Requirements
  • Install from PyPI
  • Install from Source
  • Verify Installation
  • Optional Dependencies
  • Environment Variables
  • Next Steps
• Quickstart Guide
  • Basic Setup
  • Trading Operations
  • Market Data
  • Stock Analysis
  • Watchlists
  • Using Caching
  • Error Handling
  • Next Steps
• Configuration
  • API Configuration
  • Cache Configuration
  • Feed Configuration
  • Environment Variables
  • Request Configuration
  • Logging Configuration
  • Performance Configuration
  • Best Practices

User Guide

• Trading Module
  • Overview
  • Quick Example
• Stock Module
  • Historical Data
  • Historical Quotes
  • Historical Auctions
  • Company Logos
  • Overview
  • Features
  • Quick Example
• Caching
  • Overview
  • Memory Cache
  • Redis Cache
  • TTL Configuration
  • Cache Keys
  • Cache Invalidation
  • Performance Considerations
  • Best Practices
  • Cache Metrics
  • Disabling Cache
• Feed Management
  • Overview
  • Automatic Feed Detection
  • Manual Feed Selection
  • Feed Availability
  • Feed Characteristics
  • Feed Manager Configuration
  • Handling Feed Errors
  • Multi-Symbol Requests
  • Feed Performance
  • Best Practices
  • Feed Subscription
  • Troubleshooting
  • Feed Costs
• Error Handling
  • Exception Hierarchy
  • Common Exceptions
  • Error Handling Patterns
  • HTTP Status Codes
  • Logging Errors
  • Custom Error Handling
  • Error Recovery Strategies
  • Best Practices

API Reference

• API Reference
  • py_alpaca_api

Examples

• Quickstart
  • Installation
• Examples
  • Trading Examples
  • Market Data Examples
  • Analysis Examples
  • Advanced Examples

Development

• Contributing
  • Getting Started
  • Development Workflow
  • Code Standards
  • Project Structure
  • Pull Request Guidelines
  • Testing Guidelines
  • Documentation
  • Release Process
  • Getting Help
  • Code of Conduct
• Changelog
  • [3.0.0] - 2024-09-20
  • [2.0.0] - 2024-08-15
  • [1.0.0] - 2024-06-01

Indices and Tables

• Index

• Module Index

• Search Page