AppSettingSource:
src/models/indexSetting.model.tsInterface:
IIndexSettings
Top-level fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
index | string | Yes | — | Unique symbol key (indexed) |
indexLabel | string | Yes | — | Display name |
trueDataIndex | string | No | "" | Legacy TrueData symbol |
assetClass | enum | Yes | INDEX | INDEX, STOCK, ETF, COMMODITY, CURRENCY |
exchange | enum | Yes | NFO | NSE, BSE, NFO, BFO, MCX, CDS, BCD |
symbolType | string | Yes | Index | e.g. Index, Stock |
backgroundColor | string | No | — | UI colour |
textColor | string | No | — | UI text colour |
isActive | boolean | No | false | Whether trading services run for this symbol |
soundBaseDifference | number | No | 0 | Alert threshold |
isIncreaseNotification | boolean | No | false | Price increase alert |
isDecreaseNotification | boolean | No | false | Price decrease alert |
tradingModes | object | No | — | { cash, futures, options } booleans |
activeSegment | enum | No | options | cash, futures, options |
optionsUnderlyingType | enum | No | SPOT | SPOT or FUTURES |
optionExpiriesByFuturesExpiry | Map | No | — | Futures expiry → option expiry list |
cash | CashSettings | No | — | Cash segment config |
futures | FuturesSettings | No | — | Futures segment config |
options | OptionsSettings | No | — | Options segment config |
createdBy | ObjectId | No | — | Ref to User |
updatedBy | ObjectId[] | No | — | Refs to User |
Cash settings (cash)
| Field | Type | Default | Description |
|---|---|---|---|
instrumentToken | number | 0 | Zerodha instrument token |
lotSize | number | 1 | Lot size |
tradingsymbol | string | "" | Trading symbol |
lastPrice | number | — | Last traded price |
isRecurringBuy | boolean | false | Enable recurring buy |
buyQuantity | number | 0 | Buy lot count |
buyDuration | number | 0 | Interval in minutes |
buyOrderLimit | number | 0 | Max open buy orders |
buyOrderType | enum | MARKET | MARKET or LIMIT |
sellOrderType | enum | MARKET | MARKET or LIMIT |
buyMarketProtection | number | 0 | Market protection % |
sellMarketProtection | number | 0 | Market protection % |
Futures settings (futures)
| Field | Type | Default | Description |
|---|---|---|---|
instrumentToken | number | 0 | Active futures token |
lotSize | number | 1 | Lot size |
tradingsymbol | string | "" | Contract symbol |
expiryDate | string | "" | Active expiry |
activeExpiry | string | "" | Selected expiry key |
contractFormat | string | "" | Symbol format template |
futuresChainByExpiry | Map | — | Expiry → chain entry |
isRecurringBuy | boolean | false | Enable recurring buy |
buyQuantity | number | 0 | Buy lot count |
buyDuration | number | 0 | Interval in minutes |
buyOrderLimit | number | 0 | Max open buy orders |
buyOrderType | enum | MARKET | Order type |
sellOrderType | enum | MARKET | Order type |
buyMarketProtection | number | 0 | Protection % |
sellMarketProtection | number | 0 | Protection % |
Futures chain entry (futuresChainByExpiry value)
| Field | Type | Description |
|---|---|---|
expiryDate | string | Expiry date string |
expiryType | enum | weekly or monthly |
lotSize | number | Contract lot size |
tradingsymbol | string | Kite symbol |
instrumentToken | number | Token |
contractFormat | string | Format template |
Options settings (options)
| Field | Type | Default | Description |
|---|---|---|---|
underlyingToken | number | 0 | Underlying instrument token |
underlyingSymbol | string | "" | Underlying symbol |
linkedFuturesExpiry | string | "" | Linked futures expiry |
expiryDate | string | "" | Active option expiry |
expiryType | enum | monthly | weekly or monthly |
lotSize | number | 1 | Lot size |
baseDiff | number | 100 | Strike step |
lastActiveRight | enum | — | CALL or PUT |
buyOrderType | enum | MARKET | Buy order type |
sellOrderType | enum | MARKET | Sell order type |
isRecurringSell | boolean | false | Trailing sell enabled |
isPlacingCallOrder | boolean | false | Call order active |
isCallRecurringBuy | boolean | false | Call recurring buy |
callDifference | number | 0 | Call strike offset |
callQuantity | number | 1 | Call lot count |
callBuyDuration | number | 0 | Call buy interval |
callBuyOrderLimit | number | 0 | Call buy limit |
callTargetSellPrice | number | 0 | Call target sell |
callSellDuration | number | 1 | Call trailing duration |
callBuyMarketProtection | number | 0 | Call buy protection |
callSellMarketProtection | number | 0 | Call sell protection |
strikeMatchValueCallDifference | number | 0 | Strike-match call offset |
isPlacingPutOrder | boolean | false | Put order active |
isPutRecurringBuy | boolean | false | Put recurring buy |
putDifference | number | 0 | Put strike offset |
putQuantity | number | 1 | Put lot count |
putBuyDuration | number | 0 | Put buy interval |
putBuyOrderLimit | number | 0 | Put buy limit |
putTargetSellPrice | number | 0 | Put target sell |
putSellDuration | number | 1 | Put trailing duration |
putBuyMarketProtection | number | 0 | Put buy protection |
putSellMarketProtection | number | 0 | Put sell protection |
strikeMatchValuePutDifference | number | 0 | Strike-match put offset |
optionChainByExpiry | Map | — | Expiry → strike chain |
Option chain expiry (optionChainByExpiry value)
| Field | Type | Description |
|---|---|---|
expiryDate | string | Expiry date |
expiryType | enum | weekly or monthly |
lotSize | number | Lot size |
baseDiff | number | Strike step |
strikeList | number[] | Available strikes |
strikes | Map | Strike price → { ce, pe } legs |
Option strike leg (ce / pe)
| Field | Type | Description |
|---|---|---|
tradingsymbol | string | Kite symbol |
instrument_token | number | Token |
lot_size | number | Lot size |