API Reference

Complete reference for all 77 public API endpoints. All requests require an X-API-Key header.

Account

4 endpoints

Retrieve profile, credit balance, usage statistics, and subscription status for the authenticated user.


Market Data

15 endpoints

Access OHLCV bars across custom bar types, market regime classifications, on-chain blockchain metrics, and data quality reports.


Strategies

7 endpoints

Browse published strategies, retrieve analytics, ledger entries, timeseries, and training metadata.


Backtest

6 endpoints

Submit async backtest jobs, poll for completion, and retrieve performance analytics, trade ledgers, and per-trade timeseries.

Backtest lifecycle
POST /v1/backtest/requests → { request_id: 123, status: "pending" }
    ↓ poll until status = "completed"
GET /v1/backtest/requests/123 → { status: "completed" }
    ↓ fetch results
GET /v1/backtest/requests/123/analytics?strategy_slug=test-dollar-strategy-0

Note: The strategy_slug query param is required on analytics, ledger, and timeseries endpoints.


Optimization

9 endpoints

Submit hyperparameter optimization jobs, poll for completion, and drill into individual trial results.

Optimization lifecycle
POST /v1/optimization/requests → { request_id: 55, status: "pending" }
    ↓ poll GET /v1/optimization/requests until status = "completed"
GET /v1/optimization/requests/55 → { status: "completed" }
    ↓ browse trials
GET /v1/optimization/requests/55/trials → { tiles: {...}, trials: [...] }
    ↓ drill into a trial
GET /v1/optimization/requests/55/trials/23/analytics

Builder

6 endpoints

Build and execute custom strategy DAGs programmatically. Unlike Backtest, no published strategy slug is required.

Builder lifecycle
GET /v1/builder/meta/symbols → discover available symbols
    ↓ submit a builder request
POST /v1/builder/requests → { request_id: 77, status: "pending" }
    ↓ poll until status = "completed"
GET /v1/builder/requests/77 → { status: "completed" }
    ↓ submit for optimization (optional)
POST /v1/builder/optimization/requests → { request_id: 91 }

Alerts

7 endpoints

Manage notification config, alert subscriptions, and delivery history. Channel connections are set up in Settings → Alerts.

Channel connections must be set up through the UI

These endpoints manage subscriptions and history only — they do not create channel connections.


Virtual Accounts

10 endpoints

Create paper trading accounts, assign strategies, and track simulated P&L without real capital.


Demo Trading

13 endpoints

Manage Bybit Demo API credentials and strategy assignments for live demo execution using simulated funds.

Bybit Demo API credentials required

Credentials are validated against the Bybit Demo API before saving. BitPredict will close all open orders and positions on registration.

API Reference · BitPredict