Interfaces

IUser

Source: src/interfaces/user.interface.ts

Field	Type	Description
`firstName`, `middleName`, `lastName`	string	Profile
`email`	string	Login email
`password`	string	Hashed password
`loginToken`	string	Active JWT
`mfaSecret`	string	TOTP secret
`role`	string	`admin` or `user`
`pageAccess`	string[]	AppSetting ObjectIds
`activeTab`	string[]	Dashboard tabs
`activeTickerSymbolTab`	string	Active ticker
`activeOrderTab`	string	Order view
`isLoggedIn`	boolean	Session flag
`isActive`	boolean	Account enabled
`isMfaEnabled`	boolean	MFA configured
`isMfaVerified`	boolean	MFA verified
`deleted`	boolean	Soft delete
`createdBy`	string	Creator user ID
`updatedBy`	string \| string[]	Updater IDs

IIndexSettings

Source: src/interfaces/indexSetting.interface.ts Top-level index setting with nested segment interfaces:

Interface	Purpose
`IIndexSettings`	Root config: `index`, `exchange`, `activeSegment`, `tradingModes`
`ICashSettings`	Cash segment recurring buy and order types
`IFuturesSettings`	Futures chain, expiry, recurring buy
`IOptionsSettings`	Call/put automation, strike chain, trailing sell

Type aliases

Alias	Values
`AssetClass`	`INDEX`, `STOCK`, `ETF`, `COMMODITY`, `CURRENCY`
`Exchange`	`NSE`, `BSE`, `NFO`, `BFO`, `MCX`, `CDS`, `BCD`
`ActiveSegment`	`cash`, `futures`, `options`
`ExpiryType`	`weekly`, `monthly`
`OptionsUnderlyingType`	`SPOT`, `FUTURES`

IKiteOrder

Source: src/interfaces/zerodha.interface.ts Extends KiteOrder with platform-specific fields:

Field	Type	Description
`userId`	string	Placing user
`indexName`	string	Index setting key
`right`	`CALL` \| `PUT`	Option side
`strikePrice`	number	Strike
`isSold`	boolean	Sell completed
`isScheduled`	boolean	Trailing sell order
`scheduleDuration`	number	Trailing duration
`parent_order_ids`	string[]	Order chain
`marketProtection`	number	Protection %
`baseValue`	number	Index at placement

Kite Connect types

Interface	Purpose
`KiteOrderParams`	Place order request
`KiteOrder`	Kite order response
`KiteHolding`	Portfolio holding
`KitePosition`	Day/net position
`KiteMarginsResponse`	Margin data
`KiteQuote`	Live quote with depth
`KiteInstrument`	Instrument master entry
`KiteTick`	WebSocket tick
`IKiteConnect`	Kite Connect client method signatures
`IKiteTicker`	WebSocket ticker interface
`IZerodha`	MongoDB token document

Literal types

Exchange, TransactionType, ProductType, OrderType, Validity, Mode, OrderVariety, Right, OrderStatus

IIndexDataRecord

Source: src/interfaces/indexData.interface.ts Persisted snapshot fields: type, dataProvider, segments, date, time, OI metrics, ask/bid prices, and price differences. See Index Data model.

IIndexData

Source: src/interfaces/Index.interface.ts Legacy TrueData tick: Symbol, LTP, OI, Volume, bid/ask. See Index model.

ISetting

Source: src/interfaces/setting.interface.ts

Field	Type	Description
`isDummyOrder`	boolean	Dummy mode flag

ApiResponse<T>

Source: src/interfaces/response.interface.ts Standard API response wrapper:

interface ApiResponse<T> {
  success?: boolean;
  message?: string;
  data?: T;
}

Architecture

Authentication

Database Models

API Reference

Trading Engine

Zerodha Integration

Real-time

Reference

IUser

IIndexSettings

Type aliases

IKiteOrder

Kite Connect types

Literal types

IIndexDataRecord

IIndexData

ISetting

ApiResponse<T>

​IUser

​IIndexSettings

​Type aliases

​IKiteOrder

​Kite Connect types

​Literal types

​IIndexDataRecord

​IIndexData

​ISetting

​ApiResponse<T>

IUser

IIndexSettings

Type aliases

IKiteOrder

Kite Connect types

Literal types

IIndexDataRecord

IIndexData

ISetting

ApiResponse<T>