Introduction
PipAI Developer Docs is the reference for the public REST surface backing the PipAI quant tooling. The current backend is a thin FastAPI gateway in front of Binance USDⓈ-M Futures. It exposes:
- Strategies — a CRUD registry of strategy definitions (name, author, description, entry/exit conditions, executor binding). The platform stores metadata only; running a strategy is the executor's job.
- Market data — passthrough access to Binance Futures klines, ticker, depth, exchange info, funding rates, premium index, open interest, long/short ratios, plus curated lists of launches and delistings.
- Auth helpers — email-based verification of a Binance API key the user has previously registered with the platform.
What's documented here
| Module | Status |
|---|---|
| Strategies | Documented (this site) |
| Market Data | Documented (this site) |
| Backtesting | Placeholder — backend not implemented yet |
| Webhooks | Placeholder — backend not implemented yet |
Backtesting and Webhooks pages exist as forward-looking design sketches; do not treat them as implemented.
Conventions
- All requests/responses use JSON.
- Error envelope:
{"detail": "<message>"}. - Rate limit: 1000 requests per minute per IP.
See General Info, Authentication, and Errors for the details.