Documentation › Getting Started › Introduction
📚 Complete Documentation

AITraiderBot Documentation

Everything you need to integrate and build with our AI trading platform. From quick start guides to comprehensive API references.

🚀 Quick Start 📖 API Reference

📋 On This Page

⚡ Quick Start Guide

Get up and running with the AITraiderBot API in just a few minutes:

1
Get API Key
Sign up and generate your API credentials
2
Install SDK
Install our SDK in your preferred language
3
First Request
Make your first API call and get trading

🔐 Authentication

All API requests must be authenticated using API keys. Include your API key in the Authorization header of every request.

HTTP Headers
Authorization: Bearer your-api-key Content-Type: application/json X-API-Version: 2.0

API Key Types

🔑

Public Key

For read-only operations like market data and portfolio viewing.

Read-only Rate limited
🔒

Private Key

For trading operations, order management, and account modifications.

Full access IP restricted

🌐 REST API Reference

Our REST API provides programmatic access to all trading and market data functionality.

GET /v2/market/ticker/{symbol}

Get real-time ticker data for a specific trading pair including price, volume, and 24h statistics.

Example Response
{ "symbol": "BTC/USDT", "price": 43567.82, "volume": 1234567.89, "change_24h": 2.34, "high_24h": 44123.45, "low_24h": 42890.12, "timestamp": "2024-01-15T14:30:00Z" }
POST /v2/orders

Place a new trading order. Supports market, limit, and stop orders with advanced options.

Request Body
{ "symbol": "BTC/USDT", "side": "buy", "type": "limit", "amount": 0.001, "price": 43500.00, "time_in_force": "GTC" }
GET /v2/portfolio

Retrieve your current portfolio balances and positions across all connected exchanges.

Example Response
{ "total_value": 12345.67, "currency": "USD", "balances": [ { "symbol": "BTC", "free": 0.25, "locked": 0.05, "value_usd": 10891.95 } ] }

🛠️ SDK Examples

Code examples in different programming languages to help you get started quickly.

JavaScript
// Install: npm install @aitraiderbot/sdk import { AITraiderBot } from '@aitraiderbot/sdk'; // Initialize client const client = new AITraiderBot({ apiKey: 'your-api-key', baseURL: 'https://api.aitraiderbot.com' }); // Get market data const ticker = await client.getTicker('BTC/USDT'); console.log(`Current BTC price: $${ticker.price}`); // Place a buy order const order = await client.placeOrder({ symbol: 'BTC/USDT', side: 'buy', type: 'market', amount: 0.001 }); console.log('Order placed:', order);
Python
# Install: pip install aitraiderbot from aitraiderbot import AITraiderBot # Initialize client client = AITraiderBot( api_key='your-api-key', base_url='https://api.aitraiderbot.com' ) # Get market data ticker = client.get_ticker('BTC/USDT') print(f"Current BTC price: ${ticker['price']}") # Place a buy order order = client.place_order( symbol='BTC/USDT', side='buy', type='market', amount=0.001 ) print('Order placed:', order)
Rust
// Add to Cargo.toml: aitraiderbot = "2.0" use aitraiderbot::{AITraiderBot, OrderRequest}; // Initialize client let client = AITraiderBot::new( "your-api-key", "https://api.aitraiderbot.com" )?; // Get market data let ticker = client.get_ticker("BTC/USDT").await?; println!("Current BTC price: ${}", ticker.price); // Place a buy order let order_request = OrderRequest::new() .symbol("BTC/USDT") .side("buy") .order_type("market") .amount(0.001); let order = client.place_order(order_request).await?; println!("Order placed: {:?}", order);
Java
// Add to pom.xml: com.aitraiderbot:sdk:2.0.0 import com.aitraiderbot.AITraiderBot; import com.aitraiderbot.model.*; // Initialize client AITraiderBot client = new AITraiderBot( "your-api-key", "https://api.aitraiderbot.com" ); // Get market data Ticker ticker = client.getTicker("BTC/USDT"); System.out.println("Current BTC price: $" + ticker.getPrice()); // Place a buy order OrderRequest orderRequest = new OrderRequest() .setSymbol("BTC/USDT") .setSide("buy") .setType("market") .setAmount(0.001); Order order = client.placeOrder(orderRequest); System.out.println("Order placed: " + order);