09 - REST API Documentation
Registration
restx_api/__init__.py creates api_v1_bp with prefix /api/v1 and registers 47 namespaces, which expose 74 current method/path pairs across order, account, market-data, option, calendar, analyzer, portfolio, SIP, preference, messaging, and utility namespaces.
The Flask-RESTX Api is configured with doc=False. Swagger/OpenAPI UI is intentionally disabled and there is no supported /api/docs route. The maintained external contract is the API documentation.
Resource Pattern
Most resources follow this sequence:

Schemas are split by domain:
restx_api/schemas.py
Orders, options execution, margin, GTT
restx_api/data_schemas.py
Quotes, history, symbols, calendar, Greeks, instruments
restx_api/account_schema.py
Account, analyzer, ping, chart, P&L
Unknown fields are excluded by most schemas. ChartSchema explicitly includes unknown fields because chart preferences are extensible.
Authentication And CSRF
REST resources generally accept apikey in JSON for POST or query parameters for GET. Telegram and WhatsApp resources also support X-API-KEY on selected calls. The Telegram webhook uses its Telegram secret header.
app.py exempts the /api/v1 blueprint from CSRF because these calls do not use the browser form/session trust boundary. API-key verification remains mandatory unless an endpoint has a separate external authentication contract.
Rate-Limit Classes
API_RATE_LIMIT
50/second from .sample.env
Market data, account reads, chart, analyzer
ORDER_RATE_LIMIT
10/second
Place/modify/cancel and options/GTT writes
SMART_ORDER_RATE_LIMIT
10/second
Position-aware smart order
Endpoint-specific
Varies
Greeks (30/minute), SIP and portfolio backtests (10/minute), tearsheet (5/minute), Telegram and WhatsApp (30/minute)
All are environment/configuration values; compound limits joined by semicolons are supported. Note that most restx_api modules fall back to 10 per second for API_RATE_LIMIT when the key is absent from .env, not to the 50 per second shown in .sample.env. See 36 Rate Limiting.
Mode Routing
Live mode resolves
broker.<key>modules through the active API-key session.Analyzer mode routes supported order/account operations to the sandbox engine.
Analyzer GTT place, modify, cancel and orderbook route to
sandbox/gtt_manager.py. In live mode the same four services return 501 when the selected broker ships noapi/gtt_api.py, which today means brokers other than Angel One, Dhan, Fyers, Rupeezy, Upstox and Zerodha.Semi-auto mode queues eligible execution in Action Center and blocks defined destructive operations.
/pnl/symbolsis analyzer-only.
Validation Details
Regular order quantity is numeric and positive. Fractional quantity is allowed only for
CRYPTO; other exchanges are coerced to whole integers or rejected.Options execution quantity is a positive integer.
Options multi-order accepts 1 to 20 legs.
Multi-option Greeks accepts 1 to 50 symbols.
Option-chain
strike_count, when provided, is 1 to 100.History accepts
source=apiorsource=db;dbreads Historify.Instruments is GET and can return JSON or CSV.
Response Boundaries
OpenAlgo normalizes wrapper status and core fields, but broker-specific payload data is not exhaustively identical for all 38 plugins. Some endpoints intentionally return CSV, plain text, or empty webhook acknowledgements. Clients must use the endpoint contract rather than assuming every response is {status,data}.
Adding A Resource
Add or reuse a Marshmallow schema.
Put reusable behavior in
services/, not the resource method.Register the namespace in
restx_api/__init__.py.Add the method/path to
docs/api/README.mdand its endpoint page.Add the row to
docs/bdd/rest_api_inventory.featureand behavior scenarios where needed.Add focused tests for validation, auth, mode routing, and response shape.
Last updated