Validators

Base class: src/validators/base.validator.ts All validators extend BaseValidator which runs Joi validation with abortEarly: false and stripUnknown: true. Validation errors return 400 with { success: false, message: 'Validation failed', errors: [...] }.

UserValidator

Source: src/validators/user.validator.ts

Method	Route	Key rules
`createUser`	`POST /api/user`	`firstName` (3–30), `lastName` (3–30), `email`, `password` (6–20, pattern), `role` (enum), `pageAccess` (ObjectId[])
`updateUser`	`PUT /api/user`	`_id` required; all create fields optional + `activeTab`, `activeTickerSymbolTab`, `activeOrderTab`
`loginValidator`	`POST /api/user/login`	`email`, `password`; optional `role`, `isForceLogin`
`resetPasswordValidator`	`PUT /api/user/resetPassword`	`_id`, `oldPassword`, `newPassword`, `confirmPassword`
`forgotPasswordValidator`	`PUT /api/user/forgetPassword`	Same as reset password

Password pattern

^[a-zA-Z0-9!@#$%^&*_=+-]{3,30}$

Length: 6–20 characters.

ZerodhaValidator

Source: src/validators/zerodha.validator.ts

Method	Route	Key rules
`placeOrderValidator`	`POST /api/zerodha/order`	`indexName`, `right` (CALL/PUT), `exchange` (NSE/BSE/NFO/MCX), `tradingsymbol`, `transaction_type`, `quantity` (positive int), `product`, `order_type`; optional `price`, `strikePrice`, `validity`, Kite advanced fields
`cancelOrderValidator`	`DELETE /api/zerodha/order/:order_id`	`order_id` in params

Allowed values

Field	Values
`exchange`	`NSE`, `BSE`, `NFO`, `MCX`
`transaction_type`	`BUY`, `SELL`
`product`	`CNC`, `MIS`, `NRML`
`order_type`	`LIMIT`, `MARKET`, `SL`, `SL-M`
`validity`	`DAY`, `IOC`
`right`	`CALL`, `PUT`

IndexSettingValidator

Source: src/validators/indexSetting.validator.ts

Method	Route	Key rules
`createIndexSetting`	`POST /api/indexSettings`	`index` (min 1) required; optional `assetClass`, `exchange`, `activeSegment`, `tradingModes`, nested `cash`/`futures`/`options` schemas
`updateIndexSetting`	`PUT /api/indexSettings`	`_id` required; same fields as create (all optional)

Nested schemas

Schema	Key fields
`cashSettingsSchema`	`instrumentToken`, `lotSize`, `isRecurringBuy`, `buyDuration`, `buyOrderType`, market protection (-1 to 100)
`futuresSettingsSchema`	Same as cash + `expiryDate`, `activeExpiry`, `futuresChainByExpiry`
`optionsSettingsSchema`	Call/put recurring fields, `optionChainByExpiry`, `lastActiveRight`, strike match values

SettingValidator

Source: src/validators/setting.validator.ts

Method	Route	Key rules
`updateSetting`	`PUT /api/setting`	`isDummyOrder` (boolean, optional)

BaseValidator.handler

static async handler(validator: Schema, req, res, next) {
  const { error, value } = validator.validate(req.body, {
    abortEarly: false,
    stripUnknown: true,
  });
  if (error) return res.status(400).json({ success: false, message: 'Validation failed', errors });
  req.body = value;
  return next();
}

Routes without validators (e.g. GET endpoints, scheduleOrder) rely on controller-level validation or query param parsing.

Architecture

Authentication

Database Models

API Reference

Trading Engine

Zerodha Integration

Real-time

Reference

UserValidator

Password pattern

ZerodhaValidator

Allowed values

IndexSettingValidator

Nested schemas

SettingValidator

BaseValidator.handler

​UserValidator

​Password pattern

​ZerodhaValidator

​Allowed values

​IndexSettingValidator

​Nested schemas

​SettingValidator

​BaseValidator.handler

UserValidator

Password pattern

ZerodhaValidator

Allowed values

IndexSettingValidator

Nested schemas

SettingValidator

BaseValidator.handler