Changelog

A record of all API changes, additions, and deprecations.

v1.0.0

Initial ReleaseMay 2026

The first public version of the BitPredict REST API. 73 endpoints across 9 domains covering market data, strategy execution, backtesting, optimization, and account management.

Endpoints

Domains

Version prefix

SHA-256

Key hashing

API key authentication — SHA-256 hashed keys with bp_live_ prefix. Keys are shown once at creation and never stored in plaintext.

Rate limiting by plan — Per-key rate limits configurable via server environment variables. Free, Pro, and Institutions tiers with different limits.

Async job execution — Backtests, optimization runs, and builder jobs execute asynchronously with status polling.

Full pagination — All list endpoints support page and page_size parameters with total count in response.

Rate limit headers — X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and Retry-After on 429 responses.

Endpoints by domain

Account4 endpoints

/account/me

/account/credits

/account/usage

/account/subscription

Market Data15 endpoints

/data/catalog

/data/catalog/coverage

/data/bars/time

/data/bars/{bar_type}

/data/regimes/{e}/{s}/current

/data/regimes/{e}/{s}/state

/data/regimes/{e}/{s}/history

/data/regimes/{e}/{s}/statistics

/data/regimes/{e}/{s}/across-bar-types

/data/blockchain/metrics

/data/blockchain/summary

/data/blockchain/history/{metric}

/data/blockchain/history/multi

/data/quality/summary

/data/quality/detailed

Strategies7 endpoints

/strategies

/strategies/overview

/strategies/{slug}

/strategies/{slug}/analytics

/strategies/{slug}/ledger

/strategies/{slug}/timeseries

/strategies/{slug}/training

Backtests6 endpoints

/backtest/requests (POST)

/backtest/requests (GET)

/backtest/requests/{id}

/backtest/requests/{id}/analytics

/backtest/requests/{id}/ledger

/backtest/requests/{id}/timeseries

Optimization9 endpoints

/optimization/requests (POST)

/optimization/requests (GET)

/optimization/requests/{id}

/optimization/requests/{id}/results

/optimization/requests/{id}/best-trial

/optimization/requests/{id}/trials

/optimization/requests/{id}/trials/{trial_id}

/optimization/requests/{id}/trials/{trial_id}/analytics

Builder6 endpoints

/builder/requests (POST)

/builder/requests (GET)

/builder/requests/{id}

/builder/requests/{id}/analytics

/builder/requests/{id}/ledger

/builder/requests/{id}/timeseries

Alerts7 endpoints

/alerts/subscriptions (GET)

/alerts/subscriptions (POST)

/alerts/subscriptions/{id} (GET)

/alerts/subscriptions/{id} (PATCH)

/alerts/subscriptions/{id} (DELETE)

/alerts/history (GET)

/alerts/history/{id} (GET)

Virtual Accounts10 endpoints

/virtual-accounts (GET)

/virtual-accounts (POST)

/virtual-accounts/{id} (GET/PATCH/DELETE)

/virtual-accounts/{id}/ledger

/virtual-accounts/{id}/assignments (GET/POST)

/virtual-accounts/{id}/assignments/{aid} (GET/PATCH/DELETE)

Demo Trading13 endpoints

/demo-trading/api-keys (GET/POST)

/demo-trading/api-keys/{id} (GET/PATCH/DELETE)

/demo-trading/api-keys/{id}/positions

/demo-trading/api-keys/{id}/balance

/demo-trading/api-keys/{id}/orders

/demo-trading/api-keys/{id}/assignments (GET/POST)

/demo-trading/api-keys/{id}/assignments/{aid} (GET/PATCH/DELETE)