Examples & Code Samples

This page provides access to comprehensive examples and code samples for FiveTwenty. All examples are included with your FiveTwenty installation in the docs/examples/ directory and are maintained to stay up-to-date with the latest SDK features.

Browse Examples Locally

All examples are organized into two categories in your FiveTwenty installation:

Python Scripts

docs/examples/scripts/

Complete, runnable Python scripts demonstrating specific functionality:

• basic_usage.py - Getting started with FiveTwenty
• account_management.py - Account operations and configuration
• configuration_patterns.py - Different ways to configure the client
• sync_usage.py - Using the synchronous client wrapper
• pricing_and_candles.py - Market data and candlestick analysis
• advanced_order_management.py - Complex order types and management
• position_management.py - Position tracking and management
• trade_management.py - Trade lifecycle management
• transaction_analysis.py - Transaction history and analysis
• enhanced_error_handling.py - Robust error handling patterns
• advanced_features_demo.py - Advanced SDK features showcase

Jupyter Notebooks

docs/examples/notebooks/

Interactive Jupyter notebooks for learning and experimentation:

• quick-start.ipynb - Quick start guide and basic operations
• trading-strategies.ipynb - Strategy development and implementation
• streaming-data.ipynb - Real-time data processing and streaming
• risk-management.ipynb - Risk management techniques and tools
• data-analysis.ipynb - Market data analysis and visualization
• backtesting.ipynb - Strategy backtesting framework

Getting Started

Prerequisites

Before running any examples, make sure you have:

1. FiveTwenty installed: uv add fivetwenty
2. OANDA API credentials: Get your API token
3. Environment configured: Set your FIVETWENTY_OANDA_TOKEN and account details

Running Python Scripts

1. Install FiveTwenty (if not already installed):

   uv add fivetwenty
   

2. Locate examples directory:

   # Examples are included in your FiveTwenty installation
   # Find your site-packages directory:
   python -c "import fivetwenty; print(fivetwenty.__file__.replace('__init__.py', '../examples'))"
   

3. Set up your environment:

   export FIVETWENTY_OANDA_TOKEN="your-practice-token"
   export FIVETWENTY_OANDA_ACCOUNT="your-account-id"
   export FIVETWENTY_OANDA_ENVIRONMENT="practice"
   

4. Run any script:

   python path/to/examples/scripts/basic_usage.py
   

Running Jupyter Notebooks

1. Install Jupyter:

   uv add jupyter
   

2. Navigate to notebooks directory:

   # Find and navigate to the notebooks directory
   cd path/to/docs/examples/notebooks/
   

3. Start Jupyter:

   jupyter notebook
   

4. Open any notebook and follow the interactive instructions

Documentation Integration

Examples complement our structured documentation:

• Tutorials - Step-by-step learning paths
• Guides - Comprehensive guidance and solutions
• API Reference - Complete API documentation

Contributing Examples

Found a bug or want to add an example?

1. Report issues: See Contributing Guide for reporting guidelines
2. Contribute examples: Contributing Guide
3. Suggest improvements: Contributing Guide

Example Categories

By Skill Level

• Beginner: basic_usage.py, quick-start.ipynb
• Intermediate: account_management.py, pricing_and_candles.py, trading-strategies.ipynb
• Advanced: advanced_features_demo.py, enhanced_error_handling.py, backtesting.ipynb

By Use Case

• Account Management: account_management.py, configuration_patterns.py
• Market Data: pricing_and_candles.py, data-analysis.ipynb, streaming-data.ipynb
• Trading: advanced_order_management.py, position_management.py, trade_management.py
• Analysis: transaction_analysis.py, backtesting.ipynb, risk-management.ipynb
• Integration: sync_usage.py, enhanced_error_handling.py

---

Remember: All examples use the practice environment by default for safe learning and testing!