OpenAlgo

https://docs.openalgo.in
Admin
OpenAlgo is a free, open-source algorithmic trading platform that provides a unified API layer...
Tokens:492,669
Snippets:4,355
Trust Score:6.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Indicator Environment

Source: https://docs.openalgo.in/skills/indicators.md

Initializes the environment by detecting the OS, creating a virtual environment, and installing dependencies.

```bash
/indicator-setup
/indicator-setup python3.12
```

--------------------------------

### Setup Python Environment

Source: https://docs.openalgo.in/developers/design-documentation/12-ubuntu-server-installation.md

Configures the virtual environment and installs production dependencies using uv.

```bash
# Install uv package manager
pip install uv

# Create virtual environment and install dependencies
uv venv .venv
source .venv/bin/activate
uv sync

# Install production dependencies
uv pip install gunicorn eventlet==0.35.2
```

--------------------------------

### Setup Python Environment

Source: https://docs.openalgo.in/skills/execution.md

Commands to create a virtual environment, install system dependencies, and install required Python packages.

```bash
python -m venv venv
source venv/bin/activate           # Linux / Mac
# venv\Scripts\activate             # Windows

# Install TA-Lib C library first (required for the openalgo[indicators] extra)
brew install ta-lib                 # macOS
# sudo apt install libta-lib-dev    # Linux

# Install all Python packages
pip install -r requirements.txt
```

--------------------------------

### WebSocket Quick Start Example

Source: https://docs.openalgo.in/trading-platform/excel.md

A complete workflow for initializing the API, connecting to the WebSocket, and retrieving real-time data.

```Excel Formula
' Step 1: Set API key (only needed once, persisted to disk)
=oa_api("your_api_key")

' Step 2: Connect to WebSocket
=oa_ws_connect()

' Step 3: Use data functions - they auto-subscribe
Cell A1: =oa_ws_ltp("RELIANCE", "NSE")
Cell A2: =oa_ws_ltp("TCS", "NSE")
Cell A3: =oa_ws_ltp("INFY", "NSE")
Cell B1: =oa_ws_field("RELIANCE", "NSE", "volume", 2)
Cell B2: =oa_ws_field("TCS", "NSE", "volume", 2)
Cell B3: =oa_ws_field("INFY", "NSE", "volume", 2)

' All cells update continuously in real-time

' Step 4: Clean up when done
=oa_ws_unsubscribe_all()
```

--------------------------------

### Install OpenAlgo Go Library

Source: https://docs.openalgo.in/trading-platform/go.md

Use the go get command to install the library.

```bash
go get github.com/marketcalls/openalgo-go
```

--------------------------------

### Quick Start Commands

Source: https://docs.openalgo.in/installation-guidelines/getting-started/docker-development.md

Basic commands to initialize the environment and start the container.

```bash
cp .sample.env .env
```

```bash
docker-compose up --build
```

```bash
docker-compose logs -f
```

--------------------------------

### Run Installation Script

Source: https://docs.openalgo.in/installation-guidelines/getting-started/ubuntu-server-installation.md

Executes the installation script with root privileges.

```bash
sudo ./install.sh
```

--------------------------------

### Run One-Line Installation

Source: https://docs.openalgo.in/installation-guidelines/getting-started/docker-%2B-custom-domain.md

Executes the automated installation script directly on the server.

```bash
wget https://raw.githubusercontent.com/marketcalls/openalgo/refs/heads/main/install/install-docker.sh && chmod +x install-docker.sh && ./install-docker.sh
```

--------------------------------

### Run Environment Setup Skill

Source: https://docs.openalgo.in/skills/backtesting.md

Automate environment configuration using the setup skill.

```text
/setup
/setup python3.12
```

--------------------------------

### Install Docker on Ubuntu

Source: https://docs.openalgo.in/installation-guidelines/getting-started/raspberry-pi.md

Download and execute the official Docker installation script.

```bash
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
```

--------------------------------

### Install OpenAlgo SDK

Source: https://docs.openalgo.in/trading-platform/rust.md

Installation methods using cargo command or Cargo.toml configuration.

```bash
cargo add openalgo tokio --features tokio/full
```

```toml
[dependencies]
openalgo = "1.0.5"
tokio = { version = "1", features = ["full"] }
```

--------------------------------

### cURL Request Example

Source: https://docs.openalgo.in/api-documentation/v1/data-api/intervals.md

A command-line example for fetching available intervals.

```bash
curl -X POST http://127.0.0.1:5000/api/v1/intervals \
  -H 'Content-Type: application/json' \
  -d '{
  "apikey": "<your_app_apikey>"
}'
```

--------------------------------

### Download Installation Script

Source: https://docs.openalgo.in/installation-guidelines/getting-started/ubuntu-server-installation.md

Downloads and prepares the OpenAlgo installation script in a dedicated directory.

```bash
mkdir -p ~/openalgo-install
cd ~/openalgo-install

wget https://raw.githubusercontent.com/marketcalls/openalgo/main/install/install.sh
chmod +x install.sh
```

--------------------------------

### Inspect Installation Directory

Source: https://docs.openalgo.in/installation-guidelines/getting-started/ubuntu-server-installation.md

Commands to verify the installation path, configuration, and application logs.

```bash
# Repo
ls /var/python/openalgo

# Effective configuration
sudo cat /var/python/openalgo/.env

# Application logs
sudo tail -f /var/python/openalgo/log/openalgo_$(date +%F).log

# JSON-formatted error log (always-on)
sudo tail -f /var/python/openalgo/log/errors.jsonl
```

--------------------------------

### Verbose Output Examples

Source: https://docs.openalgo.in/trading-platform/python/websockets-verbose-control.md

Example console outputs for different verbose settings.

```text
=== Testing with verbose=False ===

MY CALLBACK: NIFTY LTP: 26008.5

--- Poll 1 ---
  NSE_INDEX:NIFTY = 26008.5
  NSE:INFY = 1531.0
```

```text
=== Testing with verbose=True ===

[WS]    Connected to ws://127.0.0.1:8765
[AUTH]  Authenticating with API key: bf1267a1...7cf9169f
[AUTH]  Success | Broker: upstox | User: rajandran
[SUB]   Subscribing NSE_INDEX:NIFTY Quote...
[SUB]   NSE_INDEX:NIFTY | Mode: Quote | Status: success
[SUB]   Subscribing NSE:INFY Quote...
[SUB]   NSE:INFY | Mode: Quote | Status: success
MY CALLBACK: NIFTY LTP: 26008.5

--- Poll 1 ---
  NSE_INDEX:NIFTY = 26008.5
  NSE:INFY = 1531.0
```

```text
=== Testing with verbose=2 ===

[WS]    Connected to ws://127.0.0.1:8765
[AUTH]  Authenticating with API key: bf1267a1...7cf9169f
[AUTH]  Success | Broker: upstox | User: rajandran
[AUTH]  Full response: {'type': 'auth', 'status': 'success', ...}
[SUB]   Subscribing NSE_INDEX:NIFTY Quote...
[SUB]   NSE_INDEX:NIFTY | Mode: Quote | Status: success
[SUB]   Full response: {'type': 'subscribe', ...}
[QUOTE] NSE_INDEX:NIFTY      | O: 25998.5    H: 26025.5    L: 25924.15   C: 26008.5    LTP: 26008.5
MY CALLBACK: NIFTY LTP: 26008.5
[QUOTE] NSE:INFY             | O: 1549.0     H: 1550.6     L: 1525.9     C: 1531.0     LTP: 1531.0

--- Poll 1 ---
  NSE_INDEX:NIFTY = 26008.5
  NSE:INFY = 1531.0
```

--------------------------------

### Install System Prerequisites

Source: https://docs.openalgo.in/developers/design-documentation/12-ubuntu-server-installation.md

Updates the system and installs essential packages including Python, Node.js, and Nginx.

```bash
# Update system
sudo apt update && sudo apt upgrade -y

# Install required packages
sudo apt install -y python3.12 python3.12-venv python3-pip \
                    nginx certbot python3-certbot-nginx \
                    git curl build-essential

# Install Node.js (for frontend build)
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs
```

--------------------------------

### Multi-Domain Deployment Installation

Source: https://docs.openalgo.in/installation-guidelines/getting-started/ubuntu-server-installation.md

Downloads and executes the multi-deploy installer for running multiple OpenAlgo instances.

```bash
wget https://raw.githubusercontent.com/marketcalls/openalgo/main/install/install-multi.sh
chmod +x install-multi.sh
sudo ./install-multi.sh
```

--------------------------------

### Install OpenAlgo.NET via Package Manager

Source: https://docs.openalgo.in/trading-platform/.net.md

Use the Package Manager Console to install the OpenAlgo.NET library.

```powershell
Install-Package OpenAlgo.NET
```

--------------------------------

### Install Project Dependencies

Source: https://docs.openalgo.in/contributors.md

Clones the repository, installs the uv package manager, syncs Python dependencies, and builds the React frontend.

```bash
# Clone the repository
git clone https://github.com/marketcalls/openalgo.git
cd openalgo

# Install uv package manager (if not already installed)
pip install uv

# Sync Python dependencies (uv handles virtualenv automatically)
uv sync

# Build React frontend (required before first run)
cd frontend
npm install
npm run build
cd ..
```

--------------------------------

### GET /installation-guidelines/getting-started.md

Source: https://docs.openalgo.in/getting-started

Performs a query against the documentation index to retrieve answers and relevant excerpts based on a specific question.

```APIDOC
## GET /installation-guidelines/getting-started.md

### Description
Perform an HTTP GET request on the documentation index with the `ask` parameter, and the optional `goal` parameter to retrieve a direct answer and relevant excerpts.

### Method
GET

### Endpoint
https://docs.openalgo.in/installation-guidelines/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### GET /installation-guidelines/getting-started/upgrade.md

Source: https://docs.openalgo.in/getting-started/upgrade

Perform a query against the documentation index to receive a direct answer and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /installation-guidelines/getting-started/upgrade.md

### Description
Perform an HTTP GET request on the documentation index to retrieve answers and relevant excerpts from the documentation.

### Method
GET

### Endpoint
https://docs.openalgo.in/installation-guidelines/getting-started/upgrade.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Install Specific Backtesting Skills

Source: https://docs.openalgo.in/skills/backtesting.md

Target individual skill components such as backtest, optimize, expert, or setup modules.

```bash
npx skills add marketcalls/vectorbt-backtesting-skills -s backtest
npx skills add marketcalls/vectorbt-backtesting-skills -s optimize
npx skills add marketcalls/vectorbt-backtesting-skills -s vectorbt-expert
npx skills add marketcalls/vectorbt-backtesting-skills -s setup
```

--------------------------------

### Example Hosts File

Source: https://docs.openalgo.in/installation-guidelines/getting-started/windows-with-caddy.md

A sample configuration for the Windows hosts file.

```text
# localhost name resolution is handled within DNS itself.
#	127.0.0.1       localhost
#	::1             localhost

# Added by Docker Desktop
192.168.1.6 host.docker.internal
192.168.1.6 gateway.docker.internal

# To allow the same kube context to work on the host and the container:
127.0.0.1 kubernetes.docker.internal
127.0.0.1 openalgo.local
# End of section
```

--------------------------------

### /indicator-setup

Source: https://docs.openalgo.in/skills/indicators.md

Detects the operating system, creates a virtual environment, installs dependencies, and configures API keys in the .env file.

```APIDOC
## /indicator-setup

### Description
Detects OS, creates venv, installs all dependencies, and collects API keys into .env.

### Usage
`/indicator-setup [python_version]`
```

--------------------------------

### GET /python/status/<id>

Source: https://docs.openalgo.in/developers/design-documentation/38-python-strategies-hosting.md

Get strategy status.

```APIDOC
## GET /python/status/<id>

### Description
Retrieves the current status of a strategy identified by its ID.

### Method
GET

### Endpoint
/python/status/<id>

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the strategy.
```

--------------------------------

### Start OpenAlgo Instance

Source: https://docs.openalgo.in/skills/execution.md

Commands to clone the repository and launch the OpenAlgo application using uv.

```bash
git clone https://github.com/marketcalls/openalgo.git
cd openalgo
pip install uv && uv run app.py
```

--------------------------------

### GET /python/logs/<id>

Source: https://docs.openalgo.in/developers/design-documentation/38-python-strategies-hosting.md

Get strategy logs.

```APIDOC
## GET /python/logs/<id>

### Description
Retrieves the logs for a specific strategy identified by its ID.

### Method
GET

### Endpoint
/python/logs/<id>

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the strategy.
```

--------------------------------

### Verify Caddy Installation

Source: https://docs.openalgo.in/installation-guidelines/getting-started/windows-with-caddy.md

Check the installed version of Caddy.

```powershell
.\caddy.exe version
```

--------------------------------

### GET /installation-guidelines/getting-started/windows-installation/environmental-variables.md

Source: https://docs.openalgo.in/getting-started/windows-installation/environmental-variables

Performs a query against the documentation index to retrieve answers, excerpts, and sources based on a specific question.

```APIDOC
## GET /installation-guidelines/getting-started/windows-installation/environmental-variables.md

### Description
Perform an HTTP GET request on the documentation index to retrieve a direct answer to a question along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.openalgo.in/installation-guidelines/getting-started/windows-installation/environmental-variables.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### Install fail2ban

Source: https://docs.openalgo.in/installation-guidelines/getting-started/raspberry-pi.md

Installs the fail2ban service to protect against brute-force attacks.

```bash
sudo apt-get install fail2ban
```

--------------------------------

### Default Installation Layout

Source: https://docs.openalgo.in/installation-guidelines/getting-started/ubuntu-server-installation.md

Displays the file system structure for a standard single-instance deployment.

```text
/var/python/openalgo/                  cloned repo
/var/python/openalgo/.venv/            uv-managed Python virtual environment
/var/python/openalgo/.env              configuration
/var/python/openalgo/openalgo.sock     Gunicorn Unix socket
/etc/systemd/system/openalgo.service   systemd unit
/etc/nginx/sites-available/openalgo.conf   Nginx vhost (stable name across domain changes)
```

--------------------------------

### Update Docker Installation

Source: https://docs.openalgo.in/change-log/release/version-2.0.1.2-released.md

Commands to update an existing Docker-based installation.

```bash
cd /opt/openalgo/<domain>
sudo docker compose pull
sudo docker compose up -d
```

--------------------------------

### Install OpenAlgo Library

Source: https://docs.openalgo.in/trading-platform/python.md

Use pip to install the OpenAlgo Python package.

```bash
# Trading API only  
pip install openalgo
```

--------------------------------

### Install OpenAlgo Library

Source: https://docs.openalgo.in/trading-platform/nodejs.md

Use npm to install the OpenAlgo package in your project.

```bash
npm install openalgo
```

--------------------------------

### Configure API Keys

Source: https://docs.openalgo.in/skills/backtesting.md

Initialize the environment variables file from the sample template.

```bash
cp .env.sample .env
# Edit .env with your API keys
```

--------------------------------

### Verify n8n Installation

Source: https://docs.openalgo.in/trading-platform/n8n.md

Confirm that n8n is correctly installed by checking its version.

```sh
n8n -v
```

--------------------------------

### Startup Script Configuration

Source: https://docs.openalgo.in/developers/design-documentation/11-docker-configuration.md

The entrypoint script handles environment setup, service initialization, and Gunicorn process management.

```bash
#!/bin/bash
# start.sh (simplified overview - actual script is 246 lines)

echo "[OpenAlgo] Starting up..."

# ============================================
# RAILWAY/CLOUD ENVIRONMENT DETECTION
# ============================================
# If HOST_SERVER is set and no .env exists, auto-generate .env
# with 40+ configuration variables including:
# - Broker configuration
# - Database URLs
# - CORS, CSP, CSRF settings
# - Rate limiting
# - WebSocket/ZeroMQ configuration

# ============================================
# DIRECTORY SETUP
# ============================================
for dir in db log log/strategies strategies strategies/scripts keys; do
    mkdir -p "$dir" 2>/dev/null || true
done

# ============================================
# DATABASE MIGRATIONS
# ============================================
if [ -f "/app/upgrade/migrate_all.py" ]; then
    /app/.venv/bin/python /app/upgrade/migrate_all.py
fi

# ============================================
# WEBSOCKET PROXY SERVER
# ============================================
/app/.venv/bin/python -m websocket_proxy.server &
WEBSOCKET_PID=$!

# ============================================
# SIGNAL HANDLING
# ============================================
cleanup() {
    echo "[OpenAlgo] Shutting down..."
    kill $WEBSOCKET_PID 2>/dev/null
    exit 0
}
trap cleanup SIGTERM SIGINT

# ============================================
# GUNICORN STARTUP
# ============================================
APP_PORT="${PORT:-5000}"  # Railway uses PORT env var
mkdir -p /tmp/gunicorn_workers

exec /app/.venv/bin/gunicorn \
    --worker-class eventlet \
    --workers 1 \
    --bind 0.0.0.0:${APP_PORT} \
    --timeout 300 \
    --graceful-timeout 30 \
    --worker-tmp-dir /tmp/gunicorn_workers \
    --log-level warning \
    app:app
```

--------------------------------

### API Response Examples

Source: https://docs.openalgo.in/api-documentation/v1/orders-api/cancelallorder.md

Examples of successful and partially successful API responses.

```json
{
  "status": "success",
  "message": "Canceled 5 orders. Failed to cancel 0 orders.",
  "canceled_orders": [
    "250408001042620",
    "250408001042667",
    "250408001042642",
    "250408001043015",
    "250408001043386"
  ],
  "failed_cancellations": []
}
```

```json
{
  "status": "success",
  "message": "Canceled 3 orders. Failed to cancel 2 orders.",
  "canceled_orders": [
    "250408001042620",
    "250408001042667",
    "250408001042642"
  ],
  "failed_cancellations": [
    {
      "orderid": "250408001043015",
      "reason": "Order in transit"
    },
    {
      "orderid": "250408001043386",
      "reason": "Order already executed"
    }
  ]
}
```

--------------------------------

### Configure Environment Variables

Source: https://docs.openalgo.in/installation-guidelines/getting-started/raspberry-pi.md

Prepare the .env file from the sample configuration.

```bash
cp .sample.env .env
vi .env
```

--------------------------------

### Get Order Logs Endpoint

Source: https://docs.openalgo.in/developers/design-documentation/22-log-section.md

Retrieves order logs via a GET request.

```http
GET /logs/api/orders
```

--------------------------------

### Initialize API and Fetch Data

Source: https://docs.openalgo.in/trading-platform/python/indicators/utility.md

Setup the API client and retrieve historical market data for analysis.

```python
# Initialize API client
client = api(api_key='your_api_key_here', host='http://127.0.0.1:5000')

# Fetch historical data
df = client.history(symbol="SBIN", 
                   exchange="NSE", 
                   interval="5m", 
                   start_date="2025-04-01", 
                   end_date="2025-04-08")

# Extract price series
close = df['close']
high = df['high']
low = df['low']
open_prices = df['open']
volume = df['volume']
```

--------------------------------

### Start OpenAlgo locally

Source: https://docs.openalgo.in/installation-guidelines/getting-started/upgrade.md

Launch the application after an upgrade to verify configuration and database initialization.

```bash
uv run app.py
```

```text
Configuration version check passed
INFO in telegram_db: Telegram database initialized successfully
INFO in base: Scheduler started
INFO in traffic_db: Initializing Traffic Logs DB at: sqlite:///db/logs.db
INFO in latency_db: Initializing Latency DB at: sqlite:///db/latency.db
INFO in auth_db: Initializing Auth DB
INFO in symbol: Initializing Master Contract DB
```

--------------------------------

### Install n8n Globally

Source: https://docs.openalgo.in/trading-platform/n8n.md

Use npm to install the n8n package globally on the system.

```sh
npm install -g n8n
```

--------------------------------

### Sample Environmental Configuration

Source: https://docs.openalgo.in/installation-guidelines/getting-started/mac-os-installation/environmental-variables.md

Template for the .env file containing broker, security, database, and server settings.

```python
# Broker Configuration
BROKER_API_KEY = 'YOUR_BROKER_API_KEY'
BROKER_API_SECRET = 'YOUR_BROKER_API_SECRET'

REDIRECT_URL = 'http://127.0.0.1:5000/<broker>/callback'  # Change if different

# Valid Brokers Configuration
VALID_BROKERS = 'fivepaisa,aliceblue,angel,dhan,fyers,icici,kotak,shoonya,upstox,zebu,zerodha'

# Security Configuration
# IMPORTANT: Generate new random values for both keys during setup!

# OpenAlgo Application Key
APP_KEY = '3daa0403ce2501ee7432b75bf100048e3cf510d63d2754f952e93d88bf07ea84'

# Security Pepper - Used for hashing/encryption of sensitive data
# This is used for:
# 1. API key hashing
# 2. User password hashing
# 3. Broker auth token encryption
# Generate a new random string during setup using: python -c "import secrets; print(secrets.token_hex(32))"
API_KEY_PEPPER = 'a25d94718479b170c16278e321ea6c989358bf499a658fd20c90033cef8ce772'

# OpenAlgo Database Configuration
DATABASE_URL = 'sqlite:///db/openalgo.db' 

# OpenAlgo Ngrok Configuration
NGROK_ALLOW = 'FALSE' 

# OpenAlgo Hosted Server (Custom Domain Name) or Ngrok Domain Configuration
# Change to your custom domain or Ngrok domain
HOST_SERVER = 'http://127.0.0.1:5000'  

# OpenAlgo Flask App Host and Port Configuration
# For 0.0.0.0 (accessible from other devices on the network)
# Flask Environment - development or production
FLASK_HOST_IP='127.0.0.1'  
FLASK_PORT='5000'  
FLASK_DEBUG='False' 
FLASK_ENV='development'

# OpenAlgo Rate Limit Settings
LOGIN_RATE_LIMIT_MIN = "5 per minute" 
LOGIN_RATE_LIMIT_HOUR = "25 per hour"
API_RATE_LIMIT="10 per second"

# OpenAlgo API Configuration

# Required to give 0.5 second to 1 second delay between multi-legged option strategies
# Single legged orders are not affected by this setting.
SMART_ORDER_DELAY = '0.5'

# Session Expiry Time (24-hour format, IST)
# All user sessions will automatically expire at this time daily
SESSION_EXPIRY_TIME = '03:00'

# Note: OpenAlgo version is now managed in utils/version.py
```

--------------------------------

### Fork and Clone Repository

Source: https://docs.openalgo.in/contributors.md

Initial setup steps to clone the repository and configure the upstream remote.

```bash
# Fork the repository on GitHub (click Fork button)
# Clone your fork
git clone https://github.com/YOUR_USERNAME/openalgo.git
cd openalgo

# Add upstream remote
git remote add upstream https://github.com/marketcalls/openalgo.git

# Verify remotes
git remote -v
```

--------------------------------

### Inspect Installation Logs

Source: https://docs.openalgo.in/installation-guidelines/getting-started/ubuntu-server-installation.md

Commands to locate and display the most recent installation log file.

```bash
ls -l ~/openalgo-install/logs/
cat ~/openalgo-install/logs/$(ls -t ~/openalgo-install/logs/ | head -1)
```

--------------------------------

### Update Native Ubuntu Installation

Source: https://docs.openalgo.in/change-log/release/version-2.0.1.2-released.md

Commands to update an existing native Ubuntu installation.

```bash
cd /var/python/openalgo-flask/<deploy-name>/openalgo
sudo ./install/update.sh
# update.sh runs migrate_all.py. No schema migration is required for this
# release; uv sync pulls opengreeks and drops py_vollib automatically.
```

--------------------------------

### Conventional Commit Examples

Source: https://docs.openalgo.in/contributors.md

Examples of commit messages following the Conventional Commits specification.

```bash
git commit -m "feat: add Groww broker integration"
git commit -m "fix: correct margin calculation for options"
git commit -m "docs: update WebSocket setup instructions"
git commit -m "refactor: optimize order processing pipeline"
```

--------------------------------

### POST /python/start/<id>

Source: https://docs.openalgo.in/developers/design-documentation/38-python-strategies-hosting.md

Start a specific strategy.

```APIDOC
## POST /python/start/<id>

### Description
Starts the execution of a strategy identified by its ID.

### Method
POST

### Endpoint
/python/start/<id>

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the strategy.
```

--------------------------------

### Initialize Startup Banner

Source: https://docs.openalgo.in/developers/design-documentation/16-centralized-logging.md

Displays the application version and endpoint URLs in the console upon startup.

```python
from utils.logging import log_startup_banner

# Display startup banner with version and URLs
log_startup_banner(version, web_url, ws_url, ngrok_url)
```

--------------------------------

### cURL Request Example

Source: https://docs.openalgo.in/api-documentation/v1/orders-api/cancelallorder.md

A command-line example for executing the cancellation request using cURL.

```bash
curl -X POST http://127.0.0.1:5000/api/v1/cancelallorder \
  -H 'Content-Type: application/json' \
  -d '{
  "apikey": "<your_app_apikey>",
  "strategy": "Python"
}'
```

--------------------------------

### Initialize Broker Directory Structure

Source: https://docs.openalgo.in/developers/design-documentation/33-broker-folder-explanations.md

Creates the necessary directory hierarchy and initialization files for a new broker integration.

```bash
mkdir -p broker/newbroker/{api,mapping,database,streaming}
touch broker/newbroker/{api,mapping,database,streaming}/__init__.py
```

--------------------------------

### Install Skills Globally

Source: https://docs.openalgo.in/skills/indicators.md

Install the indicator skills globally to make them accessible across all projects.

```bash
npx skills add marketcalls/openalgo-indicator-skills -g
```

--------------------------------

### Initialize API and Fetch Data

Source: https://docs.openalgo.in/trading-platform/python/indicators/volume.md

Setup the API client and retrieve historical OHLCV data for indicator calculations.

```python
# Initialize API client
client = api(api_key='your_api_key_here', host='http://127.0.0.1:5000')

# Fetch historical data
df = client.history(symbol="SBIN", 
                   exchange="NSE", 
                   interval="5m", 
                   start_date="2025-04-01", 
                   end_date="2025-04-08")

# Extract OHLCV data
high = df['high']
low = df['low'] 
close = df['close']
open_price = df['open']
volume = df['volume']
```

--------------------------------

### Setup SSL

Source: https://docs.openalgo.in/developers/design-documentation/12-ubuntu-server-installation.md

Uses Certbot to automatically configure SSL certificates for the domain.

```bash
sudo certbot --nginx -d your-domain.com
```

--------------------------------

### Install iptables on Raspberry Pi

Source: https://docs.openalgo.in/installation-guidelines/getting-started/raspberry-pi.md

Updates package lists and installs the iptables firewall utility.

```bash
sudo apt-get update
sudo apt-get install iptables
```

--------------------------------

### Install as Non-Root User

Source: https://docs.openalgo.in/installation-guidelines/getting-started/docker-%2B-custom-domain.md

Recommended installation method for production environments to ensure better security.

```bash
# If you're logged in as root, create a non-root user first
adduser openalgo
usermod -aG sudo openalgo
su - openalgo

# Download and run the script
wget https://raw.githubusercontent.com/marketcalls/openalgo/refs/heads/main/install/install-docker.sh
chmod +x install-docker.sh
./install-docker.sh
```

--------------------------------

### Update Environment Configuration

Source: https://docs.openalgo.in/change-log/release/version-1.0.0.34-launched.md

Initialize the environment file by copying the provided sample configuration.

```bash
cp .sample.env .env
```

--------------------------------

### Setup OpenAlgo for Indian Markets

Source: https://docs.openalgo.in/skills/backtesting.md

Clone and run the OpenAlgo repository to enable Indian market data access.

```bash
git clone https://github.com/marketcalls/openalgo.git
cd openalgo
pip install -r requirements.txt
python app.py
```

--------------------------------

### Install Cloudflared via Winget

Source: https://docs.openalgo.in/installation-guidelines/getting-started/cloudflared-with-custom-domain.md

Use the Windows Package Manager to install the cloudflared utility.

```powershell
# Install via Winget (Windows Package Manager)
winget install Cloudflare.cloudflared
```

--------------------------------

### Install Dependencies for OpenAlgo

Source: https://docs.openalgo.in/change-log/release/version-2.0.0.0-released.md

Commands to synchronize Python dependencies and install frontend packages for development.

```bash
uv sync                    # Python dependencies
cd frontend && npm install # Frontend (for development only)
```

--------------------------------

### Initialize OpenAlgo Client

Source: https://docs.openalgo.in/trading-platform/go.md

Import the package and initialize the client with your API key and optional custom WebSocket URL.

```go
package main

import (
    "fmt"
    "github.com/marketcalls/openalgo-go/openalgo"
)

func main() {
    // Replace 'your_api_key_here' with your actual API key
    // Default host is http://127.0.0.1:5000
    client := openalgo.NewClient("your_api_key_here", "http://127.0.0.1:5000")

    // Or with custom WebSocket URL
    client := openalgo.NewClient("your_api_key_here", "http://127.0.0.1:5000", "v1", "ws://127.0.0.1:8765")
}
```

--------------------------------

### Synthetic Future Example Calculation

Source: https://docs.openalgo.in/api-documentation/v1/data-api/syntheticfuture.md

Step-by-step numerical example of calculating synthetic future and basis.

```text
Spot Price (underlying_ltp): 25910.05
ATM Strike: 25900
ATM Call Premium: 500
ATM Put Premium: 420

Synthetic Future = 25900 + 500 - 420 = 25980
Basis = 25980 - 25910.05 = 69.95 points
```
Tokens:
Raw