Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quick Start

Get up and running with axiomtrade-rs in under 5 minutes.

Installation

Add axiomtrade-rs to your Cargo.toml:

[dependencies]
axiomtrade-rs = "0.1.0"
tokio = { version = "1.0", features = ["full"] }

Basic Usage

1. Authentication

use axiomtrade_rs::auth::AuthClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut auth_client = AuthClient::new()?;
    
    let email = "your-email@example.com";
    let password = "your-password";
    
    // Login and get tokens
    let tokens = auth_client.login(&email, &password, None).await?;
    println!("Login successful! Access token: {}", tokens.access_token);
    
    Ok(())
}

2. Portfolio Management

#![allow(unused)]
fn main() {
use axiomtrade_rs::api::portfolio::PortfolioClient;

// Get wallet balance
let mut portfolio_client = PortfolioClient::new()?;
let wallet = "your-wallet-address";
let balance = portfolio_client.get_balance(wallet).await?;
println!("SOL Balance: {} SOL", balance.sol_balance);
}

3. Trading Operations

#![allow(unused)]
fn main() {
use axiomtrade_rs::api::trading::TradingClient;

// Execute a simple trade
let mut trading_client = TradingClient::new()?;
let result = trading_client.buy_token(
    "token-mint-address",
    1.0, // Amount in SOL
    None, // Use default slippage
).await?;
println!("Trade executed: {:?}", result);
}

4. WebSocket Streaming

#![allow(unused)]
fn main() {
use axiomtrade_rs::websocket::{client::WebSocketClient, handler::MessageHandler};

struct MyHandler;

impl MessageHandler for MyHandler {
    async fn handle_message(&self, message: String) {
        println!("Received: {}", message);
    }
}

// Connect to WebSocket
let mut ws_client = WebSocketClient::new("wss://api.axiom.trade/ws").await?;
ws_client.set_handler(Box::new(MyHandler)).await;
ws_client.connect().await?;
}

Environment Setup

For automatic OTP and other features, create a .env file:

# Axiom Trade credentials
AXIOM_EMAIL=your-email@example.com
AXIOM_PASSWORD=your-password

# Optional: Automatic OTP via inbox.lv
INBOX_LV_EMAIL=your-otp-email@inbox.lv
INBOX_LV_PASSWORD=your-imap-password

Running Examples

The repository includes 22+ working examples:

# Authentication examples
cargo run --example basic_login
cargo run --example otp_verification

# Portfolio examples
cargo run --example get_portfolio
cargo run --example batch_balances

# Trading examples
cargo run --example simple_trade

# WebSocket examples
cargo run --example basic_websocket

Next Steps

Need Help?