Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
CRUD endpoints for per-symbol trading configuration
/api/indexSettings
Source: src/routes/indexSetting.route.ts
MongoDB collection: appsettings (model name AppSetting)
| Method | Path | Auth | Description |
|---|---|---|---|
POST | / | isAdmin, createIndexSetting | Create a new index setting |
GET | /get/:id | None | Get a single index setting by MongoDB _id |
GET | /getAll | isAuth | List all index settings (authenticated users) |
PUT | / | isAdmin, updateIndexSetting | Update an index setting (_id required in body) |
PUT | /resetAllPageIndexSetting | isAdmin | Reset page-level index settings to defaults |
DELETE | /:id | isAdmin | Delete an index setting |
PATCH | /activeInactive/:id | isAdmin | Toggle isActive for an index setting |
IndexSettingValidator. Key top-level fields:
| Field | Type | Notes |
|---|---|---|
index | string | Unique symbol key (e.g. nifty, banknifty) |
indexLabel | string | Display label |
assetClass | enum | INDEX, STOCK, ETF, COMMODITY, CURRENCY |
exchange | enum | NSE, BSE, NFO, BFO, MCX, CDS, BCD |
activeSegment | enum | cash, futures, options |
tradingModes | object | { cash, futures, options } booleans |
cash | object | Cash segment settings (see Index Setting model) |
futures | object | Futures segment settings |
options | object | Options segment settings including strike chain |
GET /get/:id has no auth middleware — ensure this is acceptable for your deployment or add middleware if needed.