API Reference
API Reference is organised by API segment so you can move directly to the operation, resource or socket you need. Each page contains the purpose, prerequisites, endpoint area, example request attributes, example code, example response attributes, response example, errors and related documentation.
API Reference sections
| Section | What it contains |
|---|---|
| API Standards | Shared formats, authentication headers, timestamps, errors, and retry behaviour. |
| Authentication | Authorization-code and access-token operations for individual and third-party apps. |
| Trading | Order placement and management, order book, trade book, positions, and webhooks. |
| Market Data | Quotes, historical candles, depth, option/futures chains and expired F&O data. |
| Reports | Order, trade, charges, P&L, tax and ledger reporting resources. |
| Account | Profile, funds, holdings, logout, and EDIS / DDPI workflows. |
| Market Information | Market status and Symbol Master files. |
| Margin Calculator | SPAN and multi-order margin estimation. |
| Price Alerts | Create, read, modify, delete, and enable/disable price alerts. |
| WebSockets | Data Socket (including Tick By Tick depth) and General Socket lifecycle and events. |
| Appendix | Symbol Master, symbology resources, and common API error codes. |
Last updated on