Skip to content

API_GUIDE.md

Latest commit

 

History

History
339 lines (275 loc) · 8.43 KB

API_GUIDE.md

File metadata and controls

339 lines (275 loc) · 8.43 KB

📊 Cryptocurrency Exchange API Guide

This guide provides detailed information about the supported cryptocurrency exchange APIs and their features for the trading bot.

🏪 Supported Exchanges

1. Binance API

Exchange: Binance
API Base URL: https://api.binance.com
Testnet URL: https://testnet.binance.vision
Rate Limit: 1,200 requests per minute
Trading Fee: 0.1%

Features:

  • ✅ Spot Trading
  • ✅ Futures Trading
  • ✅ WebSocket Support
  • ✅ Advanced Order Types
  • ✅ High Liquidity
  • ✅ Extensive Market Coverage

Supported Order Types:

  • Market Orders
  • Limit Orders
  • Stop Loss Orders
  • Take Profit Orders

Best For:

  • High-frequency trading
  • Large volume trading
  • Advanced order types
  • Futures trading

2. Coinbase Advanced Trade API

Exchange: Coinbase
API Base URL: https://api.coinbase.com
Testnet URL: https://api-public.sandbox.exchange.coinbase.com
Rate Limit: 30 requests per second
Trading Fee: 0.5%

Features:

  • ✅ Spot Trading
  • ❌ Futures Trading
  • ✅ WebSocket Support
  • ✅ Regulatory Compliance
  • ✅ High Security
  • ✅ User-Friendly

Supported Order Types:

  • Market Orders
  • Limit Orders
  • Stop Orders
  • Stop Limit Orders

Best For:

  • Regulatory compliance
  • Security-focused trading
  • Beginner-friendly
  • US-based traders

3. Kraken API

Exchange: Kraken
API Base URL: https://api.kraken.com
Testnet URL: Not available (uses same URL)
Rate Limit: 15 requests per 15 seconds
Trading Fee: 0.26%

Features:

  • ✅ Spot Trading
  • ✅ Futures Trading
  • ✅ WebSocket Support
  • ✅ Advanced Security
  • ✅ Staking Support
  • ✅ Fiat Pairs

Supported Order Types:

  • Market Orders
  • Limit Orders
  • Stop Loss Orders
  • Take Profit Orders
  • Stop Loss Limit Orders

Best For:

  • European traders
  • Fiat trading pairs
  • Security-conscious users
  • Staking integration

4. Bybit API

Exchange: Bybit
API Base URL: https://api.bybit.com
Testnet URL: https://api-testnet.bybit.com
Rate Limit: 120 requests per minute
Trading Fee: 0.1%

Features:

  • ✅ Spot Trading
  • ✅ Futures Trading
  • ✅ WebSocket Support
  • ✅ High Leverage
  • ✅ Copy Trading
  • ✅ Options Trading

Supported Order Types:

  • Market Orders
  • Limit Orders
  • Stop Loss Orders
  • Take Profit Orders

Best For:

  • Futures trading
  • High leverage trading
  • Copy trading
  • Options trading

5. OKX API

Exchange: OKX
API Base URL: https://www.okx.com
Testnet URL: Same as production
Rate Limit: 20 requests per second
Trading Fee: 0.1%

Features:

  • ✅ Spot Trading
  • ✅ Futures Trading
  • ✅ WebSocket Support
  • ✅ DeFi Integration
  • ✅ NFT Trading
  • ✅ Multi-chain Support

Supported Order Types:

  • Market Orders
  • Limit Orders
  • Stop Loss Orders
  • Take Profit Orders

Best For:

  • DeFi integration
  • Multi-chain trading
  • NFT trading
  • Advanced trading features

🔧 API Configuration

Environment Variables

# Exchange Selection
EXCHANGE_ID=binance  # binance, coinbase, kraken, bybit, okx

# API Credentials
API_KEY=your_api_key_here
SECRET_KEY=your_secret_key_here
PASSPHRASE=your_passphrase_here  # Required for some exchanges

# Testnet Configuration
ENABLE_TESTNET=true  # Use testnet for safe testing

# API Settings
API_TIMEOUT=30  # Request timeout in seconds
MAX_RETRIES=3   # Number of retry attempts
RETRY_DELAY=5   # Delay between retries in seconds

Command Line Usage

# Basic usage with specific exchange
python main.py --exchange binance --strategy MULTI_INDICATOR --symbol BTC/USDT

# Testnet mode
python main.py --exchange coinbase --strategy RSI_STRATEGY --symbol ETH/USD

# Different exchanges
python main.py --exchange kraken --strategy MACD_STRATEGY --symbol BTC/EUR
python main.py --exchange bybit --strategy STOCHASTIC_STRATEGY --symbol ADA/USDT
python main.py --exchange okx --strategy ADX_STRATEGY --symbol DOT/USDT

📈 Rate Limiting

Understanding Rate Limits

Each exchange has different rate limiting policies:

Exchange Rate Limit Window Strategy
Binance 1,200 requests Per minute High frequency
Coinbase 30 requests Per second Moderate frequency
Kraken 15 requests Per 15 seconds Conservative
Bybit 120 requests Per minute Moderate frequency
OKX 20 requests Per second Moderate frequency

Rate Limit Management

The trading bot automatically handles rate limiting:

  • ✅ Automatic request queuing
  • ✅ Intelligent retry logic
  • ✅ Rate limit monitoring
  • ✅ Graceful degradation

🔐 Security Best Practices

API Key Security

  1. Use Testnet First: Always test with testnet before live trading
  2. Restrict Permissions: Only grant necessary permissions to API keys
  3. IP Whitelisting: Restrict API access to specific IP addresses
  4. Regular Rotation: Rotate API keys regularly
  5. Secure Storage: Store API keys in environment variables, not in code

Recommended API Key Permissions

# Minimum Required Permissions
- Read account information
- Read market data
- Place/cancel orders
- Read order history

# Optional Permissions (use with caution)
- Withdraw funds (only if needed)
- Futures trading (only if using futures)

📊 Data Granularity

Supported Timeframes

All exchanges support these timeframes:

  • 1m - 1 minute
  • 5m - 5 minutes
  • 15m - 15 minutes
  • 1h - 1 hour
  • 4h - 4 hours
  • 1d - 1 day

Historical Data Availability

Exchange Historical Data Data Quality Update Frequency
Binance Excellent High Real-time
Coinbase Good High Real-time
Kraken Good High Real-time
Bybit Good High Real-time
OKX Good High Real-time

💰 Fee Structures

Trading Fees Comparison

Exchange Maker Fee Taker Fee Volume Discounts
Binance 0.1% 0.1% Yes
Coinbase 0.5% 0.5% Limited
Kraken 0.16% 0.26% Yes
Bybit 0.1% 0.1% Yes
OKX 0.1% 0.1% Yes

Fee Optimization Tips

  1. Use Maker Orders: Place limit orders to get maker fees
  2. Volume Discounts: Higher trading volumes reduce fees
  3. Token Holdings: Some exchanges offer fee discounts for holding their tokens
  4. VIP Programs: Consider VIP programs for high-volume traders

🚀 Performance Optimization

Exchange Selection Criteria

  1. Liquidity: Choose exchanges with high liquidity for your trading pairs
  2. Latency: Consider geographic proximity to reduce latency
  3. Fees: Compare fee structures for your trading volume
  4. Features: Select based on required features (futures, options, etc.)
  5. Regulation: Consider regulatory compliance requirements

Multi-Exchange Strategy

# Example: Using multiple exchanges for arbitrage
exchanges = ['binance', 'coinbase', 'kraken']
for exchange in exchanges:
    price = get_current_price(symbol, exchange)
    # Compare prices and execute arbitrage

🔍 Troubleshooting

Common Issues

Rate Limit Exceeded

# Solution: Increase retry delay
RETRY_DELAY=10
MAX_RETRIES=5

Network Timeout

# Solution: Increase timeout
API_TIMEOUT=60

Authentication Errors

# Check API credentials
API_KEY=your_correct_api_key
SECRET_KEY=your_correct_secret_key
PASSPHRASE=your_correct_passphrase  # If required

Symbol Not Found

# Check symbol format
# Correct: BTC/USDT, ETH/USD, ADA/EUR
# Incorrect: BTCUSDT, ETH-USD, ADA_EUR

Debug Mode

# Enable debug logging
LOG_LEVEL=DEBUG

📚 Additional Resources

Official Documentation

Community Resources

⚠️ Important Disclaimer: Always test thoroughly with small amounts before live trading. Cryptocurrency trading involves significant risk, and past performance does not guarantee future results.