forex_data Logo

User Guide

  • Installation
    • Prerequisites
      • Installing uv
    • Quick Installation
      • Using pip or uv (Recommended)
    • Installing from Source
      • For Development or Latest Features
        • 1. Clone the Repository
        • 2. Install uv
        • 3. Install Dependencies
        • 4. Verify Installation
    • Installation Options
      • Development Installation
      • Default Installation
    • Requirements
    • Next Steps
  • Quick Start
    • Basic Concepts
    • Configuration
    • Working with Historical Data
      • Basic Usage
      • Changing Timeframes
      • Adding Custom Timeframes
      • Visualizing Data
    • Working with Real-time Data
      • Basic Usage
      • Get Latest Close Price
      • Get Recent History
      • Get Intraday Data
    • Complete Example
    • Default Engine & Storage
    • Next Steps
    • Need Help?
  • Configuration
    • Configuration File
      • Basic Configuration File
    • Configuration Options
      • Default Engine & File Storage Format
      • DATA_PATH
      • Real-Time Provider API Keys & Credentials
        • Supported Environment Variables
        • 1. Twelve Data (twelvedata)
        • 2. Tiingo (tiingo)
        • 3. Spotware cTrader Open API (ctrader)
    • Using Configuration in Code
      • Specify Configuration File folder
      • Explicit Configuration File
      • Overriding Configuration
    • Advanced Configuration
      • Template Configuration File
      • Environment Variables
    • Configuration Best Practices
    • Example: Production Configuration
    • Troubleshooting
      • Configuration Not Found
      • Invalid API Key
    • Next Steps
  • Command-Line Interface (CLI)
    • Execution Syntax
    • Commands Overview
    • generate-database
      • Usage
      • Arguments
      • Options
      • Examples
    • plot
      • Usage
      • Arguments
      • Options
      • Examples
  • Examples
    • Historical Data Examples
      • Example 1: Basic Data Retrieval
      • Example 2: Working with Multiple Timeframes
      • Example 3: Visualizing Historical Data
      • Example 4: Multi-Year Analysis
      • Example 5: Conditional Data Filtering
    • Real-time Data Examples
      • Example 5: Get Latest Market Price (Twelve Data)
      • Example 6: Top-of-Book Quotes (Tiingo)
      • Example 7: Institutional Trendbars (cTrader)
    • Plotting Examples
      • Example 8: Interactive Historical Candlestick Chart
      • Example 9: Hourly Line Chart with VWMP
    • Combined Examples
      • Example 9: Historical + Real-time Combination
      • Example 10: Multi-Currency Analysis
    • Advanced Examples
      • Example 11: Custom Data Processing Pipeline
      • Example 12: Error Handling and Validation
      • Example 13: Performance Optimization
      • Example 14: Export to Different Formats
    • Testing Examples
      • Example 15: Running the Test Suite
    • Tips and Best Practices
    • Next Steps

API Reference

  • forex_data
    • forex_data_aggregator package
      • Subpackages
        • forex_data.config package
        • forex_data.data_management package
      • Module contents

Additional Information

  • Contributing
    • Getting Started
      • Development Setup
    • Code Standards
      • Python Style Guide
      • Linting and Formatting
    • Testing
      • Writing Tests
      • Running Tests
      • Continuous Integration
    • Documentation
      • Building Documentation
      • Docstring Format
      • Adding Documentation Pages
    • Contribution Workflow
      • Making Changes
      • Submitting a Pull Request
    • What to Contribute
      • Features
      • Bug Fixes
      • Documentation
      • Tests
    • Development Priorities
      • Current Focus Areas
    • Code Review Process
      • What Reviewers Look For
    • Getting Help
    • Community Guidelines
      • Be Respectful
      • Code of Conduct
    • License
    • Recognition
    • Thank You!
  • Changelog
    • Version 0.2.0 (Current)
      • Added
        • Core Features
        • Data Management
        • Developer Experience
        • Documentation
      • Known Issues
    • Future Releases
      • Planned for v0.3.0
      • Planned for v0.4.0
    • How to Upgrade
    • Contributing to Changelog
    • See Also
forex_data
  • Search

© Copyright 2024, Nicola Fiorato.

Built with Sphinx using a theme provided by Read the Docs.