Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Start or stop automated recurring buy intervals
/api/recurringOrder
Source: src/routes/recurringOrder.route.ts
| Method | Path | Auth | Description |
|---|---|---|---|
POST | / | isAuth | Start or stop a recurring buy interval for an index |
| Field | Type | Required | Description |
|---|---|---|---|
indexName | string | Yes | Index setting key |
right | CALL | PUT | No | Required for options segment |
recurringStatus | boolean | Yes | true to start, false to stop |
recurringTime | number | Yes | Interval in minutes (min 0.1667 ≈ 10 seconds) |
exchange | string | No | Default NFO |
order_type | string | No | Default MARKET |
product | string | No | Default NRML |
validity | string | No | Default IOC |
recurringStatus: true, registers an interval keyed recurringOrder_{indexName}_{right}.latestDataMap, evaluates strike conditions, and places BUY orders via Zerodha (or dummy mode).recurringStatus: false, stops the interval and optionally triggers bulk sell.RecurringOrder collection for session recovery.