bt_api_py¶
bt_api_py provides one BtApi façade over installed exchange plugins and an optional ZeroMQ forwarding boundary. The active documentation describes the current package contract; archived plans and historical venue claims are not release guarantees.
Start here¶
- Install and run doctor
- Use the typed API
- Read the public API reference
- Understand direct and ZMQ boundaries
- Read support-status evidence rules
- Read the 0.15.4 release notes
Runtime guarantee boundaries¶
- Direct mode preserves the installed Feed's legacy return values.
- ZMQ mode returns typed snapshots or typed command acknowledgements for its implemented operations.
Consistency.LIVEnever silently returns an old market cache entry;Consistency.CACHE_OKmarks an allowed cache result as stale.- Missing plugins, unsupported operations, live-query failure, stale-cache absence, and unknown command results are separate domain errors.
Support status¶
The entries below are evidence tiers, not a count of production-ready exchanges.
| Scope | Tier | Evidence boundary | Current limitation |
|---|---|---|---|
| core-reference bundle | experimental | Bundle metadata for BINANCESPOT, OKXSPOT and CTP___FUTURE; not a live-trading or installed-plugin certification. | Current isolated submodule diagnostic has no initialized plugin worktrees, so package install/import/test certification is pending. |
| other registered plugins | unverified | Registry or submodule presence only. | Do not infer REST, WebSocket, paper-trading, or production readiness from registration alone. |
Blocking CI supports Python 3.11, 3.12, 3.13; Python 3.14 is canary-only.
See docs/operations/support-status-policy.md for the evidence and expiry rules.