A step-by-step path through the SDK, from first login to live-ready trading tools. Every step links to runnable examples in examples/ and shows real output from the UAT sandbox.
flowchart LR
A[0 Setup] --> B[1 Authentication] --> C[2 Instruments] --> D[3 Market Data]
D --> E[4 Realtime] --> F[5 Trading] --> G[6 Portfolio] --> H[7 Recipes]
| Step | Page | You will do | Examples |
|---|---|---|---|
| 0 | Setup | Install, create .env, run a first example on UAT |
introduction |
| 1 | Authentication | Log in with OTP, .env or institutional credentials |
authentication, uat_environment |
| 2 | Instruments | Find the right stock, future or option contract | get_instruments |
| 3 | Market Data | Prices, depth, option chains, history, fundamentals | market_data |
| 4 | Realtime Data | Stream indices, option chains, depth, Greeks and candles | realtime_data |
| 5 | Trading | Place, modify, cancel orders and multi-leg strategies | trading |
| 6 | Portfolio | Funds, holdings, positions and P&L | portfolio |
| 7 | Recipes and Next Steps | Task lookup, worked workflows, going-live checklist | all of the above |
Start at step 0 and go in order, or jump to the page you need. Each page opens and closes with Previous and Next links.
Reference: Glossary (exact field and method names, allowed values) and API rate limits.
| I want to... | Go to |
|---|---|
| Log in without typing an OTP every time | 1. Authentication |
| Find a contract's ref_id, lot size or expiry | 2. Instruments |
| Pull an option chain into pandas | 3. Market Data |
| Watch a live ATM straddle | 4. Realtime Data |
| Check margin, then place an order | 5. Trading |
| See my P&L in rupees | 6. Portfolio |
| Go live safely | 7. Recipes and Next Steps |
- UAT first. Every example defaults to the sandbox. Switching to live is a one-line change, covered in Setup and the going-live checklist.
- Prices are paise. The API returns integers (116770 means Rs 1167.70). Examples print rupees and keep request payloads in paise.
- SDK version. Written and tested on
nubra-sdk0.5.4. See VERSIONS.md and the changelog.