API Reference

The Sandbox Interface

All trading operations go through a unified interface (SandboxBase). Whether you are backtesting or live trading, the API is identical.

Category
Functions

Account

get_spot_summary(), get_perp_summary(), get_perp_position(asset)

Trading

buy(asset, qty, price), sell(asset, qty, price)

Futures

long(asset, qty, price), short(asset, qty, price), reduce_position(asset, qty)

Leverage

set_leverage(asset, leverage)

Price

get_perp_price(asset), get_spot_price(asset)

OHLCV

get_spot_ohlcv(asset, interval, limit), get_futures_ohlcv(asset, interval, limit)

Funding

get_funding_rate(asset), get_funding_rate_history(asset, limit)

OI

get_open_interest(asset), get_open_interest_history(asset, limit)

Orders

get_perp_open_orders(), get_spot_open_orders(), cancel_perp_orders(asset, ids)

Time

get_current_time()

Package Modules

import vibetrading.strategy   # generate & validate strategies from prompts
import vibetrading.backtest   # backtest engine (BacktestEngine, run())
import vibetrading.sandbox    # exchange sandboxes & live runner
import vibetrading.tools      # data download & CSV loading
import vibetrading.models     # order & position data models

Architecture

Project Structure

Last updated