{ "components": { "securitySchemes": { "mockBearer": { "description": "Enter any non-empty value. Mock authentication does not verify token contents or require a JWT.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Stateless development mock extracted from supplied DOCX files. Optionally select X-Mock-Scenario. Synthetic and reconstructed examples are labelled. No trades, payments, OTPs or external integrations are executed.", "title": "Trading Modules — Mock API", "version": "1.0.0" }, "openapi": "3.0.3", "paths": { "/alerts-rest/alert/create": { "post": { "description": "Creates a new price or event-based alert for a given scrip. The alert fires when the configured market condition is met.", "operationId": "post-alerts-rest-alert-create", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "alertName": "TEST", "alertType": "LastTradedPrice", "exch": "NSE", "exchSeg": "", "expiry": "", "operator": "greaterequal", "scripName": "IDEA-EQ", "token": "14366", "triggerStatus": "", "triggeredTime": "", "value": "10", "valueType": "Price" }, "schema": { "properties": { "alertName": { "description": "Human-readable name/label for this alert (e.g., \"TCS LTP Alert\").", "type": "string", "x-data-type": "string" }, "alertType": { "description": "Type of alert. Accepted values: LastTradedPrice, LTP, ltp (broker-dependent — see §4.5).", "type": "string", "x-data-type": "string" }, "exch": { "description": "Exchange code. E.g., NSE, BSE.", "type": "string", "x-data-type": "string" }, "exchSeg": { "description": "Exchange segment (e.g., NSE_EQ, NSE_CM). Format varies by broker — see §4.5.", "type": "string", "x-data-type": "string" }, "expiry": { "anyOf": [ { "enum": [ "" ], "type": "string", "x-data-type": "string" }, { "format": "date-time", "type": "string", "x-data-type": "date-time" } ], "description": "Alert expiry date-time. Pass empty string if no expiry.", "x-data-type": "union" }, "operator": { "description": "Comparison operator. Accepted: greater, lesser, greaterequal, \u003e=, \u003c= (broker-dependent — see §4.5).", "type": "string", "x-data-type": "string" }, "scripName": { "description": "Symbol/scrip name as recognised by the exchange. E.g., IDEA-EQ, TCS-EQ.", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange-assigned numeric token for the scrip.", "type": "string", "x-data-type": "string" }, "triggerStatus": { "description": "Current trigger state. Pass empty string on creation.", "type": "string", "x-data-type": "string" }, "triggeredTime": { "description": "Last triggered timestamp. Pass empty string on creation.", "type": "string", "x-data-type": "string" }, "value": { "description": "Target price or value that should trigger the alert.", "type": "string", "x-data-type": "string" }, "valueType": { "description": "Type of value tracked. E.g., Price. (Mock Provider / Mock Provider only)", "type": "string", "x-data-type": "string" } }, "required": [ "alertName", "alertType", "exch", "operator", "scripName", "token", "value" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "message": "Failed", "result": [], "status": "Not ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "infoMessage": null, "message": "Alert successfully set", "result": null, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "nullable": true }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Create Alert", "tags": [ "alerts" ], "x-request-schema-file": "schemas/requests/alerts/post-alerts-rest-alert-create.json" } }, "/alerts-rest/alert/delete/{id}": { "post": { "description": "Permanently removes an alert by its identifier. The alert ID is passed as a URL path parameter.", "operationId": "post-alerts-rest-alert-delete-id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "integer", "x-data-type": "integer" } ], "x-data-type": "union" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object", "x-data-type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ "Alert deleted successfully" ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "type": "string" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Delete Alert", "tags": [ "alerts" ], "x-request-schema-file": "schemas/requests/alerts/post-alerts-rest-alert-delete-id.json" } }, "/alerts-rest/alert/list": { "get": { "description": "Retrieves all alerts configured for the authenticated user. Returns an array of alert objects in the result field.", "operationId": "get-alerts-rest-alert-list", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "alertName": "NIFTY alert 1", "alertType": "LTP", "createdOn": "2025-11-20 15:39:41", "exch": "NSE", "exchSeg": null, "expiry": null, "id": 1, "operator": "greater", "scripName": "NIFTY 50", "token": "26000", "triggerStatus": null, "triggeredTime": null, "value": 26000 } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "alertName": { "type": "string" }, "alertType": { "type": "string" }, "createdOn": { "type": "string" }, "exch": { "type": "string" }, "exchSeg": { "nullable": true }, "expiry": { "nullable": true }, "id": { "type": "integer" }, "operator": { "type": "string" }, "scripName": { "type": "string" }, "token": { "type": "string" }, "triggerStatus": { "nullable": true }, "triggeredTime": { "nullable": true }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Alerts", "tags": [ "alerts" ], "x-request-schema-file": "schemas/requests/alerts/get-alerts-rest-alert-list.json" } }, "/alerts-rest/alert/modify": { "post": { "description": "Updates the parameters of an existing alert identified by its id. All fields that were used to create the alert should be re-submitted along with the updated values.", "operationId": "post-alerts-rest-alert-modify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "alertName": "TEST", "alertType": "LastTradedPrice", "exch": "NSE", "exchSeg": "", "expiry": "", "id": 30, "operator": "greaterequal", "scripName": "IDEA-EQ", "token": "14366", "triggerStatus": "", "triggeredTime": "", "value": "9", "valueType": "Price" }, "schema": { "properties": { "alertName": { "description": "Updated name/label for the alert.", "type": "string", "x-data-type": "string" }, "alertType": { "description": "Alert type (same accepted values as Create Alert).", "type": "string", "x-data-type": "string" }, "exch": { "description": "Exchange code.", "type": "string", "x-data-type": "string" }, "exchSeg": { "description": "Exchange segment.", "type": "string", "x-data-type": "string" }, "expiry": { "anyOf": [ { "enum": [ "" ], "type": "string", "x-data-type": "string" }, { "format": "date-time", "type": "string", "x-data-type": "date-time" } ], "description": "Updated expiry date-time.", "x-data-type": "union" }, "id": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "integer", "x-data-type": "integer" } ], "description": "Unique identifier of the alert to be modified. Integer for most brokers; string for Mock Provider.", "x-data-type": "union" }, "operator": { "description": "Comparison operator.", "type": "string", "x-data-type": "string" }, "scripName": { "description": "Scrip/symbol name.", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange token for the scrip.", "type": "string", "x-data-type": "string" }, "triggerStatus": { "description": "Current trigger status.", "type": "string", "x-data-type": "string" }, "triggeredTime": { "description": "Last triggered time (carry forward from existing alert).", "type": "string", "x-data-type": "string" }, "value": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Updated trigger value.", "x-data-type": "union" }, "valueType": { "description": "Value type. (Mock Provider / Mock Provider only)", "type": "string", "x-data-type": "string" } }, "required": [ "id", "alertName", "alertType", "exch", "operator", "scripName", "token", "value" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": null, "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "nullable": true }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Modify Alert", "tags": [ "alerts" ], "x-request-schema-file": "schemas/requests/alerts/post-alerts-rest-alert-modify.json" } }, "/api/chart/history": { "post": { "description": "Fetches historical OHLC bar data for a specific instrument and resolution range. This is the internal chart loader endpoint used by the charting frontend to load candle data.", "operationId": "post-api-chart-history", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exchange": "MCX", "from": "1774839572000", "resolution": "1", "to": "1778823094000", "token": "488290" }, "schema": { "properties": { "exchange": { "description": "Exchange — NSE, BSE, NFO, MCX", "type": "string", "x-data-type": "string" }, "from": { "description": "Start timestamp (Unix epoch seconds)", "type": "string", "x-data-type": "string" }, "resolution": { "description": "Chart resolution — 1, 5, 15, 30, 60, 240, 1440, 1D", "type": "string", "x-data-type": "string" }, "to": { "description": "End timestamp (Unix epoch seconds)", "type": "string", "x-data-type": "string" }, "token": { "description": "Instrument token ID", "type": "string", "x-data-type": "string" }, "user": { "description": "User ID for user-specific data", "type": "string", "x-data-type": "string" } }, "required": [ "token", "resolution", "from", "to", "exchange" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": null, "result": [ { "close": 9051, "high": 9061, "low": 9017, "open": 9044, "time": "2026-03-30 09:00:59", "volume": 215 } ], "stat": "Ok" }, "schema": { "properties": { "message": { "nullable": true }, "result": { "items": { "properties": { "close": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "open": { "type": "number" }, "time": { "type": "string" }, "volume": { "type": "number" } }, "type": "object" }, "type": "array" }, "stat": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "POST /api/chart/history — Get OHLC Data", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/post-api-chart-history.json" } }, "/api/profile/accountDetails": { "get": { "description": "Returns a flat summary of account details including status, enabled exchanges, products, and contact information.", "operationId": "get-api-profile-accountdetails", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "113148", "accountName": "GANGADHAR JANGAM", "accountStatus": "Activated", "cellAddr": "8686105177", "dpType": "NA", "emailAddr": "jangamgadhar@gmail.com", "exchEnabled": "nse_cm|bse_cm|bse_fo|bcs_fo|cde_fo|mcx_fo|nse_fo|", "poaStatus": "N", "product": [ "CNC", "NRML", "MIS", "MTF", "CO", "BO" ], "sBrokerName": "Mock Provider" }, "schema": { "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "accountStatus": { "type": "string" }, "cellAddr": { "type": "string" }, "dpType": { "type": "string" }, "emailAddr": { "type": "string" }, "exchEnabled": { "type": "string" }, "poaStatus": { "type": "string" }, "product": { "items": { "type": "string" }, "type": "array" }, "sBrokerName": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Account Details", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/get-api-profile-accountdetails.json" } }, "/api/v1/marketWatch/addscrip": { "post": { "description": "Adds one or more tradable scrips into a user's watchlist tab up to the configured scrip limit (default 50 per watchlist). Enriches the response with company metadata, lot size, and tick size.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-marketwatch-addscrip", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 1, "scripData": [ { "exchange": "NSE", "token": "2885" }, { "exchange": "NSE", "token": "11536" } ] }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to add scrips into.", "type": "integer", "x-data-type": "integer" }, "scripData": { "description": "Array of scrip identifiers to add.", "items": { "properties": { "exchange": { "description": "Exchange of the scrip (e.g., \"NSE\", \"BSE\", \"NFO\").", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange token of the scrip.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } }, "required": [ "mwId", "scripData" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW119", "message": "Symbol already added in market watch", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": { "scrip": [ { "companyName": "RELIANCE INDUSTRIES LTD", "exchange": "NSE", "formattedInsName": "RELIANCE EQ", "lotSize": "1", "sortOrder": 1, "symbol": "RELIANCE", "tickSize": "0.05", "token": "2885", "tradingSymbol": "RELIANCE-EQ" } ] }, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "scrip": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "formattedInsName": { "type": "string" }, "lotSize": { "type": "string" }, "sortOrder": { "type": "integer" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Add Scrip to MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-marketwatch-addscrip.json" } }, "/api/v1/marketWatch/contract/info": { "post": { "description": "Returns underlying security information, active F\u0026O derivatives (futures \u0026 options series), freeze quantity, MTF leverage, and AMO ordering status for a given scrip identified by exchange and token.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-marketwatch-contract-info", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "exchange": "NSE", "token": "2885" }, "schema": { "properties": { "exchange": { "description": "Exchange of the underlying scrip (e.g., \"NSE\").", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange token of the underlying scrip.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW111", "message": "Token does not exist", "result": [], "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": [ { "freezeQty": "10000", "isAmoApplicable": true, "isin": "INE002A01018", "scrips": [ { "exchange": "NFO", "expiry": "2026-10-29", "formattedInsName": "RELIANCE 26 OCT 3000 CE", "insType": "OPTSTK", "isFnOAvailable": true, "lotSize": "250", "mtfMargin": "0", "multiplier": "1", "pdc": "45.20", "symbol": "RELIANCE", "tickSize": "0.05", "token": "135678", "tradingSymbol": "RELIANCE26OCT3000CE" } ] } ], "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "items": { "properties": { "freezeQty": { "type": "string" }, "isAmoApplicable": { "type": "boolean" }, "isin": { "type": "string" }, "scrips": { "items": { "properties": { "exchange": { "type": "string" }, "expiry": { "type": "string" }, "formattedInsName": { "type": "string" }, "insType": { "type": "string" }, "isFnOAvailable": { "type": "boolean" }, "lotSize": { "type": "string" }, "mtfMargin": { "type": "string" }, "multiplier": { "type": "string" }, "pdc": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Contract Info \u0026 Option Chain", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-marketwatch-contract-info.json" } }, "/api/v1/marketWatch/createMW": { "post": { "description": "Creates a new empty watchlist for the authenticated user. Supports up to a configured maximum (default 6, IDs 1–6 or 101–106). Watchlist names cannot exceed 15 characters and reserved names (NIFTY 50, RECENTLYVIEWED, MYSTOCKS, POSITIONS, HOLDINGS) are prohibited.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-marketwatch-createmw", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwName": "Tech Stocks" }, "schema": { "properties": { "mwName": { "description": "Name for the new watchlist. Maximum 15 characters; reserved names not allowed.", "maxLength": 15, "not": { "enum": [ "NIFTY 50", "RECENTLYVIEWED", "MYSTOCKS", "POSITIONS", "HOLDINGS" ] }, "type": "string", "x-data-type": "string" } }, "required": [ "mwName" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW102", "message": "MarketWatch Name Should Not Exceed 15 Characters", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": { "mwId": 2 }, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "mwId": { "type": "integer" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Create MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-marketwatch-createmw.json" } }, "/api/v1/marketWatch/deleteMW": { "post": { "description": "Deletes a target user watchlist and purges all scrip mappings contained inside it. This action is irreversible.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-marketwatch-deletemw", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 2 }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to delete permanently.", "type": "integer", "x-data-type": "integer" } }, "required": [ "mwId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW101", "message": "Invalid market watch id", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Tech Stocks Deleted Successfully", "status": "Ok" } } }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Delete Entire MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-marketwatch-deletemw.json" } }, "/api/v1/marketWatch/deletescrip": { "post": { "description": "Removes one or more scrips from a watchlist by their exchange and token identifiers.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-marketwatch-deletescrip", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 1, "scripData": [ { "exchange": "NSE", "token": "2885" } ] }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to remove scrips from.", "type": "integer", "x-data-type": "integer" }, "scripData": { "description": "Array of scrip identifiers to remove.", "items": { "properties": { "exchange": { "description": "Exchange of the scrip.", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange token of the scrip.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } }, "required": [ "mwId", "scripData" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW110", "message": "Scrip not available in market watch", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "RELIANCE-EQ Deleted Successfully", "status": "Ok" } } }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Delete Scrip from MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-marketwatch-deletescrip.json" } }, "/api/v1/marketWatch/getAllMwScrips": { "get": { "description": "Retrieves all configured watchlists and all enriched scrip contracts for the authenticated user. \n\n\n\nEndpoint Details", "operationId": "get-api-v1-marketwatch-getallmwscrips", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "code": "0", "message": "Success", "result": [ { "isDefault": false, "isEdit": true, "isRename": true, "mwId": "1", "mwName": "Watchlist 1", "scrips": [ { "companyName": "RELIANCE INDUSTRIES LTD", "exchange": "NSE", "formattedInsName": "RELIANCE EQ", "instrumentType": "EQ", "isin": "INE002A01018", "lotSize": "1", "pdc": "2980.50", "sortOrder": 1, "symbol": "RELIANCE", "tickSize": "0.05", "token": "2885", "tradingSymbol": "RELIANCE-EQ" } ] } ], "status": "Ok" }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "items": { "properties": { "isDefault": { "type": "boolean" }, "isEdit": { "type": "boolean" }, "isRename": { "type": "boolean" }, "mwId": { "type": "string" }, "mwName": { "type": "string" }, "scrips": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "formattedInsName": { "type": "string" }, "instrumentType": { "type": "string" }, "isin": { "type": "string" }, "lotSize": { "type": "string" }, "pdc": { "type": "string" }, "sortOrder": { "type": "integer" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get All MarketWatch Scrips", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/get-api-v1-marketwatch-getallmwscrips.json" } }, "/api/v1/marketWatch/getSingleMwScripsDetails": { "post": { "description": "Retrieves comprehensive contract details, corporate action badges, and live parameters for all scrips within one specified watchlist tab.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-marketwatch-getsinglemwscripsdetails", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 1 }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to retrieve full scrip details for.", "type": "integer", "x-data-type": "integer" } }, "required": [ "mwId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW101", "message": "Invalid market watch id", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": { "isDefault": false, "isEdit": true, "isRename": true, "mwId": "1", "mwName": "Watchlist 1", "scrips": [ { "exchange": "NSE", "instrumentType": "EQ", "isin": "INE002A01018", "lotSize": "1", "pdc": "2980.50", "symbol": "RELIANCE", "tickSize": "0.05", "token": "2885", "tradingSymbol": "RELIANCE-EQ" } ] }, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "isDefault": { "type": "boolean" }, "isEdit": { "type": "boolean" }, "isRename": { "type": "boolean" }, "mwId": { "type": "string" }, "mwName": { "type": "string" }, "scrips": { "items": { "properties": { "exchange": { "type": "string" }, "instrumentType": { "type": "string" }, "isin": { "type": "string" }, "lotSize": { "type": "string" }, "pdc": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Single MarketWatch Scrip Details", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-marketwatch-getsinglemwscripsdetails.json" } }, "/api/v1/marketWatch/renameMW": { "post": { "description": "Renames an existing user watchlist tab. Both the watchlist ID and new name are validated against character and uniqueness constraints.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-marketwatch-renamemw", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 2, "mwName": "Bluechips" }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to rename.", "type": "integer", "x-data-type": "integer" }, "mwName": { "description": "New name for the watchlist. Maximum 15 characters.", "maxLength": 15, "type": "string", "x-data-type": "string" } }, "required": [ "mwId", "mwName" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW111", "message": "Market watch id doesn't exists", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Tech Stocks Renamed to Bluechips Successfully.", "status": "Ok" } } }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Rename MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-marketwatch-renamemw.json" } }, "/api/v1/marketWatch/sortMwScrips": { "post": { "description": "Updates the positional display ordering of scrips inside a specific watchlist. All scrips in the watchlist must be provided with sequential sort orders in a single call.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-marketwatch-sortmwscrips", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 1, "scripData": [ { "exchange": "NSE", "sortingOrder": 1, "token": "11536" }, { "exchange": "NSE", "sortingOrder": 2, "token": "2885" } ] }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist whose scrip order is being updated.", "type": "integer", "x-data-type": "integer" }, "scripData": { "description": "Array of all scrips with their new sort positions.", "items": { "properties": { "exchange": { "description": "Exchange of the scrip (e.g., \"NSE\", \"BSE\").", "type": "string", "x-data-type": "string" }, "sortingOrder": { "description": "New 1-based sort position for the scrip.", "minimum": 1, "type": "integer", "x-data-type": "integer" }, "token": { "description": "Exchange token of the scrip.", "type": "string", "x-data-type": "string" } }, "required": [ "token", "exchange", "sortingOrder" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } }, "required": [ "mwId", "scripData" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW113", "message": "Sorting scrip count does not match watchlist scrip count", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Sorting order saved successfully", "status": "Ok" } } }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Sort MarketWatch Scrips", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-marketwatch-sortmwscrips.json" } }, "/api/v1/marketWatch/trending/recent/search": { "get": { "description": "Retrieves the top trending traded instruments and recently searched scrips across the application platform. \n\n\n\nEndpoint Details", "operationId": "get-api-v1-marketwatch-trending-recent-search", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "code": "0", "message": "Success", "result": [ { "companyName": "RELIANCE INDUSTRIES LTD", "exchange": "NSE", "pdc": "2980.50", "symbol": "RELIANCE", "token": "2885", "tradingSymbol": "RELIANCE-EQ" }, { "companyName": "TATA CONSULTANCY SERV LT", "exchange": "NSE", "pdc": "4250.00", "symbol": "TCS", "token": "11536", "tradingSymbol": "TCS-EQ" } ], "status": "Ok" }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "pdc": { "type": "string" }, "symbol": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Trending \u0026 Recent Search", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/get-api-v1-marketwatch-trending-recent-search.json" } }, "/api/v1/predefined/getMW": { "get": { "description": "Retrieves a paginated list of all system and research-curated predefined watchlists. Supports keyword search and pagination via query parameters. \n\n\n\nEndpoint Details", "operationId": "get-api-v1-predefined-getmw", "parameters": [ { "allowEmptyValue": false, "example": 1, "in": "query", "name": "page", "required": false, "schema": { "description": "Page number (1-based, default: 1).", "minimum": 1, "type": "integer", "x-data-type": "integer" } }, { "allowEmptyValue": false, "example": 10, "in": "query", "name": "pageSize", "required": false, "schema": { "description": "Records per page (default: 10).", "type": "integer", "x-data-type": "integer" } }, { "allowEmptyValue": true, "example": "Energy", "in": "query", "name": "q", "required": false, "schema": { "description": "Keyword to filter watchlists by name or tag (e.g., \"Energy\").", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "activeStatus": 1, "description": "Renewable energy leaders in India", "flag": "NEW", "isEditable": 0, "isEnabled": 1, "logo": "/assets/logos/green_energy.png", "mwId": 1, "mwName": "Green Energy Basket", "scripCount": 8, "status": "LIVE", "subscriberCount": 1420, "tag": "THEMATIC", "topSymbols": [ "ADANIGREEN", "TATAPOWER", "SUZLON" ], "updatedAt": "2026-09-08T10:15:00Z" } ], "pagination": { "page": 1, "pageSize": 10, "totalPages": 1, "totalRecords": 1 } }, "schema": { "properties": { "data": { "items": { "properties": { "activeStatus": { "type": "integer" }, "description": { "type": "string" }, "flag": { "type": "string" }, "isEditable": { "type": "integer" }, "isEnabled": { "type": "integer" }, "logo": { "type": "string" }, "mwId": { "type": "integer" }, "mwName": { "type": "string" }, "scripCount": { "type": "integer" }, "status": { "type": "string" }, "subscriberCount": { "type": "integer" }, "tag": { "type": "string" }, "topSymbols": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalPages": { "type": "integer" }, "totalRecords": { "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Predefined Watchlists", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/get-api-v1-predefined-getmw.json" } }, "/api/v1/predefined/getMW/{mwId}": { "get": { "description": "Retrieves complete configuration, metadata, and all member scrips for a specific predefined watchlist identified by its mwId path parameter.\n\n\n\nEndpoint Details", "operationId": "get-api-v1-predefined-getmw-mwid", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } }, { "in": "path", "name": "mwId", "required": true, "schema": { "type": "integer", "x-data-type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "error": "WATCHLIST_NOT_FOUND", "message": "No watchlist found with ID 1" } }, "success": { "description": "documented", "summary": "Success", "value": { "activeStatus": 1, "description": "Renewable energy leaders in India", "flag": "NEW", "isEditable": 0, "isEnabled": 1, "logo": "/assets/logos/green_energy.png", "mwId": 1, "mwName": "Green Energy Basket", "scrips": [ { "exchange": "NSE", "pdc": "420.50", "symbol": "TATAPOWER", "token": "3456" } ], "status": "LIVE", "subscriberCount": 1420, "tag": "THEMATIC", "updatedAt": "2026-09-08T10:15:00Z" } } }, "schema": { "anyOf": [ { "properties": { "activeStatus": { "type": "integer" }, "description": { "type": "string" }, "flag": { "type": "string" }, "isEditable": { "type": "integer" }, "isEnabled": { "type": "integer" }, "logo": { "type": "string" }, "mwId": { "type": "integer" }, "mwName": { "type": "string" }, "scrips": { "items": { "properties": { "exchange": { "type": "string" }, "pdc": { "type": "string" }, "symbol": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" }, "subscriberCount": { "type": "integer" }, "tag": { "type": "string" }, "updatedAt": { "type": "string" } }, "type": "object" }, { "properties": { "error": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Predefined Watchlist Details", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/get-api-v1-predefined-getmw-mwid.json" } }, "/api/v1/scrip/search": { "post": { "description": "Searches tradeable contracts across segments with text-based search, exchange filtering, category filtering (EQ, FUT, OPT), and pagination. Returns matching instruments sorted by relevance.\n\n\n\nEndpoint Details", "operationId": "post-api-v1-scrip-search", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "category": [ "EQ" ], "currentPage": "1", "exchange": [ "NSE", "BSE" ], "pageSize": "10", "searchText": "TATA" }, "schema": { "properties": { "category": { "description": "Instrument categories to filter (e.g., [\"EQ\"], [\"FUT\"], [\"OPT\"]).", "items": { "type": "string", "x-data-type": "string" }, "type": "array", "x-data-type": "array" }, "currentPage": { "description": "1-based page number for pagination. Defaults to \"1\".", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Filter by exchange(s) (e.g., [\"NSE\", \"BSE\"]). Omit for all exchanges.", "items": { "type": "string", "x-data-type": "string" }, "type": "array", "x-data-type": "array" }, "pageSize": { "description": "Number of results per page. Defaults to \"10\".", "type": "string", "x-data-type": "string" }, "searchText": { "description": "Keyword or symbol prefix to search for (e.g., \"TATA\").", "type": "string", "x-data-type": "string" } }, "required": [ "searchText" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW111", "message": "No record found", "result": { "currentPage": 0, "pageCount": 0, "searchResult": [] }, "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": { "currentPage": 1, "pageCount": 5, "searchResult": [ { "companyName": "TATA MOTORS LIMITED", "exchange": "NSE", "formattedInsName": "TATAMOTORS EQ", "instrumentType": "EQ", "isin": "INE155A01022", "lotSize": "1", "symbol": "TATAMOTORS", "tickSize": "0.05", "token": "3456", "tradingSymbol": "TATAMOTORS-EQ" } ] }, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "currentPage": { "type": "integer" }, "pageCount": { "type": "integer" }, "searchResult": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "formattedInsName": { "type": "string" }, "instrumentType": { "type": "string" }, "isin": { "type": "string" }, "lotSize": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "currentPage": { "type": "integer" }, "pageCount": { "type": "integer" }, "searchResult": { "items": {}, "type": "array" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Scrip Search", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-api-v1-scrip-search.json" } }, "/auth/v2/access/bio/enable": { "post": { "description": "Enables or disables biometric authentication (fingerprint/face ID) for the user on a specific device. Once enabled, the user can authenticate via the Validate Biometric endpoint instead of entering a password or OTP on subsequent logins from the same device.", "operationId": "post-auth-v2-access-bio-enable", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "2e701e2ef84a0867", "deviceType": "ANDROID", "enable": "true", "userId": "DVJ6912" }, "schema": { "properties": { "appName": { "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Device ID for which biometrics is being enabled", "type": "string", "x-data-type": "string" }, "deviceType": { "description": "Device type — ANDROID or IOS", "type": "string", "x-data-type": "string" }, "enable": { "description": "\"true\" to enable biometric, \"false\" to disable", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "deviceId", "deviceType", "enable" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "message": "Bio-metric Enabled successfully", "status": "Success" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Enable Biometric", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-bio-enable.json" } }, "/auth/v2/access/bio/validate": { "post": { "description": "Authenticates a user using a biometric token previously issued by the device. On success, returns a full session object containing an access token and trading permissions — equivalent to the response from a successful OTP or TOTP login.", "operationId": "post-auth-v2-access-bio-validate", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "07fa22e186a401b8", "os": "android", "token": "eyJhbGci...", "userId": "I13796" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "os": { "description": "Device OS (redundant with osName; kept for compatibility)", "type": "string", "x-data-type": "string" }, "token": { "description": "Biometric token issued to the device on previous login", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "token", "deviceId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "accessToken": "mock-access-token", "allowBseCash": "Y", "allowNseCash": "Y", "allowNseFo": "Y", "clientName": "NAVNEET KUMAR", "clientType": "Active", "isAuthorized": false, "success": "Success", "userId": "I13796", "userRole": "Active" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "accessToken": { "type": "string" }, "allowBseCash": { "type": "string" }, "allowNseCash": { "type": "string" }, "allowNseFo": { "type": "string" }, "clientName": { "type": "string" }, "clientType": { "type": "string" }, "isAuthorized": { "type": "boolean" }, "success": { "type": "string" }, "userId": { "type": "string" }, "userRole": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Validate Biometric", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-bio-validate.json" } }, "/auth/v2/access/client/enckey": { "post": { "description": "Returns an RSA/AES encryption key for the given user. The client must use this key to encrypt sensitive fields (such as the password) before transmitting them to the server. This ensures credentials are never sent in plain text over the network.", "operationId": "post-auth-v2-access-client-enckey", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "userId": "MOCK-CLIENT-001" }, "schema": { "properties": { "userId": { "description": "Unique client identifier used to fetch the corresponding encryption key", "type": "string", "x-data-type": "string" } }, "required": [ "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Mock request processed successfully", "result": [ { "encKey": "MDEyMzQ1Njc4OWFiY2RlZjAxMjM0NTY3ODlhYmNkZWY=" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "encKey": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Get Encryption Key", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-client-enckey.json" } }, "/auth/v2/access/client/logout": { "post": { "description": "Terminates the user's active session by invalidating the current access token. This endpoint should be called whenever the user explicitly signs out. On success, the access token is revoked and the user must authenticate again to obtain a new session.", "operationId": "post-auth-v2-access-client-logout", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "616968f42c515790", "osName": "WEBEXTERNAL", "userId": "DVJ8299", "versionNo": "1.0.0.1.4" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Device identifier from which the logout is initiated", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" }, "versionNo": { "description": "Application version number", "type": "string", "x-data-type": "string" } }, "required": [ "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "message": "Success", "status": "Success" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Logout", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-client-logout.json" } }, "/auth/v2/access/client/unblock": { "post": { "description": "Initiates the account unblocking flow for a blocked user by sending an OTP to their registered contact details. The user must supply their PAN for identity verification. Returns a temporary session token used in the subsequent Verify Unblock OTP call.", "operationId": "post-auth-v2-access-client-unblock", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "f832498e764fa20a", "osName": "MOBANDROID", "pan": "JDPTM3694M", "source": "MOB", "userId": "SAL194" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "pan": { "description": "PAN card number for identity verification", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel — WEB, MOB, or APP", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "pan", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "emailId": "as***@***.com", "isTOtpAvailable": false, "message": "An OTP has been sent to your registered Mobile Number and email.", "mobileNumber": "98****38", "resendOtpAfter": "60", "resendOtpCountsLeft": "4", "token": "mock-access-token", "userId": "SAL194" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "emailId": { "type": "string" }, "isTOtpAvailable": { "type": "boolean" }, "message": { "type": "string" }, "mobileNumber": { "type": "string" }, "resendOtpAfter": { "type": "string" }, "resendOtpCountsLeft": { "type": "string" }, "token": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Generate OTP — Unblock Account", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-client-unblock.json" } }, "/auth/v2/access/client/unblock/verify": { "post": { "description": "Verifies the OTP submitted during the account unblock flow. On successful verification, the user's account is unblocked and they can proceed with normal login.", "operationId": "post-auth-v2-access-client-unblock-verify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "f832498e764fa20a", "osName": "MOBANDROID", "otp": "322481", "source": "MOB", "userId": "SAL194" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "otp": { "description": "OTP received during the unblock initiation step", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel — WEB, MOB, or APP", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "otp", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "message": "User unblocked successfully", "status": "Success" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Verify OTP — Unblock Account", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-client-unblock-verify.json" } }, "/auth/v2/access/client/verify": { "post": { "description": "Verifies whether a client (user) exists in the system. This is typically the first step in the authentication flow, used to check if a given user ID is registered before proceeding with password or OTP-based login.", "operationId": "post-auth-v2-access-client-verify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "userId": "MOCK-CLIENT-001" }, "schema": { "properties": { "userId": { "description": "Unique client identifier (e.g. trading account ID)", "type": "string", "x-data-type": "string" } }, "required": [ "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Mock request processed successfully", "result": [], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Verify Client", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-client-verify.json" } }, "/auth/v2/access/email/otp/send": { "post": { "description": "Sends an OTP to the specified email address for guest user verification. This typically follows mobile OTP verification as part of a multi-step identity validation process. The session ID from the previous step must be passed in the request.", "operationId": "post-auth-v2-access-email-otp-send", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "emailId": "deekshayadav7088@gmail.com", "id": "268", "osName": "MOBANDROID", "source": "MOB" }, "schema": { "properties": { "emailId": { "description": "Email address to send the OTP to", "format": "email", "type": "string", "x-data-type": "email" }, "id": { "description": "Session ID from the mobile OTP verification step", "type": "string", "x-data-type": "string" }, "osName": { "description": "Channel identifier — MOBANDROID, MOBIOS, WEB, etc.", "type": "string", "x-data-type": "string" }, "source": { "description": "Device Source MOB, WEB, API", "type": "string", "x-data-type": "string" } }, "required": [ "id", "emailId", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "An OTP has been sent to your registered Email", "result": [ { "id": 268 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Generate Email OTP — Guest User", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-email-otp-send.json" } }, "/auth/v2/access/email/otp/verify": { "post": { "description": "Verifies the OTP delivered to the guest user's email address. This completes the two-channel (mobile + email) identity verification flow for guest users. On success, the session is marked as verified and the user can proceed to the next registration or login step.", "operationId": "post-auth-v2-access-email-otp-verify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "emailId": "deekshayadav7088@gmail.com", "id": "268", "osName": "MOBANDROID", "otp": "728713", "source": "MOB" }, "schema": { "properties": { "emailId": { "description": "Email address that received the OTP", "format": "email", "type": "string", "x-data-type": "email" }, "id": { "description": "Session ID from the email OTP generation step", "type": "string", "x-data-type": "string" }, "osName": { "description": "Channel identifier — MOBANDROID, MOBIOS, WEB, etc.", "type": "string", "x-data-type": "string" }, "otp": { "description": "OTP received on the email address", "type": "string", "x-data-type": "string" }, "source": { "description": "Device Source MOB, WEB, API", "type": "string", "x-data-type": "string" } }, "required": [ "emailId", "otp", "id", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "id": 268 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Verify Email OTP — Guest User", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-email-otp-verify.json" } }, "/auth/v2/access/mobile/otp/send": { "post": { "description": "Sends an OTP to the specified mobile number for guest (unauthenticated) users. This is used during new user registration or pre-login identity verification flows where no existing session exists. Returns a session ID used in the subsequent verification call.", "operationId": "post-auth-v2-access-mobile-otp-send", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "mobile": "7617703518", "osName": "MOBANDROID", "source": "MOB" }, "schema": { "properties": { "mobile": { "description": "Mobile number to which the OTP will be sent", "type": "string", "x-data-type": "string" }, "osName": { "description": "Channel identifier — MOBANDROID, MOBIOS, WEB, etc.", "type": "string", "x-data-type": "string" }, "source": { "description": "Device source MOB, WEB, API", "type": "string", "x-data-type": "string" } }, "required": [ "mobile", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "An OTP has been sent to your registered Mobile Number and email.", "result": [ { "id": 268 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Generate Mobile OTP — Guest User", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-mobile-otp-send.json" } }, "/auth/v2/access/mobile/otp/verify": { "post": { "description": "Verifies the OTP received on the guest user's mobile number. The session ID returned by the Generate Mobile OTP call must be included. On success, the session progresses to the next step in the registration or guest login flow.", "operationId": "post-auth-v2-access-mobile-otp-verify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "id": "268", "mobile": "7617703518", "osName": "MOBANDROID", "otp": "475558", "source": "MOB" }, "schema": { "properties": { "id": { "description": "Session ID returned by the Generate Mobile OTP call", "type": "string", "x-data-type": "string" }, "mobile": { "description": "Mobile number that received the OTP", "type": "string", "x-data-type": "string" }, "osName": { "description": "Channel identifier — MOBANDROID, MOBIOS, WEB, etc.", "type": "string", "x-data-type": "string" }, "otp": { "description": "The OTP received on the mobile number", "type": "string", "x-data-type": "string" }, "source": { "description": "Device Source MOB, WEB, API", "type": "string", "x-data-type": "string" } }, "required": [ "mobile", "source", "otp", "id" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "id": 268 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Verify Mobile OTP — Guest User", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-mobile-otp-verify.json" } }, "/auth/v2/access/otp/send": { "post": { "description": "Triggers dispatch of a One-Time Password (OTP) to the user's registered mobile number and/or email address for login verification. Used as a second factor after password validation or as a standalone login method depending on broker configuration.", "operationId": "post-auth-v2-access-otp-send", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "MOCK-DEVICE-001", "osName": "MOBANDROID", "password": "MockPass123!", "source": "MOB", "userId": "MOCK-CLIENT-001", "versionNo": "1.0.0" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS — MOBANDROID, MOBIOS, WEBEXTERNAL, etc.", "type": "string", "x-data-type": "string" }, "password": { "description": "Encrypted password; required only for brokers that combine password + OTP in a single call", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel — WEB, MOB, or APP", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" }, "versionNo": { "description": "Application version number", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Mock request processed successfully", "result": [ { "emailId": "client@example.com", "mobileNumber": "9990000001", "resendOtpAfter": 30, "resendOtpCountsLeft": 3, "totpAvailable": true, "userId": "MOCK-CLIENT-001" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "emailId": { "type": "string" }, "mobileNumber": { "type": "string" }, "resendOtpAfter": { "type": "integer" }, "resendOtpCountsLeft": { "type": "integer" }, "totpAvailable": { "type": "boolean" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Generate OTP (Login)", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-otp-send.json" } }, "/auth/v2/access/otp/validate": { "post": { "description": "Validates the OTP entered by the user during login. On successful verification, the server returns a JWT access token (accessToken) and a WebSocket token (wsToken), which are used to authenticate subsequent API calls and establish real-time connections respectively.", "operationId": "post-auth-v2-access-otp-validate", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "f832498e764fa20a", "fcmToken": "cvJ-7f83R-...", "imei": "13aa6d34011e0ebb", "osName": "MOBANDROID", "otp": "448010", "source": "MOB", "userId": "SAL194", "vendor": "IBuYnG7eJMB3t61", "version": "1.0.07" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "fcmToken": { "description": "Firebase Cloud Messaging token for push notifications", "type": "string", "x-data-type": "string" }, "imei": { "description": "Device IMEI identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "otp": { "description": "The OTP received on mobile/email", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel — WEB, MOB, or APP", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" }, "vendor": { "description": "Vendor key for SSO integrations", "type": "string", "x-data-type": "string" }, "version": { "description": "Application version number", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "otp", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Mock request processed successfully", "result": [ { "accessToken": "mock-access-token", "email": "ashokkumar211@yahoo.com", "exchanges": [ "NSE_CASH", "NSE_FO", "BSE_CASH", "MCX" ], "isAuthorized": false, "isDormant": false, "mobile": "9837001038", "name": "ASHOK KUMAR AGARWAL", "pan": "AFKPA8315H", "role": "[ACTIVE_USER]", "ucc": "SAL194", "wsToken": "mock-access-token" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "accessToken": { "type": "string" }, "email": { "type": "string" }, "exchanges": { "items": { "type": "string" }, "type": "array" }, "isAuthorized": { "type": "boolean" }, "isDormant": { "type": "boolean" }, "mobile": { "type": "string" }, "name": { "type": "string" }, "pan": { "type": "string" }, "role": { "type": "string" }, "ucc": { "type": "string" }, "wsToken": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Verify OTP", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-otp-validate.json" } }, "/auth/v2/access/pwd/change": { "post": { "description": "Allows an authenticated user to change their login password. Both the old and new passwords must be encrypted using the key obtained from the Get Encryption Key endpoint before submission. This endpoint requires a valid session.", "operationId": "post-auth-v2-access-pwd-change", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "newPassword": "U2FsdGVkX19...", "oldPassword": "U2FsdGVkX1+...", "osName": " MOBANDROID ", "source": "WEB", "userId": "VIJ460" }, "schema": { "properties": { "newPassword": { "description": "New password to set, encrypted with the client encryption key", "type": "string", "x-data-type": "string" }, "oldPassword": { "description": "Current password, encrypted with the client encryption key", "type": "string", "x-data-type": "string" }, "osName": { "description": "Channel identifier — MOBANDROID, MOBIOS, WEB, etc.", "type": "string", "x-data-type": "string" }, "source": { "description": "Device Source MOB, WEB, API", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "oldPassword", "newPassword", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Password changed successfully", "result": [], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Change Password", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-pwd-change.json" } }, "/auth/v2/access/pwd/forgot": { "post": { "description": "Initiates the forgot-password flow by dispatching an OTP to the user's registered mobile number and email. The user must provide their PAN in addition to their user ID for identity verification. Returns a temporary token required for subsequent steps.", "operationId": "post-auth-v2-access-pwd-forgot", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "f832498e764fa20a", "osName": "MOBANDROID", "pan": "DDJHV2931K", "source": "MOB", "userId": "SAL194" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "pan": { "description": "PAN card number for identity verification", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel — WEB, MOB, or APP", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "pan", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "emailId": "as***@***.com", "isTOtpAvailable": false, "message": "An OTP has been sent to your registered Mobile Number and email.", "mobileNumber": "98****38", "resendOtpAfter": "60", "resendOtpCountsLeft": "4", "status": "Success", "token": "mock-access-token", "userId": "SAL194" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "emailId": { "type": "string" }, "isTOtpAvailable": { "type": "boolean" }, "message": { "type": "string" }, "mobileNumber": { "type": "string" }, "resendOtpAfter": { "type": "string" }, "resendOtpCountsLeft": { "type": "string" }, "status": { "type": "string" }, "token": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Generate OTP — Forgot Password", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-pwd-forgot.json" } }, "/auth/v2/access/pwd/forgot/verify": { "post": { "description": "Validates the OTP sent during the Forgot Password flow. On successful OTP verification, a reset token is returned. This token must be passed to the Reset Password endpoint to complete the password reset.", "operationId": "post-auth-v2-access-pwd-forgot-verify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "f832498e764fa20a", "osName": "MOBANDROID", "otp": "057476", "source": "MOB", "userId": "SAL194" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "otp": { "description": "OTP received on mobile/email", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "otp", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "message": "Success", "status": "Success", "token": "mock-access-token" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "message": { "type": "string" }, "status": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Verify OTP — Forgot Password", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-pwd-forgot-verify.json" } }, "/auth/v2/access/pwd/reset": { "post": { "description": "Resets the user's password after successful OTP verification in the Forgot Password flow. The new password must be encrypted before submission. This endpoint completes the password recovery sequence.", "operationId": "post-auth-v2-access-pwd-reset", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "f832498e764fa20a", "osName": "MOBANDROID", "password": "encrypted_password_string", "userId": "SAL194" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "password": { "description": "New password, encrypted with the client encryption key", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "password" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Password reset successfully", "result": [], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Reset Password", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-pwd-reset.json" } }, "/auth/v2/access/pwd/validate": { "post": { "description": "Validates the encrypted password for a given user. On success, this endpoint returns a session token and details about the next authentication step (e.g., OTP delivery). The password field must be encrypted using the key returned by the Get Encryption Key endpoint.", "operationId": "post-auth-v2-access-pwd-validate", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "MOCK-DEVICE-001", "osName": "Android", "password": "MockPass123!", "source": "WEB", "userId": "MOCK-CLIENT-001", "versionNo": "1.0.0" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier (e.g. Mock Provider)", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS — MOBANDROID, MOBIOS, WEB, WEBEXTERNAL, etc.", "type": "string", "x-data-type": "string" }, "password": { "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel — WEB, MOB, or APP", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" }, "versionNo": { "description": "Application version number", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Mock request processed successfully", "result": [ { "emailId": "client@example.com", "kcRole": "string|array", "mobileNumber": "9990000001", "resendOtpAfter": 30, "resendOtpCountsLeft": 3, "token": "mock-access-token", "totpAvailable": true, "userId": "MOCK-CLIENT-001" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "emailId": { "type": "string" }, "kcRole": { "type": "string" }, "mobileNumber": { "type": "string" }, "resendOtpAfter": { "type": "integer" }, "resendOtpCountsLeft": { "type": "integer" }, "token": { "type": "string" }, "totpAvailable": { "type": "boolean" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Validate Password", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-pwd-validate.json" } }, "/auth/v2/access/qr/generate": { "get": { "description": "Generates a QR code image for QR-based login. The returned QR name acts as a session identifier. The web client displays this QR code, and the mobile app scans it to authenticate the session.", "operationId": "get-auth-v2-access-qr-generate", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "byteCode": "data:image/png;base64,iVBORw0KGgo...", "qrName": "bce986dc-5c84-48dd-8af9-b31ade" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "byteCode": { "type": "string" }, "qrName": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Generate QR Code", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/get-auth-v2-access-qr-generate.json" } }, "/auth/v2/access/qr/login": { "post": { "description": "Polls the server to check whether a QR code has been scanned and the mobile user authenticated. On successful scan, returns the access token and user details for the web session. This endpoint should be called repeatedly at short intervals until authorization is confirmed.", "operationId": "post-auth-v2-access-qr-login", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "qrName": "903700e2-bf1d-4884-a129-578917" }, "schema": { "properties": { "qrName": { "description": "QR session identifier from the Generate QR Code response", "type": "string", "x-data-type": "string" } }, "required": [ "qrName" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "accessToken": "mock-access-token", "authorized": false, "clientId": "DVJ6550", "rmsOms": "OMT" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "accessToken": { "type": "string" }, "authorized": { "type": "boolean" }, "clientId": { "type": "string" }, "rmsOms": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "]Get QR Login Details", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-qr-login.json" } }, "/auth/v2/access/qr/validate": { "post": { "description": "Called by the mobile app after scanning the QR code displayed on the web client. Registers the authenticated mobile user's approval of the QR session, enabling the web client to retrieve a session token via the Get QR Login Details endpoint.", "operationId": "post-auth-v2-access-qr-validate", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "deviceIp": "d92944fdcb2ae3a5", "keyValue": "08249902-73f2-4fb9-8ede-e67dc4", "osName": "MOBANDROID", "userId": "VIJ91" }, "schema": { "properties": { "deviceIp": { "description": "IP or device identifier of the mobile device", "type": "string", "x-data-type": "string" }, "keyValue": { "description": "QR key value extracted from the scanned QR code", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS — MOBANDROID, MOBIOS", "type": "string", "x-data-type": "string" }, "userId": { "description": "Authenticated mobile user's unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "keyValue", "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Ok", "result": [], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Scan QR Code", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-qr-validate.json" } }, "/auth/v2/access/totp/enable": { "post": { "description": "Completes TOTP registration by validating the first TOTP code generated by the authenticator app after scanning the QR code. This confirms that the authenticator is correctly configured and enables TOTP as a login factor for the account.", "operationId": "post-auth-v2-access-totp-enable", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "7d0ec6fb5263a361", "osName": "MOBANDROID", "source": "MOB", "totp": "725047", "userId": "VIJ91" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel", "type": "string", "x-data-type": "string" }, "totp": { "description": "First TOTP code generated by the authenticator app", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "totp", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "message": "TOTP Enabled successfully", "status": "Success" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Enable TOTP", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-totp-enable.json" } }, "/auth/v2/access/totp/generate": { "post": { "description": "Initiates TOTP (Time-based One-Time Password) registration by sending an OTP to the user's registered mobile and email. This is the first step in enabling TOTP for an account. The user must verify this OTP before receiving the TOTP QR code.", "operationId": "post-auth-v2-access-totp-generate", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "7d0ec6fb5263a361", "osName": "MOBANDROID", "source": "MOB", "userId": "VIJ91" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel — MOB, WEB, etc.", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "emailId": "ra***@***.com", "isTOtpAvailable": false, "mobileNumber": "70****85", "resendOtpAfter": "60", "resendOtpCountsLeft": "4", "userId": "VIJ91" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "emailId": { "type": "string" }, "isTOtpAvailable": { "type": "boolean" }, "mobileNumber": { "type": "string" }, "resendOtpAfter": { "type": "string" }, "resendOtpCountsLeft": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Generate OTP — Register TOTP", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-totp-generate.json" } }, "/auth/v2/access/totp/get": { "post": { "description": "Returns a QR code image (base64) and a secret key to be scanned/entered into a TOTP authenticator app such as Google Authenticator or Authy. The OTP received in the previous step (Generate OTP for TOTP) must be provided to authorize this request.", "operationId": "post-auth-v2-access-totp-get", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "7d0ec6fb5263a361", "osName": "MOBANDROID", "receivedOtp": "506676", "source": "MOB", "userId": "VIJ91" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "receivedOtp": { "description": "OTP received in the Generate OTP (Register TOTP) step", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "receivedOtp", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "scanImage": "data:image/png;base64,iVBOR...", "secKey": "ILJXOIYVKOZEVVSSXGMLBEDOBTGXANUD", "status": "Success", "tOtpEnabled": false }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "scanImage": { "type": "string" }, "secKey": { "type": "string" }, "status": { "type": "string" }, "tOtpEnabled": { "type": "boolean" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get TOTP Registration QR Code", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-totp-get.json" } }, "/auth/v2/access/totp/verify": { "post": { "description": "Validates a Time-based One-Time Password (TOTP) generated by an authenticator app (e.g. Google Authenticator). This is used as a 2FA step for users who have enabled TOTP. On success, returns the same session tokens as OTP verification.", "operationId": "post-auth-v2-access-totp-verify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "appName": "Mock App", "deviceId": "f832498e764fa20a", "fcmToken": "cvJ-7f83R-...", "imei": "13aa6d34011e0ebb", "osName": "MOBANDROID", "source": "MOB", "totp": "448010", "userId": "SAL194", "vendor": "IBuYnG7eJMB3t61", "version": "1.0.07" }, "schema": { "properties": { "appName": { "description": "Vendor or application identifier", "type": "string", "x-data-type": "string" }, "deviceId": { "description": "Unique device identifier", "type": "string", "x-data-type": "string" }, "fcmToken": { "description": "Firebase Cloud Messaging token", "type": "string", "x-data-type": "string" }, "imei": { "description": "Device IMEI identifier", "type": "string", "x-data-type": "string" }, "osName": { "description": "Device OS", "type": "string", "x-data-type": "string" }, "source": { "description": "Login channel — WEB, MOB, or APP", "type": "string", "x-data-type": "string" }, "totp": { "description": "6-digit TOTP code from the authenticator app", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" }, "vendor": { "description": "Vendor key for SSO integrations", "type": "string", "x-data-type": "string" }, "version": { "description": "Application version number", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "totp", "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Mock request processed successfully", "result": [ { "accessToken": "mock-access-token", "email": "...", "exchanges": [ "NSE_CASH", "NSE_FO", "BSE_CASH", "MCX" ], "isAuthorized": false, "isDormant": false, "mobile": "...", "name": "ASHOK KUMAR AGARWAL", "pan": "AFKPA8315H", "role": "[ACTIVE_USER]", "ucc": "SAL194", "wsToken": "mock-access-token" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "accessToken": { "type": "string" }, "email": { "type": "string" }, "exchanges": { "items": { "type": "string" }, "type": "array" }, "isAuthorized": { "type": "boolean" }, "isDormant": { "type": "boolean" }, "mobile": { "type": "string" }, "name": { "type": "string" }, "pan": { "type": "string" }, "role": { "type": "string" }, "ucc": { "type": "string" }, "wsToken": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Verify TOTP", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-totp-verify.json" } }, "/auth/v2/access/verify/token": { "post": { "description": "Validates an existing JWT access token to check whether it is still active and not expired. Used by services and middleware to confirm session validity without requiring a full re-authentication.", "operationId": "post-auth-v2-access-verify-token", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "token": "eyJhbGci...", "userId": "VIJ91" }, "schema": { "properties": { "token": { "description": "JWT access token to be verified", "type": "string", "x-data-type": "string" }, "userId": { "description": "Unique client identifier associated with the token", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "token" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": { "message": "Token is valid.", "status": "Success" }, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "properties": { "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "Verify Token", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-access-verify-token.json" } }, "/auth/v2/sso/vendor/authorize": { "post": { "description": "Checks and authorizes a vendor integration for an authenticated user within the SSO (Single Sign-On) framework. Returns a redirect URL that the client should navigate to in order to complete the SSO handshake with the third-party vendor.", "operationId": "post-auth-v2-sso-vendor-authorize", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "userId": "DVJ6912", "vendor": "YlpPdhGJSbfsSOFb" }, "schema": { "properties": { "userId": { "description": "Unique client identifier of the authenticated user", "type": "string", "x-data-type": "string" }, "vendor": { "description": "Vendor key identifying the third-party SSO integration", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "vendor" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "authorized": false, "redirectUrl": "https://mock.example/home" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "authorized": { "type": "boolean" }, "redirectUrl": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SSO — Authorize Vendor", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-sso-vendor-authorize.json" } }, "/auth/v2/sso/vendor/check": { "post": { "description": "Checks whether a user is authorized for a specific SSO vendor and generates a one-time auth code for the redirect. If the user is authorized, the response contains a vendor-specific redirect URL with an embedded authentication code that the vendor uses to establish a session.", "operationId": "post-auth-v2-sso-vendor-check", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "userId": "792922", "vendor": "rRQAJLBmqUCEvOU" }, "schema": { "properties": { "userId": { "description": "Unique client identifier", "type": "string", "x-data-type": "string" }, "vendor": { "description": "Vendor key identifying the SSO integration", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "vendor" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "authorized": true, "redirectUrl": "https://vendor.example.com/auth?authCode=6GT6Q9AD\u0026userId=792922" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "authorized": { "type": "boolean" }, "redirectUrl": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SSO — Check Vendor", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-sso-vendor-check.json" } }, "/auth/v2/sso/vendor/details": { "post": { "description": "Retrieves metadata about a registered SSO vendor using its vendor key. Primarily used to look up the application name associated with a vendor identifier for display or validation purposes.", "operationId": "post-auth-v2-sso-vendor-details", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "vendor": "iMxoMCfMUGrAuTL" }, "schema": { "properties": { "vendor": { "description": "Vendor key identifying the SSO integration", "type": "string", "x-data-type": "string" } }, "required": [ "vendor" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "appName": "Mock App" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "appName": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "SSO — Vendor Details", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-sso-vendor-details.json" } }, "/auth/v2/sso/vendor/getUserDetails": { "post": { "description": "Exchanges a one-time SSO auth code (issued by the Check Vendor endpoint) for the authenticated user's full session details, including a JWT token. This endpoint is called by the third-party vendor's backend to complete the SSO login and retrieve the user's session.", "operationId": "post-auth-v2-sso-vendor-getuserdetails", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "authCode": "5JJX5JCJSHG48UVOX1S4", "vendor": "onStMCcEGaLMgeR" }, "schema": { "properties": { "authCode": { "description": "One-time auth code from the Check Vendor redirect URL", "type": "string", "x-data-type": "string" }, "vendor": { "description": "Vendor key identifying the SSO integration", "type": "string", "x-data-type": "string" } }, "required": [ "vendor", "authCode" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "clientId": "DVJ6559", "stat": "Ok", "userSession": "eyJhbGci..." }, "schema": { "properties": { "clientId": { "type": "string" }, "stat": { "type": "string" }, "userSession": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "summary": "SSO — Get User Details", "tags": [ "auth" ], "x-request-schema-file": "schemas/requests/auth/post-auth-v2-sso-vendor-getuserdetails.json" } }, "/bo-rest/basketorder/addscrips": { "post": { "description": "Adds a single order leg (scrip) to an existing basket. The scrips object contains the full order specification. One scrip is added per request.", "operationId": "post-bo-rest-basketorder-addscrips", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "basketId": 44, "scrips": { "deviceNumber": "1fad105f580900ab839621c4ef0f9344", "disclosedQty": "0", "exchange": "NSE", "mktProtection": "1", "orderType": "AMO", "price": "8.76", "priceType": "L", "product": "CNC", "qty": 1, "ret": "DAY", "source": "IBT-EX", "stopLoss": "0", "target": "0", "token": "14366", "tradingSymbol": "IDEA-EQ", "trailingPrice": "0", "transType": "BUY", "triggerPrice": "0" } }, "schema": { "properties": { "basketId": { "description": "ID of the basket to which the scrip should be added.", "type": "integer", "x-data-type": "integer" }, "scrips": { "properties": { "deviceNumber": { "type": "string", "x-data-type": "string" }, "disclosedQty": { "type": "string", "x-data-type": "string" }, "exchange": { "type": "string", "x-data-type": "string" }, "mktProtection": { "type": "string", "x-data-type": "string" }, "orderType": { "type": "string", "x-data-type": "string" }, "price": { "type": "string", "x-data-type": "string" }, "priceType": { "type": "string", "x-data-type": "string" }, "product": { "type": "string", "x-data-type": "string" }, "qty": { "type": "integer", "x-data-type": "integer" }, "ret": { "type": "string", "x-data-type": "string" }, "source": { "type": "string", "x-data-type": "string" }, "stopLoss": { "type": "string", "x-data-type": "string" }, "target": { "type": "string", "x-data-type": "string" }, "token": { "type": "string", "x-data-type": "string" }, "tradingSymbol": { "type": "string", "x-data-type": "string" }, "trailingPrice": { "type": "string", "x-data-type": "string" }, "transType": { "type": "string", "x-data-type": "string" }, "triggerPrice": { "type": "string", "x-data-type": "string" } }, "type": "object", "x-data-type": "object" } }, "required": [ "basketId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "basketId": 44, "disClosedQty": null, "exchange": "NSE", "expiry": null, "expiryDate": null, "formattedInsName": "IDEA-EQ", "id": 89, "lotSize": null, "mktProtection": "1", "orderType": "AMO", "price": "8.76", "priceType": "L", "product": "CNC", "qty": "1", "ret": "DAY", "sortOrder": null, "stopLoss": "0", "target": "0", "token": "14366", "tradingSymbol": "IDEA-EQ", "trailingStopLoss": null, "transType": "BUY", "triggerPrice": "0", "validityDays": null, "weekTag": null } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "basketId": { "type": "integer" }, "disClosedQty": { "nullable": true }, "exchange": { "type": "string" }, "expiry": { "nullable": true }, "expiryDate": { "nullable": true }, "formattedInsName": { "type": "string" }, "id": { "type": "integer" }, "lotSize": { "nullable": true }, "mktProtection": { "type": "string" }, "orderType": { "type": "string" }, "price": { "type": "string" }, "priceType": { "type": "string" }, "product": { "type": "string" }, "qty": { "type": "string" }, "ret": { "type": "string" }, "sortOrder": { "nullable": true }, "stopLoss": { "type": "string" }, "target": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "trailingStopLoss": { "nullable": true }, "transType": { "type": "string" }, "triggerPrice": { "type": "string" }, "validityDays": { "nullable": true }, "weekTag": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Add Scrips to Basket", "tags": [ "basket-orders" ], "x-request-schema-file": "schemas/requests/basket-orders/post-bo-rest-basketorder-addscrips.json" } }, "/bo-rest/basketorder/createbasket": { "post": { "description": "Creates a new empty basket with the given name. The response returns the created basket object with the assigned basketId.", "operationId": "post-bo-rest-basketorder-createbasket", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "basketName": "Basket" }, "schema": { "properties": { "basketName": { "description": "Name/label for the new basket.", "type": "string", "x-data-type": "string" } }, "required": [ "basketName" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "basketId": 44, "basketName": "Basket", "createdOn": "2026-04-06 17:54:47", "isExecuted": "0", "scripCount": 0 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "basketId": { "type": "integer" }, "basketName": { "type": "string" }, "createdOn": { "type": "string" }, "isExecuted": { "type": "string" }, "scripCount": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Create Basket", "tags": [ "basket-orders" ], "x-request-schema-file": "schemas/requests/basket-orders/post-bo-rest-basketorder-createbasket.json" } }, "/bo-rest/basketorder/delete/{basketId}": { "post": { "description": "Permanently deletes an entire basket and all its scrip entries. The basketId is passed as a URL path parameter.", "operationId": "post-bo-rest-basketorder-delete-basketid", "parameters": [ { "in": "path", "name": "basketId", "required": true, "schema": { "type": "integer", "x-data-type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object", "x-data-type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "basketId": 7, "basketName": "Basket aathscafdhdbd", "createdOn": "2026-03-10 18:13:16", "isExecuted": "1", "scripCount": 5 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "basketId": { "type": "integer" }, "basketName": { "type": "string" }, "createdOn": { "type": "string" }, "isExecuted": { "type": "string" }, "scripCount": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Delete Basket", "tags": [ "basket-orders" ], "x-request-schema-file": "schemas/requests/basket-orders/post-bo-rest-basketorder-delete-basketid.json" } }, "/bo-rest/basketorder/deletescrips": { "post": { "description": "Removes one or more scrip entries from a basket using their scrip IDs. The basket itself is retained.", "operationId": "post-bo-rest-basketorder-deletescrips", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "basketId": 44, "scripsId": [ 88 ] }, "schema": { "properties": { "basketId": { "description": "ID of the basket from which scrips are to be removed.", "type": "integer", "x-data-type": "integer" }, "scripsId": { "description": "Array of scrip entry IDs to delete. E.g., [88, 91].", "items": { "type": "integer", "x-data-type": "integer" }, "type": "array", "x-data-type": "array" } }, "required": [ "basketId", "scripsId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Delete Scrips from Basket", "tags": [ "basket-orders" ], "x-request-schema-file": "schemas/requests/basket-orders/post-bo-rest-basketorder-deletescrips.json" } }, "/bo-rest/basketorder/getbasket": { "get": { "description": "Returns all baskets created by the authenticated user.", "operationId": "get-bo-rest-basketorder-getbasket", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "basketId": 7, "basketName": "Basket", "createdOn": "2026-03-10 18:13:16", "isExecuted": "0", "scripCount": 5 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "basketId": { "type": "integer" }, "basketName": { "type": "string" }, "createdOn": { "type": "string" }, "isExecuted": { "type": "string" }, "scripCount": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Basket", "tags": [ "basket-orders" ], "x-request-schema-file": "schemas/requests/basket-orders/get-bo-rest-basketorder-getbasket.json" } }, "/bo-rest/basketorder/getscrips/{basketId}": { "get": { "description": "Returns all scrip entries (order legs) in the specified basket. The basketId is passed as a URL path parameter.", "operationId": "get-bo-rest-basketorder-getscrips-basketid", "parameters": [ { "in": "path", "name": "basketId", "required": true, "schema": { "type": "integer", "x-data-type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "basketId": 44, "disClosedQty": null, "exchange": "NSE", "expiry": null, "expiryDate": null, "formattedInsName": "IDEA-EQ", "id": 89, "lotSize": null, "mktProtection": "1", "orderType": "AMO", "price": "8.76", "priceType": "L", "product": "CNC", "qty": "1", "ret": "DAY", "sortOrder": null, "stopLoss": "0", "target": "0", "token": "14366", "tradingSymbol": "IDEA-EQ", "trailingStopLoss": null, "transType": "BUY", "triggerPrice": "0", "validityDays": null, "weekTag": null } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "basketId": { "type": "integer" }, "disClosedQty": { "nullable": true }, "exchange": { "type": "string" }, "expiry": { "nullable": true }, "expiryDate": { "nullable": true }, "formattedInsName": { "type": "string" }, "id": { "type": "integer" }, "lotSize": { "nullable": true }, "mktProtection": { "type": "string" }, "orderType": { "type": "string" }, "price": { "type": "string" }, "priceType": { "type": "string" }, "product": { "type": "string" }, "qty": { "type": "string" }, "ret": { "type": "string" }, "sortOrder": { "nullable": true }, "stopLoss": { "type": "string" }, "target": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "trailingStopLoss": { "nullable": true }, "transType": { "type": "string" }, "triggerPrice": { "type": "string" }, "validityDays": { "nullable": true }, "weekTag": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Scrips in Basket", "tags": [ "basket-orders" ], "x-request-schema-file": "schemas/requests/basket-orders/get-bo-rest-basketorder-getscrips-basketid.json" } }, "/bo-rest/basketorder/spanmargin": { "post": { "description": "Calculates the SPAN margin requirement for a set of basket orders before execution. This endpoint is currently active for Mock Provider only. Mock Provider returns \"Not ok\" (not yet supported at that broker). Not applicable to Mock Provider, Mock Provider, Mock Provider, or Mock Provider.", "operationId": "post-bo-rest-basketorder-spanmargin", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "exchange": "NSE", "orderFlag": "NEW", "orderType": "Regular", "price": "395.90", "priceType": "L", "product": "CNC", "qty": "1", "stopLoss": "0", "token": "383", "transType": "BUY", "triggerPrice": "0" } ], "schema": { "items": { "properties": { "exchange": { "type": "string", "x-data-type": "string" }, "orderFlag": { "type": "string", "x-data-type": "string" }, "orderType": { "type": "string", "x-data-type": "string" }, "price": { "type": "string", "x-data-type": "string" }, "priceType": { "type": "string", "x-data-type": "string" }, "product": { "type": "string", "x-data-type": "string" }, "qty": { "type": "string", "x-data-type": "string" }, "stopLoss": { "type": "string", "x-data-type": "string" }, "token": { "type": "string", "x-data-type": "string" }, "transType": { "type": "string", "x-data-type": "string" }, "triggerPrice": { "type": "string", "x-data-type": "string" } }, "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "availableMargin": "3940.26", "emsg": null, "exposureMarginPrst": "0", "spanRequirement": "0", "spreadBenefit": "0", "stat": null, "totalRequirement": "397.0899963378906" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "availableMargin": { "type": "string" }, "emsg": { "nullable": true }, "exposureMarginPrst": { "type": "string" }, "spanRequirement": { "type": "string" }, "spreadBenefit": { "type": "string" }, "stat": { "nullable": true }, "totalRequirement": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SpanMargin (NEST Brokers Only)", "tags": [ "basket-orders" ], "x-request-schema-file": "schemas/requests/basket-orders/post-bo-rest-basketorder-spanmargin.json" } }, "/bo-rest/basketorder/updatescrips": { "post": { "description": "Updates the parameters of an existing scrip entry in a basket. The id field in the scrips object identifies which scrip to modify. All fields from Add Scrips should be re-submitted along with the updated values.", "operationId": "post-bo-rest-basketorder-updatescrips", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "basketId": 44, "scrips": { "disclosedQty": 0, "exchange": "NSE", "id": 89, "lotSize": "1", "mktProtection": "", "orderType": "Regular", "positionSqrOff": "", "price": "9.91", "priceType": "L", "product": "MIS", "qty": 2, "ret": "DAY", "source": "WEB", "stopLoss": 0, "target": 0, "token": "14366", "tradingSymbol": "IDEA-EQ", "transType": "BUY", "triggerPrice": 0 } }, "schema": { "properties": { "basketId": { "description": "ID of the basket containing the scrip.", "type": "integer", "x-data-type": "integer" }, "scrips": { "properties": { "disclosedQty": { "type": "integer", "x-data-type": "integer" }, "exchange": { "type": "string", "x-data-type": "string" }, "id": { "type": "integer", "x-data-type": "integer" }, "lotSize": { "type": "string", "x-data-type": "string" }, "mktProtection": { "type": "string", "x-data-type": "string" }, "orderType": { "type": "string", "x-data-type": "string" }, "positionSqrOff": { "type": "string", "x-data-type": "string" }, "price": { "type": "string", "x-data-type": "string" }, "priceType": { "type": "string", "x-data-type": "string" }, "product": { "type": "string", "x-data-type": "string" }, "qty": { "type": "integer", "x-data-type": "integer" }, "ret": { "type": "string", "x-data-type": "string" }, "source": { "type": "string", "x-data-type": "string" }, "stopLoss": { "type": "integer", "x-data-type": "integer" }, "target": { "type": "integer", "x-data-type": "integer" }, "token": { "type": "string", "x-data-type": "string" }, "tradingSymbol": { "type": "string", "x-data-type": "string" }, "transType": { "type": "string", "x-data-type": "string" }, "triggerPrice": { "type": "integer", "x-data-type": "integer" } }, "type": "object", "x-data-type": "object" } }, "required": [ "basketId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": null, "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "nullable": true }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Update Scrips in Basket", "tags": [ "basket-orders" ], "x-request-schema-file": "schemas/requests/basket-orders/post-bo-rest-basketorder-updatescrips.json" } }, "/chart/config": { "get": { "description": "Loads all chart configurations from the database into in-memory cache. Should be called at startup or to reload configuration.", "operationId": "get-chart-config", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "exchanges": [ [] ], "supported_history_resol": [ [] ], "supported_resolutions": [ [] ], "supports_group_request": false, "supports_marks": false, "supports_search": false, "supports_time": false, "symbols_types": [ [] ] }, "schema": { "properties": { "exchanges": { "items": { "items": {}, "type": "array" }, "type": "array" }, "supported_history_resol": { "items": { "items": {}, "type": "array" }, "type": "array" }, "supported_resolutions": { "items": { "items": {}, "type": "array" }, "type": "array" }, "supports_group_request": { "type": "boolean" }, "supports_marks": { "type": "boolean" }, "supports_search": { "type": "boolean" }, "supports_time": { "type": "boolean" }, "symbols_types": { "items": { "items": {}, "type": "array" }, "type": "array" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GET /chart/config", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/get-chart-config.json" } }, "/chart/getIndices": { "get": { "description": "Returns a list of all active index instruments with their live price (LTP).", "operationId": "get-chart-getindices", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "result": [ { "exchange": "NSE", "ltp": 100, "symbol": "MOCK", "token": "10001" } ] }, "schema": { "properties": { "result": { "items": { "properties": { "exchange": { "type": "string" }, "ltp": { "type": "integer" }, "symbol": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GET /chart/getIndices", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/get-chart-getindices.json" } }, "/chart/history": { "get": { "description": "Returns historical OHLCV data in TradingView UDF format. All timestamps are Unix epoch seconds.", "operationId": "get-chart-history", "parameters": [ { "allowEmptyValue": true, "example": "mock", "in": "query", "name": "symbol", "required": true, "schema": { "description": "Encoded symbol (same format as /chart/symbols)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "mock", "in": "query", "name": "resolution", "required": true, "schema": { "description": "Bar resolution — 1, 3, 5, 10, 15, 30, 60, 120, 240, 1D, 1W, 1M, 3M, 6M, 12M", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": false, "example": 1, "in": "query", "name": "from", "required": true, "schema": { "description": "Start time (Unix epoch seconds)", "format": "int64", "type": "integer", "x-data-type": "int64" } }, { "allowEmptyValue": false, "example": 1, "in": "query", "name": "to", "required": true, "schema": { "description": "End time (Unix epoch seconds)", "format": "int64", "type": "integer", "x-data-type": "int64" } }, { "allowEmptyValue": true, "example": "mock", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange — NSE, BSE, NFO, MCX", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": false, "in": "query", "name": "countback", "required": false, "schema": { "description": "Number of bars to return (alternative to from/to range)", "type": "integer", "x-data-type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "c": [], "h": [], "iv": [], "l": [], "o": [], "s": "ok", "t": [], "v": [] }, "schema": { "properties": { "c": { "items": {}, "type": "array" }, "h": { "items": {}, "type": "array" }, "iv": { "items": {}, "type": "array" }, "l": { "items": {}, "type": "array" }, "o": { "items": {}, "type": "array" }, "s": { "type": "string" }, "t": { "items": {}, "type": "array" }, "v": { "items": {}, "type": "array" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GET /chart/history", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/get-chart-history.json" } }, "/chart/history/closeprice": { "post": { "description": "Returns close price arrays for a single instrument over a specified interval. Allowed interval values: 1D | 1W | 1M | 3M | 6M | 12M | ALL", "operationId": "post-chart-history-closeprice", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exch": "NSE", "interval": "1D", "token": "22" }, "schema": { "properties": { "exch": { "type": "string", "x-data-type": "string" }, "interval": { "type": "string", "x-data-type": "string" }, "token": { "type": "string", "x-data-type": "string" } }, "type": "object", "x-data-type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "result": [ { "c": [], "s": "ok", "t": [] } ] }, "schema": { "properties": { "result": { "items": { "properties": { "c": { "items": {}, "type": "array" }, "s": { "type": "string" }, "t": { "items": {}, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "POST /chart/history/closeprice", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/post-chart-history-closeprice.json" } }, "/chart/search": { "get": { "description": "Searches for symbols matching the query string. Query must be at least 2 characters long.", "operationId": "get-chart-search", "parameters": [ { "allowEmptyValue": true, "example": "30", "in": "query", "name": "limit", "required": false, "schema": { "anyOf": [ { "type": "integer", "x-data-type": "integer" }, { "type": "string", "x-data-type": "string" } ], "description": "Max results to return (default 30)", "x-data-type": "union" } }, { "allowEmptyValue": true, "example": "CRUDEOIL FUT", "in": "query", "name": "query", "required": true, "schema": { "description": "Search term (min 2 chars). URL-encode spaces as %20", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "stock", "in": "query", "name": "type", "required": false, "schema": { "description": "Filter by type — stock, index, futures, etc.", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "MCX", "in": "query", "name": "exchange", "required": false, "schema": { "description": "Filter by exchange — NSE, BSE, NFO, MCX", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "description": "mock", "exchange": "NSE", "full_name": "mock", "symbol": "MOCK", "ticker": "mock", "token": "10001", "tradingSymbol": "MOCK-EQ", "type": "mock" }, "schema": { "properties": { "description": { "type": "string" }, "exchange": { "type": "string" }, "full_name": { "type": "string" }, "symbol": { "type": "string" }, "ticker": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GET /chart/search", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/get-chart-search.json" } }, "/chart/symbol_info": { "get": { "description": "Returns a hardcoded datafeed version string. Response: \"Datafeed version is 2.0.4 | Valid keys count is 5 | Current key is zy1\"", "operationId": "get-chart-symbol-info", "parameters": [], "responses": { "200": { "content": { "text/plain": { "example": "Datafeed version is 2.0.4 | Valid keys count is 5 | Current key is zy1", "schema": { "type": "string" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GET /chart/symbol_info", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/get-chart-symbol-info.json" } }, "/chart/symbols": { "get": { "description": "Returns detailed metadata for a specific symbol. The symbol query parameter uses URL encoding: INDEX format: INDEX_token_exchange%3Asymbol | STOCK/F\u0026O format: token_exchange%3Asymbol (%3A = colon, %20 = space).", "operationId": "get-chart-symbols", "parameters": [ { "allowEmptyValue": true, "example": "mock", "in": "query", "name": "symbol", "required": true, "schema": { "description": "Encoded symbol string. e.g. 26000_NSE%3ANIFTY 50 for Nifty index", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "description": "mock", "has_intraday": false, "name": "mock", "pricescale": 100, "request_exchange": "mock", "session": "mock", "supported_resolutions": [ [] ], "tickSize": 1, "ticker": "mock", "timezone": "mock", "tradingSymbol": "MOCK-EQ", "type": "mock" }, "schema": { "properties": { "description": { "type": "string" }, "has_intraday": { "type": "boolean" }, "name": { "type": "string" }, "pricescale": { "type": "integer" }, "request_exchange": { "type": "string" }, "session": { "type": "string" }, "supported_resolutions": { "items": { "items": {}, "type": "array" }, "type": "array" }, "tickSize": { "type": "integer" }, "ticker": { "type": "string" }, "timezone": { "type": "string" }, "tradingSymbol": { "type": "string" }, "type": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GET /chart/symbols", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/get-chart-symbols.json" } }, "/chart/time": { "get": { "description": "Returns the current server time as a Unix timestamp in milliseconds (plain Long, not JSON).", "operationId": "get-chart-time", "parameters": [], "responses": { "200": { "content": { "text/plain": { "example": "1706604800000", "schema": { "type": "string" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GET /chart/time", "tags": [ "chart" ], "x-request-schema-file": "schemas/requests/chart/get-chart-time.json" } }, "/client/order/preference/get": { "post": { "description": "Returns the default order placement preferences (variety, order type, product, validity, quantity) for the client per segment.", "operationId": "post-client-order-preference-get", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "segment": "NSE", "userId": "XA3637" }, "schema": { "properties": { "segment": { "description": "Exchange segment (e.g. \"NSE\", \"BSE\", \"NFO\")", "type": "string", "x-data-type": "string" }, "userId": { "description": "User ID", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "segment" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "orderType": "MARKET", "product": "CNC", "quantity": 1, "segment": "NSE", "userId": "XA3637", "validity": "DAY", "variety": "REGULAR" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderType": { "type": "string" }, "product": { "type": "string" }, "quantity": { "type": "integer" }, "segment": { "type": "string" }, "userId": { "type": "string" }, "validity": { "type": "string" }, "variety": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Client Order Preference", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-client-order-preference-get.json" } }, "/client/order/preference/update": { "post": { "description": "Updates the default order preferences for the client for a given exchange segment.", "operationId": "post-client-order-preference-update", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "orderType": "Limit", "product": "MIS", "quantity": 1, "segment": "NSE", "userId": "XA3637", "validity": "DAY", "variety": "Quick" }, "schema": { "properties": { "orderType": { "description": "Order type (MARKET, Limit, market)", "type": "string", "x-data-type": "string" }, "product": { "description": "Product type (CNC, MIS, intraday, delivery)", "type": "string", "x-data-type": "string" }, "quantity": { "description": "Default order quantity", "type": "integer", "x-data-type": "integer" }, "segment": { "description": "Exchange segment (e.g. \"NSE\", \"BSE\", \"NFO\")", "type": "string", "x-data-type": "string" }, "userId": { "description": "User ID", "type": "string", "x-data-type": "string" }, "validity": { "description": "Order validity (DAY, IOC)", "type": "string", "x-data-type": "string" }, "variety": { "description": "Order variety (REGULAR, Quick, intraday, delivery)", "type": "string", "x-data-type": "string" } }, "required": [ "userId", "segment", "variety", "orderType", "product", "validity", "quantity" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Updated Successfully", "result": null, "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "nullable": true }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Update Client Order Preference", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-client-order-preference-update.json" } }, "/fundamentalandTechnical/get/companynews": { "get": { "description": "Retrieve the latest news articles associated with a specific stock/exchange token.", "operationId": "get-fundamentalandtechnical-get-companynews", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "example": "No Records Found", "schema": { "type": "string" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Company News", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-fundamentalandtechnical-get-companynews.json" } }, "/funds/clientBankDetails": { "get": { "description": "Returns KYC-linked bank accounts, contact details, enabled trading segments, and UPI IDs for the authenticated client.", "operationId": "get-funds-clientbankdetails", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "bankDetails": [ { "bankActNo": "***********43", "bankCode": "CNRB", "bankName": "CANARA BANK", "clientName": "MURUGESAN GOWTHAMAN", "ifscCode": "CNRB0004373" } ], "email": "gowthamanmail99@gmail.com", "payoutReasons": null, "phone": "9791411886", "segEnable": [ "NSE", "NSE IPO", "BSE" ], "upiId": "NA", "userName": "MURUGESAN GOWTHAMAN" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "bankDetails": { "items": { "properties": { "bankActNo": { "type": "string" }, "bankCode": { "type": "string" }, "bankName": { "type": "string" }, "clientName": { "type": "string" }, "ifscCode": { "type": "string" } }, "type": "object" }, "type": "array" }, "email": { "type": "string" }, "payoutReasons": { "nullable": true }, "phone": { "type": "string" }, "segEnable": { "items": { "type": "string" }, "type": "array" }, "upiId": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Client Bank Details", "tags": [ "funds-payments" ], "x-request-schema-file": "schemas/requests/funds-payments/get-funds-clientbankdetails.json" } }, "/funds/clientFunds": { "get": { "description": "Fetches the available margin, opening balance, brokerage, exposure, collateral, and various P\u0026L figures for the authenticated client. Each broker returns a slightly different set of fields; all known fields are documented below.", "operationId": "get-funds-clientfunds", "parameters": [ { "allowEmptyValue": true, "example": "599210", "in": "query", "name": "userId", "required": true, "schema": { "description": "Client user identifier", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "HO", "in": "query", "name": "groupId", "required": true, "schema": { "description": "Group code (e.g. \"HO\")", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "All Equities + Derv Combined + Curr Combined", "in": "query", "name": "periodicityName", "required": true, "schema": { "description": "Segment group name (e.g. \"All Equities + Derv Combined + Curr Combined\")", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1", "in": "query", "name": "productType", "required": true, "schema": { "description": "Product type code (e.g. \"1\")", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "adhocMargin": 0, "allocationOrWithdrawal": 0, "availableMargin": 0, "bookedPAndL": -0, "brokerage": 0, "collateral": 0, "creditForSale": 0, "exposure": 0, "fundsTranstoday": 0, "holdingSellCredit": 0, "marginUsed": 0, "mtmPAndL": -0, "netAvailableFunds": 0, "notionalCash": 0, "openingBalance": 0, "payin": 0, "payout": 0, "premium": 0, "span": 0, "stockPledge": 0, "totalUtilize": 0, "unclearedCash": 0 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "adhocMargin": { "type": "number" }, "allocationOrWithdrawal": { "type": "number" }, "availableMargin": { "type": "number" }, "bookedPAndL": { "type": "number" }, "brokerage": { "type": "number" }, "collateral": { "type": "number" }, "creditForSale": { "type": "number" }, "exposure": { "type": "number" }, "fundsTranstoday": { "type": "number" }, "holdingSellCredit": { "type": "number" }, "marginUsed": { "type": "number" }, "mtmPAndL": { "type": "number" }, "netAvailableFunds": { "type": "number" }, "notionalCash": { "type": "number" }, "openingBalance": { "type": "number" }, "payin": { "type": "number" }, "payout": { "type": "number" }, "premium": { "type": "number" }, "span": { "type": "number" }, "stockPledge": { "type": "number" }, "totalUtilize": { "type": "number" }, "unclearedCash": { "type": "number" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Client Funds", "tags": [ "funds-payments" ], "x-request-schema-file": "schemas/requests/funds-payments/get-funds-clientfunds.json" } }, "/funds/createPaymentId": { "post": { "description": "Generates a Razorpay order for adding funds to the trading account. Returns an orderId and receiptId used in the subsequent payment verification step.", "operationId": "post-funds-createpaymentid", "parameters": [], "requestBody": { "content": { "application/json": { "examples": { "request-01": { "description": "documented", "summary": "Example Request (Mock Provider)", "value": { "amount": 10000, "bankActNo": "4373101011143", "ifscCode": "CNRB0004373", "payMethod": "upi", "upiId": "test@canara.upi" } }, "request-02": { "description": "documented", "summary": "Example Request (Mock Provider)", "value": { "amount": 100, "bankActNo": "50200058851178", "ifscCode": "HDFC0000067", "payMethod": "netbanking", "upiId": "" } } }, "schema": { "anyOf": [ { "properties": { "amount": { "anyOf": [ { "type": "number", "x-data-type": "number" }, { "type": "integer", "x-data-type": "integer" } ], "description": "Amount to add in INR (payin value)", "x-data-type": "union" }, "bankActNo": { "description": "Bank account number to debit", "type": "string", "x-data-type": "string" }, "ifscCode": { "description": "IFSC code of the bank account", "type": "string", "x-data-type": "string" }, "payMethod": { "description": "\"upi\" or \"netbanking\"", "type": "string", "x-data-type": "string" }, "upiId": { "description": "UPI ID when payMethod is \"upi\"; empty string for netbanking", "type": "string", "x-data-type": "string" } }, "required": [ "amount", "payMethod", "bankActNo", "ifscCode" ], "type": "object", "x-data-type": "object" }, { "properties": { "amount": { "anyOf": [ { "type": "number", "x-data-type": "number" }, { "type": "integer", "x-data-type": "integer" } ], "description": "Amount to add in INR (payin value)", "x-data-type": "union" }, "bankActNo": { "description": "Bank account number to debit", "type": "string", "x-data-type": "string" }, "ifscCode": { "description": "IFSC code of the bank account", "type": "string", "x-data-type": "string" }, "payMethod": { "description": "\"upi\" or \"netbanking\"", "type": "string", "x-data-type": "string" }, "upiId": { "description": "UPI ID when payMethod is \"upi\"; empty string for netbanking", "type": "string", "x-data-type": "string" } }, "required": [ "amount", "payMethod", "bankActNo", "ifscCode" ], "type": "object", "x-data-type": "object" } ], "x-data-type": "union" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "orderId": "order_SXjcvII8Zx27tT", "receiptId": "E9K5IKCXZKU15VK" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "orderId": { "type": "string" }, "receiptId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Create Payment ID", "tags": [ "funds-payments" ], "x-request-schema-file": "schemas/requests/funds-payments/post-funds-createpaymentid.json" } }, "/funds/createWithdrawal": { "post": { "description": "Submits a payout/withdrawal request for the specified amount to the linked bank account. Available for Mock Provider.", "operationId": "post-funds-createwithdrawal", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "amount": "2000", "bankActNo": "042104000170536" }, "schema": { "properties": { "amount": { "description": "Withdrawal amount in INR (sent as string)", "type": "string", "x-data-type": "string" }, "bankActNo": { "description": "Bank account number to credit the withdrawal amount", "type": "string", "x-data-type": "string" } }, "required": [ "bankActNo", "amount" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "data": { "amount": 2000, "asOnDate": null, "availableBalance": 0, "bankAccountNo": "042170536", "bankName": "", "clientCode": "DK2200295", "clientName": "", "isDisabledPayoutDrp": false, "listClientBanks": null, "message": "Withdrawal request sent successfully.", "success": true, "withdrawalBalance": 0 }, "error": "", "message": "Withdrawal request sent successfully.", "success": true } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "data": { "properties": { "amount": { "type": "number" }, "asOnDate": { "nullable": true }, "availableBalance": { "type": "number" }, "bankAccountNo": { "type": "string" }, "bankName": { "type": "string" }, "clientCode": { "type": "string" }, "clientName": { "type": "string" }, "isDisabledPayoutDrp": { "type": "boolean" }, "listClientBanks": { "nullable": true }, "message": { "type": "string" }, "success": { "type": "boolean" }, "withdrawalBalance": { "type": "number" } }, "type": "object" }, "error": { "type": "string" }, "message": { "type": "string" }, "success": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Create Withdrawal Request", "tags": [ "funds-payments" ], "x-request-schema-file": "schemas/requests/funds-payments/post-funds-createwithdrawal.json" } }, "/funds/deleteWithdrawal": { "post": { "description": "Cancels a pending withdrawal request by its ID. Available for Mock Provider.", "operationId": "post-funds-deletewithdrawal", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "withdrawalRequestId": "1514031" }, "schema": { "properties": { "withdrawalRequestId": { "description": "ID of the pending withdrawal request to cancel", "type": "string", "x-data-type": "string" } }, "required": [ "withdrawalRequestId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "data": "", "error": "", "message": "Withdrawal request deleted successfully.", "success": true } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "data": { "type": "string" }, "error": { "type": "string" }, "message": { "type": "string" }, "success": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Delete Withdrawal Request", "tags": [ "funds-payments" ], "x-request-schema-file": "schemas/requests/funds-payments/post-funds-deletewithdrawal.json" } }, "/funds/transactionList": { "get": { "description": "Returns the paginated list of fund transactions (payin and payout) for the authenticated client.", "operationId": "get-funds-transactionlist", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "accNum": "4373101011143", "amount": 151, "bankName": "CANARA BANK", "boUpdate": 0, "createdOn": "2026-03-26 11:53:12", "exchSeg": null, "orderId": "order_SVknqOKiXVgZvs", "paymentMethod": "upi", "paymentStatus": "created", "receiptId": "IUCAZF3WLFJD3TP", "request": null, "updatedOn": "2026-03-26T11:53:12.087+05:30", "upiId": null, "userId": "127279", "voucherNo": null } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "accNum": { "type": "string" }, "amount": { "type": "number" }, "bankName": { "type": "string" }, "boUpdate": { "type": "integer" }, "createdOn": { "type": "string" }, "exchSeg": { "nullable": true }, "orderId": { "type": "string" }, "paymentMethod": { "type": "string" }, "paymentStatus": { "type": "string" }, "receiptId": { "type": "string" }, "request": { "nullable": true }, "updatedOn": { "type": "string" }, "upiId": { "nullable": true }, "userId": { "type": "string" }, "voucherNo": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Client Transaction List", "tags": [ "funds-payments" ], "x-request-schema-file": "schemas/requests/funds-payments/get-funds-transactionlist.json" } }, "/funds/verifyPayment": { "post": { "description": "Verifies a completed Razorpay payment using the signature, order ID, and payment ID returned by the Razorpay callback. On success the fund balance is updated.", "operationId": "post-funds-verifypayment", "parameters": [], "requestBody": { "content": { "application/json": { "examples": { "request-01": { "description": "documented", "summary": "Example Request (Mock Provider)", "value": { "amount": 56000, "currency": "INR", "razorpayOrderId": "order_SZIEgc54wxCiKu", "razorpayPaymentId": "pay_SZIEha5Qdsnljw", "razorpaySignature": "47596dbc7325d2abb2d292220fdbc79a4b84dd47725a55fc9cf3c7d85573162e", "receipt": "YILMGGK8U1XEGO7" } }, "request-02": { "description": "documented", "summary": "Example Request (Mock Provider)", "value": { "amount": "2000", "currency": "INR", "razorpayOrderId": "order_SXO3I5zdp", "razorpayPaymentId": "pay_SXIiwBWXu", "razorpaySignature": "ffcd29874c683a5f295d03a0d334055c3dbc33303", "receipt": "91XMO6KWVN1" } } }, "schema": { "anyOf": [ { "properties": { "amount": { "anyOf": [ { "type": "number", "x-data-type": "number" }, { "type": "integer", "x-data-type": "integer" } ], "description": "Payment amount in INR", "x-data-type": "union" }, "currency": { "description": "Currency code — always \"INR\"", "type": "string", "x-data-type": "string" }, "razorpayOrderId": { "description": "Razorpay order ID from createPaymentId response", "type": "string", "x-data-type": "string" }, "razorpayPaymentId": { "description": "Payment ID returned by Razorpay after user pays", "type": "string", "x-data-type": "string" }, "razorpaySignature": { "description": "HMAC-SHA256 signature to verify payment authenticity", "type": "string", "x-data-type": "string" }, "receipt": { "description": "Receipt ID returned by createPaymentId", "type": "string", "x-data-type": "string" } }, "required": [ "amount", "currency", "receipt", "razorpayOrderId", "razorpayPaymentId", "razorpaySignature" ], "type": "object", "x-data-type": "object" }, { "properties": { "amount": { "anyOf": [ { "type": "number", "x-data-type": "number" }, { "type": "string", "x-data-type": "string" } ], "description": "Payment amount in INR", "x-data-type": "union" }, "currency": { "description": "Currency code — always \"INR\"", "type": "string", "x-data-type": "string" }, "razorpayOrderId": { "description": "Razorpay order ID from createPaymentId response", "type": "string", "x-data-type": "string" }, "razorpayPaymentId": { "description": "Payment ID returned by Razorpay after user pays", "type": "string", "x-data-type": "string" }, "razorpaySignature": { "description": "HMAC-SHA256 signature to verify payment authenticity", "type": "string", "x-data-type": "string" }, "receipt": { "description": "Receipt ID returned by createPaymentId", "type": "string", "x-data-type": "string" } }, "required": [ "amount", "currency", "receipt", "razorpayOrderId", "razorpayPaymentId", "razorpaySignature" ], "type": "object", "x-data-type": "object" } ], "x-data-type": "union" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "result": [ "Verified and updated successfully" ] } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "result": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Verify Payment Details", "tags": [ "funds-payments" ], "x-request-schema-file": "schemas/requests/funds-payments/post-funds-verifypayment.json" } }, "/funds/withdrawalDetails": { "get": { "description": "Retrieves the current withdrawal/payout status and balance details for the authenticated client.", "operationId": "get-funds-withdrawaldetails", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "amount": "47941", "backofficeCode": "KA0652S010", "bankActNo": "22036", "bankCode": "CAN", "bankName": null, "clientName": null, "createdOn": "1757356200000 (epoch ms)", "device": null, "ifscCode": "CNRB0000471", "orderId": null, "payMethod": "NEFT", "payment": "PAYMENT", "paymentReason": null, "paymentStatus": "completed", "receipt": null, "segment": null, "updatedOn": "1757390056000 (epoch ms)", "upiId": null, "userId": "52S010" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "amount": { "type": "string" }, "backofficeCode": { "type": "string" }, "bankActNo": { "type": "string" }, "bankCode": { "type": "string" }, "bankName": { "nullable": true }, "clientName": { "nullable": true }, "createdOn": { "type": "string" }, "device": { "nullable": true }, "ifscCode": { "type": "string" }, "orderId": { "nullable": true }, "payMethod": { "type": "string" }, "payment": { "type": "string" }, "paymentReason": { "nullable": true }, "paymentStatus": { "type": "string" }, "receipt": { "nullable": true }, "segment": { "nullable": true }, "updatedOn": { "type": "string" }, "upiId": { "nullable": true }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Withdrawal Details", "tags": [ "funds-payments" ], "x-request-schema-file": "schemas/requests/funds-payments/get-funds-withdrawaldetails.json" } }, "/getFundamentals/getBlockDealDataInDb": { "get": { "description": "Retrieve block deal data stored in the platform database for a specific stock.", "operationId": "get-getfundamentals-getblockdealdataindb", "parameters": [ { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "avgPrice": 2450.75, "buySell": "BUY", "clientName": "XYZ FUND", "coCode": "10000", "date": "2024-01-15", "exch": "NSE", "qtyShares": 500000, "scripCode": "RELIANCE", "scripName": "RELIANCE INDUSTRIES LTD", "serial": 1, "token": "1594" } ], "schema": { "items": { "properties": { "avgPrice": { "type": "number" }, "buySell": { "type": "string" }, "clientName": { "type": "string" }, "coCode": { "type": "string" }, "date": { "type": "string" }, "exch": { "type": "string" }, "qtyShares": { "type": "integer" }, "scripCode": { "type": "string" }, "scripName": { "type": "string" }, "serial": { "type": "integer" }, "token": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Block Deal Data", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getblockdealdataindb.json" } }, "/getFundamentals/getCashFlow": { "get": { "description": "Retrieve the Cash Flow Statement with operating, investing, and financing cash flows. Available on Mock Provider broker.", "operationId": "get-getfundamentals-getcashflow", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "consolidated": [ { "cashFromFinancingActivity": "-62000", "cashFromInvestingActivity": "-48000", "cashFromOperatingActivity": "135000", "cashPlusCashEquivalentBeginOfYear": "13000", "cashPlusCashEquivalentEndOfYear": "38000", "interest": "18000", "netCashFlow": "25000", "profitBeforeTax": "135500", "tax": "35000", "year": "2024" } ], "standalone": [] }, "schema": { "properties": { "consolidated": { "items": { "properties": { "cashFromFinancingActivity": { "type": "string" }, "cashFromInvestingActivity": { "type": "string" }, "cashFromOperatingActivity": { "type": "string" }, "cashPlusCashEquivalentBeginOfYear": { "type": "string" }, "cashPlusCashEquivalentEndOfYear": { "type": "string" }, "interest": { "type": "string" }, "netCashFlow": { "type": "string" }, "profitBeforeTax": { "type": "string" }, "tax": { "type": "string" }, "year": { "type": "string" } }, "type": "object" }, "type": "array" }, "standalone": { "items": {}, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Cash Flow Statement", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getcashflow.json" } }, "/getFundamentals/getCompanyDescription": { "get": { "description": "Retrieve descriptive information about a company. Response detail varies by broker — Mock Provider returns a long-form description while Mock Provider returns structured company metadata.", "operationId": "get-getfundamentals-getcompanydescription", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "companyName": "RELIANCE INDUSTRIES LTD", "description": "Reliance Industries Limited is a conglomerate holding company headquartered in Mumbai, India. Founded in 1966 by Dhirubhai Ambani, it has grown to become the largest private sector corporation in India by revenue. The company operates across energy, petrochemicals, natural gas, retail, telecommunications, mass media and textiles..." }, "schema": { "properties": { "companyName": { "type": "string" }, "description": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Company Description", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getcompanydescription.json" } }, "/getFundamentals/getCorporateAction": { "get": { "description": "Retrieve corporate action events (dividends, bonus issues, splits, buybacks, rights) for a specific stock.", "operationId": "get-getfundamentals-getcorporateaction", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "adjustmentFactor": null, "bbFromDate": null, "bbToDate": null, "bseToken": "500325", "coCode": "10000", "corpActionDetails": "Interim Dividend", "corpActionValue": "9.00", "descriptions": "Interim Dividend @ Rs. 9 Per Share", "eventType": "DIVIDEND", "exDate": 1706745600000, "isin": "INE002A01018", "maxbaybackPrice": null, "newIsin": null, "nseToken": "1594", "oldIsin": null, "recordDate": "2024-02-01", "scripName": "RELIANCE INDUSTRIES LTD" } ], "schema": { "items": { "properties": { "adjustmentFactor": { "nullable": true }, "bbFromDate": { "nullable": true }, "bbToDate": { "nullable": true }, "bseToken": { "type": "string" }, "coCode": { "type": "string" }, "corpActionDetails": { "type": "string" }, "corpActionValue": { "type": "string" }, "descriptions": { "type": "string" }, "eventType": { "type": "string" }, "exDate": { "type": "integer" }, "isin": { "type": "string" }, "maxbaybackPrice": { "nullable": true }, "newIsin": { "nullable": true }, "nseToken": { "type": "string" }, "oldIsin": { "nullable": true }, "recordDate": { "type": "string" }, "scripName": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Corporate Action", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getcorporateaction.json" } }, "/getFundamentals/getCorporateAnnouncement": { "get": { "description": "Retrieve a single corporate announcement for a specific stock.", "operationId": "get-getfundamentals-getcorporateannouncement", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "bseToken": "500325", "caption": "Board Meeting Outcome", "coCode": "10000", "date": 1706745600000, "memo": "The Board of Directors at its meeting held today declared an Interim Dividend.", "name": "RELIANCE INDUSTRIES LTD", "nseToken": "1594", "scCode": "500325", "symbol": "RELIANCE" }, "schema": { "properties": { "bseToken": { "type": "string" }, "caption": { "type": "string" }, "coCode": { "type": "string" }, "date": { "type": "integer" }, "memo": { "type": "string" }, "name": { "type": "string" }, "nseToken": { "type": "string" }, "scCode": { "type": "string" }, "symbol": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Corporate Announcement", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getcorporateannouncement.json" } }, "/getFundamentals/getCorporateAnnouncementList": { "get": { "description": "Retrieve a paginated list of corporate announcements for a specific stock.", "operationId": "get-getfundamentals-getcorporateannouncementlist", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "bseToken": "500325", "caption": "Board Meeting Outcome", "coCode": "10000", "date": 1706745600000, "memo": "The Board of Directors declared an Interim Dividend.", "name": "RELIANCE INDUSTRIES LTD", "nseToken": "1594", "scCode": "500325", "symbol": "RELIANCE" } ], "schema": { "items": { "properties": { "bseToken": { "type": "string" }, "caption": { "type": "string" }, "coCode": { "type": "string" }, "date": { "type": "integer" }, "memo": { "type": "string" }, "name": { "type": "string" }, "nseToken": { "type": "string" }, "scCode": { "type": "string" }, "symbol": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Corporate Announcement List", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getcorporateannouncementlist.json" } }, "/getFundamentals/getFundamentalTTM": { "get": { "description": "Retrieve Trailing Twelve Month (TTM) fundamental metrics for a stock, including PE ratio, PB ratio, EPS, margin data, and sector comparisons.", "operationId": "get-getfundamentals-getfundamentalttm", "parameters": [ { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "c", "in": "query", "name": "type", "required": true, "schema": { "description": "Report type identifier. Use \"c\" for consolidated data", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "description": "Price to Earnings (TTM)", "message": "Stock is trading at 24.5x earnings", "timeframe": "TTM", "title": "peTtm", "value": "24.5" }, { "description": "Price to Book (TTM)", "message": "Trading at 2.8x book value", "timeframe": "TTM", "title": "pbTtm", "value": "2.8" } ], "schema": { "items": { "properties": { "description": { "type": "string" }, "message": { "type": "string" }, "timeframe": { "type": "string" }, "title": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Fundamental TTM", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getfundamentalttm.json" } }, "/getFundamentals/getRatios": { "get": { "description": "Retrieve comprehensive financial ratios including EPS, CEPS, book value, return metrics, and growth ratios. Available on Mock Provider broker.", "operationId": "get-getfundamentals-getratios", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "consolidated": [ { "AssetTurnOver": "0.72", "BVSH_A": "432.15", "BasicEPS_A": "66.85", "CEPS_A": "85.32", "CurrentRatio": "1.45", "DebtEquity": "0.38", "DebtorTurnover": "18.6", "InterestCoverRatio": "8.25", "InventoryTurnover": "12.4", "NetProfitMargin": "10.14", "PCF": "28.4", "PER": "36.72", "P_BV": "5.68", "Payout": "13.5", "QuickRatio": "1.12", "ROCE": "12.80", "RONW": "15.46", "Yield": "0.37", "year": "2024" } ] }, "schema": { "properties": { "consolidated": { "items": { "properties": { "AssetTurnOver": { "type": "string" }, "BVSH_A": { "type": "string" }, "BasicEPS_A": { "type": "string" }, "CEPS_A": { "type": "string" }, "CurrentRatio": { "type": "string" }, "DebtEquity": { "type": "string" }, "DebtorTurnover": { "type": "string" }, "InterestCoverRatio": { "type": "string" }, "InventoryTurnover": { "type": "string" }, "NetProfitMargin": { "type": "string" }, "PCF": { "type": "string" }, "PER": { "type": "string" }, "P_BV": { "type": "string" }, "Payout": { "type": "string" }, "QuickRatio": { "type": "string" }, "ROCE": { "type": "string" }, "RONW": { "type": "string" }, "Yield": { "type": "string" }, "year": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Financial Ratios", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getratios.json" } }, "/getFundamentals/getShareHoldingspattern": { "get": { "description": "Retrieve the historical shareholding pattern breakdown for a stock, showing promoter, institutional, and retail holding percentages over time.", "operationId": "get-getfundamentals-getshareholdingspattern", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "bseToken": "500325", "coCode": "10000", "foreignInstitution": 18.67, "id": 1, "mutualFund": 9.84, "nseToken": "1594", "otherDomesticInstitution": 5.21, "others": 3.51, "promoters": 50.32, "retail": 12.45, "yrc": 202312 } ], "schema": { "items": { "properties": { "bseToken": { "type": "string" }, "coCode": { "type": "string" }, "foreignInstitution": { "type": "number" }, "id": { "type": "integer" }, "mutualFund": { "type": "number" }, "nseToken": { "type": "string" }, "otherDomesticInstitution": { "type": "number" }, "others": { "type": "number" }, "promoters": { "type": "number" }, "retail": { "type": "number" }, "yrc": { "type": "number" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Share Holdings Pattern", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getshareholdingspattern.json" } }, "/getFundamentals/getSimilarStocks": { "get": { "description": "Retrieve a list of peer companies similar to the queried stock based on market cap, sector, or industry. Request and response structure varies significantly between Mock Provider and Mock Provider.", "operationId": "get-getfundamentals-getsimilarstocks", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": false, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": false, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "INE002A01018", "in": "query", "name": "scripIdentifier", "required": false, "schema": { "description": "Script identifier — typically the ISIN or token of the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "bseCode": "532540", "isin": "INE467B01029", "mcapq": "1450000", "npaGrowth": "12.5", "npq": "12000", "nseCode": "TCS", "nseNumber": "11536", "pbva": "13.2", "pettm": "28.5", "rev4q": "240000", "srq": "58000", "stockName": "TATA CONSULTANCY SERVICES LTD", "symbol": "TCS", "yearChangeP": "18.4" } ], "schema": { "items": { "properties": { "bseCode": { "type": "string" }, "isin": { "type": "string" }, "mcapq": { "type": "string" }, "npaGrowth": { "type": "string" }, "npq": { "type": "string" }, "nseCode": { "type": "string" }, "nseNumber": { "type": "string" }, "pbva": { "type": "string" }, "pettm": { "type": "string" }, "rev4q": { "type": "string" }, "srq": { "type": "string" }, "stockName": { "type": "string" }, "symbol": { "type": "string" }, "yearChangeP": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Similar Stocks", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getsimilarstocks.json" } }, "/getFundamentals/getStockWiseNews": { "get": { "description": "Retrieve paginated news articles for a specific stock. Available on Mock Provider broker.", "operationId": "get-getfundamentals-getstockwisenews", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": false, "example": 10, "in": "query", "name": "pageSize", "required": false, "schema": { "anyOf": [ { "type": "number", "x-data-type": "number" }, { "type": "integer", "x-data-type": "integer" } ], "description": "Number of news items per page (default may vary by broker)", "x-data-type": "union" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "caption": "Reliance Industries Q3FY24 results", "date": "2024-01-31", "heading": "Reliance Q3 Results: Net Profit Rises 11%", "secName": "RELIANCE INDUSTRIES LTD", "sno": 1, "source": "Economic Times", "stockName": "RELIANCE", "symbol": "RELIANCE", "time": "14:32:00", "url": "https://example.com/news/reliance-q3-results" } ], "schema": { "items": { "properties": { "caption": { "type": "string" }, "date": { "type": "string" }, "heading": { "type": "string" }, "secName": { "type": "string" }, "sno": { "type": "integer" }, "source": { "type": "string" }, "stockName": { "type": "string" }, "symbol": { "type": "string" }, "time": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Stock Wise News", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-getfundamentals-getstockwisenews.json" } }, "/getPopup": { "post": { "description": "Retrieves popup notification(s) to be displayed to the user on a standard market trading day. On a regular market day, the response contains the SEBI-mandated Risk Disclosure popup for F\u0026O traders.\n\n\nAlso covers: 4.2 Get Popup — Mock Day", "operationId": "post-getpopup", "parameters": [], "requestBody": { "content": { "application/json": { "examples": { "request-01": { "description": "documented", "summary": "Sample Request (Mock Provider)", "value": { "userId": "XA3637" } }, "request-02": { "description": "documented", "summary": "Sample Request (Mock Provider)", "value": { "userId": "3150494" } } }, "schema": { "anyOf": [ { "properties": { "userId": { "description": "Unique identifier for the user in the broker system.", "type": "string", "x-data-type": "string" } }, "required": [ "userId" ], "type": "object", "x-data-type": "object" }, { "properties": { "userId": { "description": "Unique identifier for the user in the broker system.", "type": "string", "x-data-type": "string" } }, "required": [ "userId" ], "type": "object", "x-data-type": "object" } ], "x-data-type": "union" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "cancelExist": 0, "cancelTitle": "Cancel", "destination": "", "displayType": "mandatory", "message": [ "9 out of 10 individual traders in equity Futures and Options Segment, incurred net losses.", " On an average, loss makers registered net trading loss close to ₹ 50,000.", " Over and above the net trading losses incurred, loss makers expended an additional 28% of net trading losses as transaction costs.", " Those making net trading profits, incurred between 15% to 50% of such profits as transaction cost." ], "messageTitle": "Risk Disclosure on Derivatives", "okExist": 1, "okTitle": "Proceed", "sourceExist": 1, "sourceLink": "https://www.sebi.gov.in/reports-and-statistics/research/jan-2023/study-analysis-of-profit-and-loss-of-individual-traders-dealing-in-equity-fando-segment_67525.html", "sourceMsg": "SEBI study dated January 25, 2023 on Analysis of Profit and Loss of Individual Traders dealing in equity Futures and Options (F\u0026O) Segment...", "ssoLogin": 0, "status": 1, "userType": "all" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "cancelExist": { "type": "integer" }, "cancelTitle": { "type": "string" }, "destination": { "type": "string" }, "displayType": { "type": "string" }, "message": { "items": { "type": "string" }, "type": "array" }, "messageTitle": { "type": "string" }, "okExist": { "type": "integer" }, "okTitle": { "type": "string" }, "sourceExist": { "type": "integer" }, "sourceLink": { "type": "string" }, "sourceMsg": { "type": "string" }, "ssoLogin": { "type": "integer" }, "status": { "type": "integer" }, "userType": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Popup — Market Day", "tags": [ "notification" ], "x-request-schema-file": "schemas/requests/notification/post-getpopup.json" } }, "/getTechnicals/getDeliverableVolume": { "get": { "description": "Retrieve deliverable and traded volume data for a stock across different time periods (daily, week-to-date, month-to-date).", "operationId": "get-gettechnicals-getdeliverablevolume", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "bseToken": "500325", "coCode": "10000", "companyName": "RELIANCE INDUSTRIES LTD", "nseToken": "1594", "totalDeliveryVolumeCurrent": 4250000, "totalDeliveryVolumeMTD": 90000000, "totalDeliveryVolumeWTD": 21000000, "totalTradedVolumeCurrent": 8500000, "totalTradedVolumeMTP": 180000000, "totalTradedVolumeWTD": 42000000 }, "schema": { "properties": { "bseToken": { "type": "string" }, "coCode": { "type": "string" }, "companyName": { "type": "string" }, "nseToken": { "type": "string" }, "totalDeliveryVolumeCurrent": { "type": "integer" }, "totalDeliveryVolumeMTD": { "type": "integer" }, "totalDeliveryVolumeWTD": { "type": "integer" }, "totalTradedVolumeCurrent": { "type": "integer" }, "totalTradedVolumeMTP": { "type": "integer" }, "totalTradedVolumeWTD": { "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Deliverable Volume", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-gettechnicals-getdeliverablevolume.json" } }, "/getTechnicals/getPriceChangeAnalysis": { "get": { "description": "Retrieve price change analysis across multiple time horizons (one week, one month, three months, one year) for a specific stock.", "operationId": "get-gettechnicals-getpricechangeanalysis", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "oneMonth": [], "oneWeek": [ { "close": 2455.75, "coCode": "10000", "duration": "1W", "exch": "NSE", "high": 2480.5, "id": 1, "low": 2390, "open": 2400, "startDate": "2024-01-08", "token": "1594" } ], "oneYear": [], "threeMonth": [] }, "schema": { "properties": { "oneMonth": { "items": {}, "type": "array" }, "oneWeek": { "items": { "properties": { "close": { "type": "number" }, "coCode": { "type": "string" }, "duration": { "type": "string" }, "exch": { "type": "string" }, "high": { "type": "number" }, "id": { "type": "integer" }, "low": { "type": "number" }, "open": { "type": "number" }, "startDate": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "type": "array" }, "oneYear": { "items": {}, "type": "array" }, "threeMonth": { "items": {}, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Price Change Analysis", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-gettechnicals-getpricechangeanalysis.json" } }, "/getTechnicals/getSMAandEMAdata": { "get": { "description": "Retrieve Simple Moving Average (SMA) and Exponential Moving Average (EMA) values for standard time periods (5, 10, 20, 50, 100, 200 days).", "operationId": "get-gettechnicals-getsmaandemadata", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code. Note: Mock Provider uses \"exch\" as the key instead of \"exchange\"", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "coCode": "10000", "ema": [ { "title": "5 Days", "value": "2448.60" } ], "sma": [ { "description": "5-Day Simple Moving Average", "message": "Price is above 5-day SMA", "timeframe": "5D", "title": "5 Days", "value": "2445.20" }, { "title": "10 Days", "value": "2430.50" }, { "title": "20 Days", "value": "2410.75" }, { "title": "50 Days", "value": "2380.00" }, { "title": "100 Days", "value": "2350.25" }, { "title": "200 Days", "value": "2290.80" } ] }, "schema": { "properties": { "coCode": { "type": "string" }, "ema": { "items": { "properties": { "title": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "sma": { "items": { "anyOf": [ { "properties": { "description": { "type": "string" }, "message": { "type": "string" }, "timeframe": { "type": "string" }, "title": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, { "properties": { "title": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } ] }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SMA and EMA Data", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-gettechnicals-getsmaandemadata.json" } }, "/getTechnicals/getSupportAndResistance": { "get": { "description": "Retrieve technical support and resistance levels along with key indicators such as ADX, Williams %R, CCI, MACD, and pivot points.", "operationId": "get-gettechnicals-getsupportandresistance", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "adx": 28.4, "coCode": "10000", "coName": "RELIANCE INDUSTRIES LTD", "commodityChannelIndex": 85.6, "currPrice": 2455.75, "exchange": "NSE", "macd_12_26_days": 12.4, "pivotPoint": 2440, "rone": 2460, "rthree": 2505, "rtwo": 2480, "sone": 2420, "sthree": 2375, "stwo": 2400, "token": "1594", "williamsR": -35.2 }, "schema": { "properties": { "adx": { "type": "number" }, "coCode": { "type": "string" }, "coName": { "type": "string" }, "commodityChannelIndex": { "type": "number" }, "currPrice": { "type": "number" }, "exchange": { "type": "string" }, "macd_12_26_days": { "type": "number" }, "pivotPoint": { "type": "number" }, "rone": { "type": "number" }, "rthree": { "type": "number" }, "rtwo": { "type": "number" }, "sone": { "type": "number" }, "sthree": { "type": "number" }, "stwo": { "type": "number" }, "token": { "type": "string" }, "williamsR": { "type": "number" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Support and Resistance", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-gettechnicals-getsupportandresistance.json" } }, "/market-rest/futures/getfutures": { "get": { "description": "Returns all futures instruments grouped by category (INDEX, NIFTYLIQUID, BANKNIFTY, CURRENCY, COMMODITY), showing the nearest active expiry contract per underlying.", "operationId": "get-market-rest-futures-getfutures", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "futuresList": 1, "futuresName": "INDEX", "scrips": [ { "exchange": "NFO", "expiry": "2026-06-30", "pdc": "23051.2", "scripName": "NIFTY 30th JUN FUT", "sortOrder": 0, "symbol": "NIFTY", "token": "62329" } ] }, { "futuresList": 4, "futuresName": "CURRENCY", "scrips": [ { "exchange": "CDS", "expiry": "2026-05-15", "pdc": "91.34", "scripName": "USDINR 15th MAY FUT", "sortOrder": 0, "symbol": "USDINR", "token": "1027" } ] }, { "futuresList": 5, "futuresName": "COMMODITY", "scrips": [ { "exchange": "MCX", "expiry": "2026-04-20", "pdc": "10408", "scripName": "CRUDEOIL 20th APR FUT", "sortOrder": 0, "symbol": "CRUDEOIL", "token": "486502" } ] } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "futuresList": { "type": "integer" }, "futuresName": { "type": "string" }, "scrips": { "items": { "properties": { "exchange": { "type": "string" }, "expiry": { "type": "string" }, "pdc": { "type": "string" }, "scripName": { "type": "string" }, "sortOrder": { "type": "integer" }, "symbol": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Futures Data", "tags": [ "common-utils" ], "x-request-schema-file": "schemas/requests/common-utils/get-market-rest-futures-getfutures.json" } }, "/market-rest/indices/getindices": { "get": { "description": "Returns the list of market indices available on the platform with their previous-day close values and metadata.", "operationId": "get-market-rest-indices-getindices", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "exchange": "NSE", "expiry": null, "formattedInsName": "NIFTY", "pdc": "22713.1", "sortOrder": 0, "symbol": "NIFTY 50", "token": "26000", "tradingSymbol": "NIFTY" }, { "exchange": "NSE", "expiry": null, "formattedInsName": "INDIA VIX", "pdc": "25.52", "sortOrder": 0, "symbol": "INDIA VIX", "token": "26017", "tradingSymbol": "INDIA VIX" }, { "exchange": "BSE", "expiry": null, "formattedInsName": "SENSEX", "pdc": "0", "sortOrder": 0, "symbol": "SENSEX", "token": "1", "tradingSymbol": "SENSEX" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "exchange": { "type": "string" }, "expiry": { "nullable": true }, "formattedInsName": { "type": "string" }, "pdc": { "type": "string" }, "sortOrder": { "type": "integer" }, "symbol": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Indices", "tags": [ "common-utils" ], "x-request-schema-file": "schemas/requests/common-utils/get-market-rest-indices-getindices.json" } }, "/market-rest/sector/geteqsector": { "get": { "description": "Returns all equity sectors with their constituent scrips and performance metrics. Response structure and available fields differ between Mock Provider and Mock Provider broker integrations — see §4.16.1 for the field-level diff.", "operationId": "get-market-rest-sector-geteqsector", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "scrips": [ { "companyName": "INFOSYS LTD.", "exchange": "NSE", "expiry": null, "pdc": "1419.7", "scripName": "INFY", "sortOrder": 0, "symbol": "INFY", "token": "500209" } ], "sectorList": 5, "sectorName": "IT Industry" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "scrips": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "expiry": { "nullable": true }, "pdc": { "type": "string" }, "scripName": { "type": "string" }, "sortOrder": { "type": "integer" }, "symbol": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "type": "array" }, "sectorList": { "type": "integer" }, "sectorName": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Equity Sectors", "tags": [ "common-utils" ], "x-request-schema-file": "schemas/requests/common-utils/get-market-rest-sector-geteqsector.json" } }, "/market-rest/version/check": { "post": { "description": "Checks whether a newer version of the client application is available for the given platform.", "operationId": "post-market-rest-version-check", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "os": "ANDROID", "version": "1.0.0.42" }, "schema": { "properties": { "os": { "description": "Client operating system. Accepted values: \"ANDROID\", \"IOS\".", "type": "string", "x-data-type": "string" }, "version": { "description": "Current application version string (e.g. \"1.0.0.42\").", "type": "string", "x-data-type": "string" } }, "required": [ "version", "os" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "isUpdateAvailable": 0 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "isUpdateAvailable": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Version Check", "tags": [ "common-utils" ], "x-request-schema-file": "schemas/requests/common-utils/post-market-rest-version-check.json" } }, "/marketWatch/addscrip": { "post": { "description": "Adds one or more tradable scrips into a user's watchlist tab up to the configured scrip limit (default 50 per watchlist). Enriches the response with company metadata, lot size, and tick size.\n\n\n\nEndpoint Details", "operationId": "post-marketwatch-addscrip", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 1, "scripData": [ { "exchange": "NSE", "token": "2885" }, { "exchange": "NSE", "token": "11536" } ] }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to add scrips into.", "type": "integer", "x-data-type": "integer" }, "scripData": { "description": "Array of scrip identifiers to add.", "items": { "properties": { "exchange": { "description": "Exchange of the scrip (e.g., \"NSE\", \"BSE\", \"NFO\").", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange token of the scrip.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } }, "required": [ "mwId", "scripData" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW119", "message": "Symbol already added in market watch", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": { "scrip": [ { "companyName": "RELIANCE INDUSTRIES LTD", "exchange": "NSE", "formattedInsName": "RELIANCE EQ", "lotSize": "1", "sortOrder": 1, "symbol": "RELIANCE", "tickSize": "0.05", "token": "2885", "tradingSymbol": "RELIANCE-EQ" } ] }, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "scrip": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "formattedInsName": { "type": "string" }, "lotSize": { "type": "string" }, "sortOrder": { "type": "integer" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Add Scrip to MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-marketwatch-addscrip.json" } }, "/marketWatch/contract/info": { "post": { "description": "Returns underlying security information, active F\u0026O derivatives (futures \u0026 options series), freeze quantity, MTF leverage, and AMO ordering status for a given scrip identified by exchange and token.\n\n\n\nEndpoint Details", "operationId": "post-marketwatch-contract-info", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "exchange": "NSE", "token": "2885" }, "schema": { "properties": { "exchange": { "description": "Exchange of the underlying scrip (e.g., \"NSE\").", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange token of the underlying scrip.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW111", "message": "Token does not exist", "result": [], "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": [ { "freezeQty": "10000", "isAmoApplicable": true, "isin": "INE002A01018", "scrips": [ { "exchange": "NFO", "expiry": "2026-10-29", "formattedInsName": "RELIANCE 26 OCT 3000 CE", "insType": "OPTSTK", "isFnOAvailable": true, "lotSize": "250", "mtfMargin": "0", "multiplier": "1", "pdc": "45.20", "symbol": "RELIANCE", "tickSize": "0.05", "token": "135678", "tradingSymbol": "RELIANCE26OCT3000CE" } ] } ], "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "items": { "properties": { "freezeQty": { "type": "string" }, "isAmoApplicable": { "type": "boolean" }, "isin": { "type": "string" }, "scrips": { "items": { "properties": { "exchange": { "type": "string" }, "expiry": { "type": "string" }, "formattedInsName": { "type": "string" }, "insType": { "type": "string" }, "isFnOAvailable": { "type": "boolean" }, "lotSize": { "type": "string" }, "mtfMargin": { "type": "string" }, "multiplier": { "type": "string" }, "pdc": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Contract Info \u0026 Option Chain", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-marketwatch-contract-info.json" } }, "/marketWatch/createMW": { "post": { "description": "Creates a new empty watchlist for the authenticated user. Supports up to a configured maximum (default 6, IDs 1–6 or 101–106). Watchlist names cannot exceed 15 characters and reserved names (NIFTY 50, RECENTLYVIEWED, MYSTOCKS, POSITIONS, HOLDINGS) are prohibited.\n\n\n\nEndpoint Details", "operationId": "post-marketwatch-createmw", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwName": "Tech Stocks" }, "schema": { "properties": { "mwName": { "description": "Name for the new watchlist. Maximum 15 characters; reserved names not allowed.", "maxLength": 15, "not": { "enum": [ "NIFTY 50", "RECENTLYVIEWED", "MYSTOCKS", "POSITIONS", "HOLDINGS" ] }, "type": "string", "x-data-type": "string" } }, "required": [ "mwName" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW102", "message": "MarketWatch Name Should Not Exceed 15 Characters", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": { "mwId": 2 }, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "mwId": { "type": "integer" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Create MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-marketwatch-createmw.json" } }, "/marketWatch/deleteMW": { "post": { "description": "Deletes a target user watchlist and purges all scrip mappings contained inside it. This action is irreversible.\n\n\n\nEndpoint Details", "operationId": "post-marketwatch-deletemw", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 2 }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to delete permanently.", "type": "integer", "x-data-type": "integer" } }, "required": [ "mwId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW101", "message": "Invalid market watch id", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Tech Stocks Deleted Successfully", "status": "Ok" } } }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Delete Entire MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-marketwatch-deletemw.json" } }, "/marketWatch/deletescrip": { "post": { "description": "Removes one or more scrips from a watchlist by their exchange and token identifiers.\n\n\n\nEndpoint Details", "operationId": "post-marketwatch-deletescrip", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 1, "scripData": [ { "exchange": "NSE", "token": "2885" } ] }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to remove scrips from.", "type": "integer", "x-data-type": "integer" }, "scripData": { "description": "Array of scrip identifiers to remove.", "items": { "properties": { "exchange": { "description": "Exchange of the scrip.", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange token of the scrip.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } }, "required": [ "mwId", "scripData" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW110", "message": "Scrip not available in market watch", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "RELIANCE-EQ Deleted Successfully", "status": "Ok" } } }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Delete Scrip from MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-marketwatch-deletescrip.json" } }, "/marketWatch/getAllMwScrips": { "get": { "description": "Retrieves all configured watchlists and all enriched scrip contracts for the authenticated user. \n\n\n\nEndpoint Details", "operationId": "get-marketwatch-getallmwscrips", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "code": "0", "message": "Success", "result": [ { "isDefault": false, "isEdit": true, "isRename": true, "mwId": "1", "mwName": "Watchlist 1", "scrips": [ { "companyName": "RELIANCE INDUSTRIES LTD", "exchange": "NSE", "formattedInsName": "RELIANCE EQ", "instrumentType": "EQ", "isin": "INE002A01018", "lotSize": "1", "pdc": "2980.50", "sortOrder": 1, "symbol": "RELIANCE", "tickSize": "0.05", "token": "2885", "tradingSymbol": "RELIANCE-EQ" } ] } ], "status": "Ok" }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "items": { "properties": { "isDefault": { "type": "boolean" }, "isEdit": { "type": "boolean" }, "isRename": { "type": "boolean" }, "mwId": { "type": "string" }, "mwName": { "type": "string" }, "scrips": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "formattedInsName": { "type": "string" }, "instrumentType": { "type": "string" }, "isin": { "type": "string" }, "lotSize": { "type": "string" }, "pdc": { "type": "string" }, "sortOrder": { "type": "integer" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get All MarketWatch Scrips", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/get-marketwatch-getallmwscrips.json" } }, "/marketWatch/getSingleMwScripsDetails": { "post": { "description": "Retrieves comprehensive contract details, corporate action badges, and live parameters for all scrips within one specified watchlist tab.\n\n\n\nEndpoint Details", "operationId": "post-marketwatch-getsinglemwscripsdetails", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 1 }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to retrieve full scrip details for.", "type": "integer", "x-data-type": "integer" } }, "required": [ "mwId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW101", "message": "Invalid market watch id", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": { "isDefault": false, "isEdit": true, "isRename": true, "mwId": "1", "mwName": "Watchlist 1", "scrips": [ { "exchange": "NSE", "instrumentType": "EQ", "isin": "INE002A01018", "lotSize": "1", "pdc": "2980.50", "symbol": "RELIANCE", "tickSize": "0.05", "token": "2885", "tradingSymbol": "RELIANCE-EQ" } ] }, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "isDefault": { "type": "boolean" }, "isEdit": { "type": "boolean" }, "isRename": { "type": "boolean" }, "mwId": { "type": "string" }, "mwName": { "type": "string" }, "scrips": { "items": { "properties": { "exchange": { "type": "string" }, "instrumentType": { "type": "string" }, "isin": { "type": "string" }, "lotSize": { "type": "string" }, "pdc": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Single MarketWatch Scrip Details", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-marketwatch-getsinglemwscripsdetails.json" } }, "/marketWatch/renameMW": { "post": { "description": "Renames an existing user watchlist tab. Both the watchlist ID and new name are validated against character and uniqueness constraints.\n\n\n\nEndpoint Details", "operationId": "post-marketwatch-renamemw", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 2, "mwName": "Bluechips" }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist to rename.", "type": "integer", "x-data-type": "integer" }, "mwName": { "description": "New name for the watchlist. Maximum 15 characters.", "maxLength": 15, "type": "string", "x-data-type": "string" } }, "required": [ "mwId", "mwName" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW111", "message": "Market watch id doesn't exists", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Tech Stocks Renamed to Bluechips Successfully.", "status": "Ok" } } }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Rename MarketWatch", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-marketwatch-renamemw.json" } }, "/marketWatch/sortMwScrips": { "post": { "description": "Updates the positional display ordering of scrips inside a specific watchlist. All scrips in the watchlist must be provided with sequential sort orders in a single call.\n\n\n\nEndpoint Details", "operationId": "post-marketwatch-sortmwscrips", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mwId": 1, "scripData": [ { "exchange": "NSE", "sortingOrder": 1, "token": "11536" }, { "exchange": "NSE", "sortingOrder": 2, "token": "2885" } ] }, "schema": { "properties": { "mwId": { "description": "ID of the watchlist whose scrip order is being updated.", "type": "integer", "x-data-type": "integer" }, "scripData": { "description": "Array of all scrips with their new sort positions.", "items": { "properties": { "exchange": { "description": "Exchange of the scrip (e.g., \"NSE\", \"BSE\").", "type": "string", "x-data-type": "string" }, "sortingOrder": { "description": "New 1-based sort position for the scrip.", "minimum": 1, "type": "integer", "x-data-type": "integer" }, "token": { "description": "Exchange token of the scrip.", "type": "string", "x-data-type": "string" } }, "required": [ "token", "exchange", "sortingOrder" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } }, "required": [ "mwId", "scripData" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW113", "message": "Sorting scrip count does not match watchlist scrip count", "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Sorting order saved successfully", "status": "Ok" } } }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Sort MarketWatch Scrips", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-marketwatch-sortmwscrips.json" } }, "/marketWatch/trending/recent/search": { "get": { "description": "Retrieves the top trending traded instruments and recently searched scrips across the application platform. \n\n\n\nEndpoint Details", "operationId": "get-marketwatch-trending-recent-search", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "code": "0", "message": "Success", "result": [ { "companyName": "RELIANCE INDUSTRIES LTD", "exchange": "NSE", "pdc": "2980.50", "symbol": "RELIANCE", "token": "2885", "tradingSymbol": "RELIANCE-EQ" }, { "companyName": "TATA CONSULTANCY SERV LT", "exchange": "NSE", "pdc": "4250.00", "symbol": "TCS", "token": "11536", "tradingSymbol": "TCS-EQ" } ], "status": "Ok" }, "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "pdc": { "type": "string" }, "symbol": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Trending \u0026 Recent Search", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/get-marketwatch-trending-recent-search.json" } }, "/newbrokerage/newCalculation": { "post": { "description": "", "operationId": "post-newbrokerage-newcalculation", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "instrumentType": "EQ", "lotSize": "1", "plan": "T-pro", "price": "434.6", "qty": "1", "segment": "nse", "symbol": "DYCL", "token": "10417", "transactionType": "buy", "type": "delivery", "user": "AP010S14" }, "schema": { "properties": { "instrumentType": { "description": "Instrument category. E.g., \"EQ\" (equity), \"FUT\" (futures), \"OPT\" (options).", "type": "string", "x-data-type": "string" }, "lotSize": { "description": "Lot size of the instrument. Use \"1\" for equity; F\u0026O instruments may have larger lot sizes.", "type": "string", "x-data-type": "string" }, "plan": { "description": "Client's brokerage plan code (e.g., \"T-pro\"). Determines the applicable brokerage rate.", "type": "string", "x-data-type": "string" }, "price": { "description": "Price per unit in INR.", "type": "string", "x-data-type": "string" }, "qty": { "description": "Order quantity (number of shares or lots).", "type": "string", "x-data-type": "string" }, "segment": { "description": "Market segment. Accepted values: \"nse\", \"bse\". Determines the applicable exchange transaction charge rate.", "type": "string", "x-data-type": "string" }, "symbol": { "description": "Trading symbol of the instrument (e.g., \"DYCL\").", "type": "string", "x-data-type": "string" }, "token": { "description": "Instrument token — unique identifier for the traded instrument.", "type": "string", "x-data-type": "string" }, "transactionType": { "description": "Direction of the trade. Accepted values: \"buy\", \"sell\".", "type": "string", "x-data-type": "string" }, "type": { "description": "Product type. Accepted values: \"delivery\" (CNC), \"intraday\" (MIS). Affects STT rate and brokerage calculation.", "type": "string", "x-data-type": "string" }, "user": { "description": "Client user ID. Used to identify the client's brokerage plan and applicable rate.", "type": "string", "x-data-type": "string" } }, "required": [ "user", "qty", "price", "token", "lotSize", "plan", "segment", "type", "instrumentType", "transactionType", "symbol" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "brokerage": "1.3038", "cmCharges": "0.0000", "gst": "0.2373", "ipft": "0.0004", "sebi": "0.0004", "stampCharges": "0.0652", "stt": "0.4346", "total": "2.0559", "transactionCharge": "0.0141", "turnOver": "434.6000" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "brokerage": { "type": "string" }, "cmCharges": { "type": "string" }, "gst": { "type": "string" }, "ipft": { "type": "string" }, "sebi": { "type": "string" }, "stampCharges": { "type": "string" }, "stt": { "type": "string" }, "total": { "type": "string" }, "transactionCharge": { "type": "string" }, "turnOver": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Calculate eBrokerage", "tags": [ "brokerage" ], "x-request-schema-file": "schemas/requests/brokerage/post-newbrokerage-newcalculation.json" } }, "/nse/order/cancelOrders": { "post": { "description": "Cancels an existing IPO bid that has been previously placed. The cancellation requires the application number and bid reference number. On success, the order status transitions to \"Cancelled\" and the bid array is cleared.\n\n\n\nEndpoint Details", "operationId": "post-nse-order-cancelorders", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "applicationNumber": "800110563", "bids": [ { "activityType": "cancel", "amount": "14973.0", "atCutOff": "true", "bidReferenceNumber": "2026091800709245", "price": "93.00", "quantity": "161", "remark": "IPO CANCEL" } ], "category": "IND", "chequeAmount": "14973.00", "exchange": "NSE", "status": "Applied", "symbol": "JSIPL", "timestamp": "18-09-2026 10:12:40", "upi": "" }, "schema": { "properties": { "applicationNumber": { "description": "Application number from the original order (from getOrderBook).", "type": "string", "x-data-type": "string" }, "bids": { "description": "Array of bid cancellation objects (one per bid leg to cancel).", "items": { "properties": { "activityType": { "description": "Must be \"cancel\" for a cancellation request.", "type": "string", "x-data-type": "string" }, "amount": { "description": "Original bid amount in INR.", "type": "string", "x-data-type": "string" }, "atCutOff": { "description": "\"true\" if the original bid was at cut-off price; \"false\" otherwise.", "type": "string", "x-data-type": "string" }, "bidReferenceNumber": { "description": "Bid reference number from the original placement (bidId from getOrderBook).", "type": "string", "x-data-type": "string" }, "price": { "description": "Original bid price per share.", "type": "string", "x-data-type": "string" }, "quantity": { "description": "Quantity of shares in the original bid.", "type": "string", "x-data-type": "string" }, "remark": { "description": "Reason or remark for cancellation (e.g., \"IPO CANCEL\").", "type": "string", "x-data-type": "string" } }, "required": [ "activityType", "bidReferenceNumber", "quantity", "atCutOff", "price", "amount" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" }, "category": { "description": "Investor category of the original order (e.g., \"IND\").", "type": "string", "x-data-type": "string" }, "chequeAmount": { "description": "Total bid amount of the original order in INR.", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange of the original order: \"NSE\" or \"BSE\".", "type": "string", "x-data-type": "string" }, "status": { "description": "Current status of the order being cancelled (e.g., \"Applied\").", "type": "string", "x-data-type": "string" }, "symbol": { "description": "Exchange trading symbol of the IPO to cancel.", "type": "string", "x-data-type": "string" }, "timestamp": { "description": "Cancellation timestamp in format DD-MM-YYYY HH:mm:ss.", "format": "date-time-dd-mm-yyyy", "type": "string", "x-data-type": "date-time-dd-mm-yyyy" }, "upi": { "description": "UPI ID if the original bid used UPI; empty string otherwise.", "type": "string", "x-data-type": "string" } }, "required": [ "symbol", "exchange", "applicationNumber", "chequeAmount", "category", "timestamp", "status", "bids" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "allotmentMode": "demat", "applicationNumber": "800110563", "bids": [], "category": "IND", "clientBenId": "", "clientName": "", "depository": "CDSL", "dpVerFailCode": "", "dpVerReason": "", "dpVerStatusFlag": "S", "nonASBA": false, "status": "success", "symbol": "JSIPL", "timestamp": "18-09-2026 10:14:03", "upiFlag": "Y" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "allotmentMode": { "type": "string" }, "applicationNumber": { "type": "string" }, "bids": { "items": {}, "type": "array" }, "category": { "type": "string" }, "clientBenId": { "type": "string" }, "clientName": { "type": "string" }, "depository": { "type": "string" }, "dpVerFailCode": { "type": "string" }, "dpVerReason": { "type": "string" }, "dpVerStatusFlag": { "type": "string" }, "nonASBA": { "type": "boolean" }, "status": { "type": "string" }, "symbol": { "type": "string" }, "timestamp": { "type": "string" }, "upiFlag": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Cancel IPO Order", "tags": [ "ipo" ], "x-request-schema-file": "schemas/requests/ipo/post-nse-order-cancelorders.json" } }, "/nse/order/getOrderBook": { "get": { "description": "Retrieves the complete IPO order history for the authenticated user, including both active (Applied) and closed (Cancelled) orders across NSE and BSE. Results are returned in reverse chronological order.\n\n\n\nEndpoint Details", "operationId": "get-nse-order-getorderbook", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "activeStatus": 1, "allotmentMode": "demat", "applicationNo": "800111315", "bids": [ { "actionCode": "new", "amount": "14952.0", "bidId": "2026091800627651", "cutOff": "true", "errorCode": "", "exchange": "NSE", "message": "success", "orderId": 4956, "qty": "178", "rate": "999999.99", "series": "" } ], "category": "IND", "chequeAmount": "14952.00", "clientBenfId": "1206970000043210", "clientName": "KHATIJTULKUBRA MOASLAM SHAIKH", "closeDate": "2026-09-18", "createdOn": "2026-09-18 10:10:37", "depository": "CDSL", "dpVerStatusFlag": "P", "exchType": "NSE", "exchange": "NSE", "id": 5092, "nonASBA": "false", "openDate": "2026-09-16", "orderId": 4956, "reason": "Your Order has been Applied Successfully.", "statusMessage": "Applied", "symbol": "HEROMOTORS", "timestamp": "2026-09-18 10:10:35", "updatedOn": "2026-09-18 10:10:37", "upiFlag": "Y", "userId": "AHM118" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "activeStatus": { "type": "integer" }, "allotmentMode": { "type": "string" }, "applicationNo": { "type": "string" }, "bids": { "items": { "properties": { "actionCode": { "type": "string" }, "amount": { "type": "string" }, "bidId": { "type": "string" }, "cutOff": { "type": "string" }, "errorCode": { "type": "string" }, "exchange": { "type": "string" }, "message": { "type": "string" }, "orderId": { "type": "integer" }, "qty": { "type": "string" }, "rate": { "type": "string" }, "series": { "type": "string" } }, "type": "object" }, "type": "array" }, "category": { "type": "string" }, "chequeAmount": { "type": "string" }, "clientBenfId": { "type": "string" }, "clientName": { "type": "string" }, "closeDate": { "type": "string" }, "createdOn": { "type": "string" }, "depository": { "type": "string" }, "dpVerStatusFlag": { "type": "string" }, "exchType": { "type": "string" }, "exchange": { "type": "string" }, "id": { "type": "integer" }, "nonASBA": { "type": "string" }, "openDate": { "type": "string" }, "orderId": { "type": "integer" }, "reason": { "type": "string" }, "statusMessage": { "type": "string" }, "symbol": { "type": "string" }, "timestamp": { "type": "string" }, "updatedOn": { "type": "string" }, "upiFlag": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get IPO Order Book", "tags": [ "ipo" ], "x-request-schema-file": "schemas/requests/ipo/get-nse-order-getorderbook.json" } }, "/nse/order/openOrders": { "get": { "description": "Returns the list of currently open IPO offerings available for bidding. Each entry includes issue details, price bands, lot sizes, category settings, and subcategory bidding constraints for NSE and BSE.\n\n\n\nEndpoint Details", "operationId": "get-nse-order-openorders", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "biddingEndDate": "18-09-2026", "biddingStartDate": "16-09-2026", "categoryDetails": [ { "code": "QIB", "endTime": "17:00:00", "startTime": "10:00:00" }, { "code": "NIB", "endTime": "17:00:00", "startTime": "10:00:00" }, { "code": "RETAIL", "endTime": "17:00:00", "startTime": "10:00:00" } ], "cutOffPrice": 84, "exchange": "NSE", "faceValue": 10, "ipoType": "Mainboard", "isin": "INE012G01022", "issueSize": "1000.0", "issueType": "EQUITY", "lotSize": 178, "maxPrice": 84, "minBidQuantity": 178, "minPrice": 79, "name": "Hero Motors Limited", "registrar": "KARVY", "subCategorySettings": [ { "allowCutOff": true, "allowUpi": true, "caCode": "RETAIL", "discountPrice": null, "discountType": "", "maxLots": 13, "maxQuantity": null, "maxUpiLimit": 200000, "maxValue": 194376, "minLots": 1, "minValue": 14062, "subCatCode": "IND" } ], "subType": "EQ", "symbol": "HEROMOTORS", "tickSize": 1 } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "biddingEndDate": { "type": "string" }, "biddingStartDate": { "type": "string" }, "categoryDetails": { "items": { "properties": { "code": { "type": "string" }, "endTime": { "type": "string" }, "startTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "cutOffPrice": { "type": "number" }, "exchange": { "type": "string" }, "faceValue": { "type": "number" }, "ipoType": { "type": "string" }, "isin": { "type": "string" }, "issueSize": { "type": "string" }, "issueType": { "type": "string" }, "lotSize": { "type": "integer" }, "maxPrice": { "type": "number" }, "minBidQuantity": { "type": "integer" }, "minPrice": { "type": "number" }, "name": { "type": "string" }, "registrar": { "type": "string" }, "subCategorySettings": { "items": { "properties": { "allowCutOff": { "type": "boolean" }, "allowUpi": { "type": "boolean" }, "caCode": { "type": "string" }, "discountPrice": { "nullable": true }, "discountType": { "type": "string" }, "maxLots": { "type": "number" }, "maxQuantity": { "nullable": true }, "maxUpiLimit": { "type": "number" }, "maxValue": { "type": "number" }, "minLots": { "type": "number" }, "minValue": { "type": "number" }, "subCatCode": { "type": "string" } }, "type": "object" }, "type": "array" }, "subType": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "number" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Open IPO Orders", "tags": [ "ipo" ], "x-request-schema-file": "schemas/requests/ipo/get-nse-order-openorders.json" } }, "/nse/order/placeOrders": { "post": { "description": "Submits a new IPO bid for a specified symbol on either NSE or BSE. The bid can be placed at a specific price or at the cut-off price. Returns bid confirmation details including the bid reference number.\n\n\n\nEndpoint Details", "operationId": "post-nse-order-placeorders", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "bids": [ { "activityType": "new", "amount": "84.0", "atCutOff": true, "price": "84.0", "quantity": "178", "remark": null } ], "category": "IND", "chequeAmount": "14952.00", "closeDateTime": "18-09-2026", "exchange": "NSE", "openDateTime": "16-09-2026", "preApply": false, "symbol": "HEROMOTORS", "timestamp": "18-09-2026 10:10:34", "upi": "" }, "schema": { "properties": { "bids": { "description": "Array of bid objects. Typically one bid per request.", "items": { "properties": { "activityType": { "description": "Bid action type. Use \"new\" for a fresh bid.", "type": "string", "x-data-type": "string" }, "amount": { "description": "Total bid amount for this bid leg (quantity × price).", "type": "string", "x-data-type": "string" }, "atCutOff": { "description": "Whether the bid is placed at cut-off price.", "type": "boolean", "x-data-type": "boolean" }, "price": { "description": "Bid price per share in INR; use cut-off price if atCutOff is true.", "type": "string", "x-data-type": "string" }, "quantity": { "description": "Number of shares to bid (must be a valid lot multiple).", "type": "string", "x-data-type": "string" }, "remark": { "description": "Optional remark or note for the bid.", "nullable": true, "type": "string", "x-data-type": "string" } }, "required": [ "quantity", "price", "atCutOff", "amount", "activityType" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" }, "category": { "description": "Investor category code (e.g., \"IND\" for individual retail).", "type": "string", "x-data-type": "string" }, "chequeAmount": { "description": "Total bid amount in INR as a string (e.g., \"14952.00\").", "type": "string", "x-data-type": "string" }, "closeDateTime": { "description": "IPO bidding close date in format DD-MM-YYYY.", "format": "date-dd-mm-yyyy", "type": "string", "x-data-type": "date-dd-mm-yyyy" }, "exchange": { "description": "Exchange where the IPO is listed: \"NSE\" or \"BSE\".", "type": "string", "x-data-type": "string" }, "openDateTime": { "description": "IPO bidding open date in format DD-MM-YYYY.", "format": "date-dd-mm-yyyy", "type": "string", "x-data-type": "date-dd-mm-yyyy" }, "preApply": { "description": "Whether this is a pre-apply bid. Defaults to false.", "type": "boolean", "x-data-type": "boolean" }, "symbol": { "description": "Exchange trading symbol of the IPO (e.g., \"HEROMOTORS\").", "type": "string", "x-data-type": "string" }, "timestamp": { "description": "Order placement timestamp in format DD-MM-YYYY HH:mm:ss.", "format": "date-time-dd-mm-yyyy", "type": "string", "x-data-type": "date-time-dd-mm-yyyy" }, "upi": { "description": "UPI ID for payment; empty string if not using UPI.", "type": "string", "x-data-type": "string" } }, "required": [ "symbol", "exchange", "category", "timestamp", "chequeAmount", "openDateTime", "closeDateTime", "bids" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "allotmentMode": "demat", "applicationNumber": "", "bids": [ { "activityType": "new", "amount": 14952, "atCutOff": true, "bidReferenceNumber": 2026091800627651, "price": 999999.99, "quantity": 178, "remark": "", "series": "", "status": "success" } ], "category": "IND", "clientBenId": "", "clientName": "", "depository": "CDSL", "dpVerStatusFlag": "P", "nonASBA": false, "status": "success", "symbol": "HEROMOTORS", "timestamp": "18-09-2026 10:10:35", "upiFlag": "Y" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "allotmentMode": { "type": "string" }, "applicationNumber": { "type": "string" }, "bids": { "items": { "properties": { "activityType": { "type": "string" }, "amount": { "type": "number" }, "atCutOff": { "type": "boolean" }, "bidReferenceNumber": { "type": "integer" }, "price": { "type": "number" }, "quantity": { "type": "integer" }, "remark": { "type": "string" }, "series": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" }, "category": { "type": "string" }, "clientBenId": { "type": "string" }, "clientName": { "type": "string" }, "depository": { "type": "string" }, "dpVerStatusFlag": { "type": "string" }, "nonASBA": { "type": "boolean" }, "status": { "type": "string" }, "symbol": { "type": "string" }, "timestamp": { "type": "string" }, "upiFlag": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Place IPO Order", "tags": [ "ipo" ], "x-request-schema-file": "schemas/requests/ipo/post-nse-order-placeorders.json" } }, "/optionChain/getChainData": { "get": { "description": "Retrieve the full option chain for a specific underlying and expiry date, grouped by strike price. Each strike contains a CE (Call) and PE (Put) sub-object with live market data. Mock Provider and Mock Provider additionally return option greeks (delta, gamma, theta, vega, rho, and implied volatility) for each leg.", "operationId": "get-optionchain-getchaindata", "parameters": [ { "allowEmptyValue": true, "example": "NIFTY", "in": "query", "name": "underlying", "required": true, "schema": { "description": "Underlying instrument symbol (e.g., NIFTY, BANKNIFTY, RELIANCE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": false, "example": "07APR26", "in": "query", "name": "expiry", "required": true, "schema": { "description": "Expiry date in DDMMMYY format (e.g., 07APR26, 28APR26)", "format": "date-ddmmmyy", "type": "string", "x-data-type": "date-ddmmmyy" } }, { "allowEmptyValue": true, "example": 10, "in": "query", "name": "interval", "required": true, "schema": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Strike interval for grouping. Sent as a Number by Mock Provider, Mock Provider, Mock Provider, and Mock Provider; sent as a String by Mock Provider (e.g., \"10\")", "x-data-type": "union" } }, { "allowEmptyValue": true, "example": "nse_fo", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange segment (e.g., nse_fo)", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "data": [ { "CE": { "delta": "0.841647", "forInsName": "NIFTY 7th APR 22500 CE", "gamma": "0.00050244", "gval": "0", "iv": "0.400083722710899", "ltp": "512.0", "oi": "1633580.0", "pdc": "388.2", "pdoi": "2307305", "rho": "0.5156", "theta": "-60.9554", "token": "40732", "tradingsymbol": "NIFTY07APR26C22500", "vega": "2.9054" }, "PE": { "delta": "-0.173600", "forInsName": "NIFTY 7th APR 22500 PE", "gamma": "0.00049988", "gval": "0", "iv": "0.4267505383833786", "ltp": "48.35", "oi": "8933925.0", "pdc": "200.25", "pdoi": "4137380", "rho": "-0.1106", "theta": "-65.1805", "token": "40735", "tradingsymbol": "NIFTY07APR26P22500", "vega": "3.0832" }, "strikeprice": "22500" } ], "exchange": "nse_fo", "futLTP": "23050.2", "futToken": "66691", "lotsize": "65", "pcr": "0.82", "segment": "nse_idx", "spotLTP": "22968.25", "spotToken": "26000", "ticksize": "0.05" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "data": { "items": { "properties": { "CE": { "properties": { "delta": { "type": "string" }, "forInsName": { "type": "string" }, "gamma": { "type": "string" }, "gval": { "type": "string" }, "iv": { "type": "string" }, "ltp": { "type": "string" }, "oi": { "type": "string" }, "pdc": { "type": "string" }, "pdoi": { "type": "string" }, "rho": { "type": "string" }, "theta": { "type": "string" }, "token": { "type": "string" }, "tradingsymbol": { "type": "string" }, "vega": { "type": "string" } }, "type": "object" }, "PE": { "properties": { "delta": { "type": "string" }, "forInsName": { "type": "string" }, "gamma": { "type": "string" }, "gval": { "type": "string" }, "iv": { "type": "string" }, "ltp": { "type": "string" }, "oi": { "type": "string" }, "pdc": { "type": "string" }, "pdoi": { "type": "string" }, "rho": { "type": "string" }, "theta": { "type": "string" }, "token": { "type": "string" }, "tradingsymbol": { "type": "string" }, "vega": { "type": "string" } }, "type": "object" }, "strikeprice": { "type": "string" } }, "type": "object" }, "type": "array" }, "exchange": { "type": "string" }, "futLTP": { "type": "string" }, "futToken": { "type": "string" }, "lotsize": { "type": "string" }, "pcr": { "type": "string" }, "segment": { "type": "string" }, "spotLTP": { "type": "string" }, "spotToken": { "type": "string" }, "ticksize": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Option Chain", "tags": [ "options-chain" ], "x-request-schema-file": "schemas/requests/options-chain/get-optionchain-getchaindata.json" } }, "/optionChain/getExpiryDates": { "get": { "description": "Retrieve the list of available expiry dates for a specific underlying instrument. The depth and range of expiry dates returned varies by broker — Mock Provider returns the longest forward-dated list including quarterly and annual expiries.", "operationId": "get-optionchain-getexpirydates", "parameters": [ { "allowEmptyValue": true, "example": "NIFTY", "in": "query", "name": "underlying", "required": true, "schema": { "description": "Underlying instrument symbol (e.g., NIFTY, RELIANCE, ABB)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "nse_fo", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange segment (e.g., nse_fo)", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "underlying": "NIFTY", "underlying_expiry": [ "07APR26", "13APR26", "21APR26", "28APR26", "05MAY26", "26MAY26", "29SEP26", "29DEC26", "30MAR27", "29JUN27", "28DEC27" ] } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "underlying": { "type": "string" }, "underlying_expiry": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Expiry Dates", "tags": [ "options-chain" ], "x-request-schema-file": "schemas/requests/options-chain/get-optionchain-getexpirydates.json" } }, "/optionChain/getUnderlyings": { "get": { "description": "Retrieve the full list of underlying instruments available for F\u0026O trading on a given exchange segment. The list includes index instruments (NIFTY, BANKNIFTY, etc.) and all F\u0026O-eligible stock symbols. Mock Provider, Mock Provider, and Mock Provider return the most comprehensive list; Mock Provider and Mock Provider return a subset.", "operationId": "get-optionchain-getunderlyings", "parameters": [ { "allowEmptyValue": true, "example": "nse_fo", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange segment (e.g., nse_fo)", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "list_underlying": [ "NIFTY", "BANKNIFTY", "FINNIFTY", "MIDCPNIFTY", "NIFTYNXT50", "ABB", "ABCAPITAL", "ADANIENT", "ADANIPORTS", "AXISBANK", "BAJFINANCE", "BHARTIARTL", "HDFCBANK", "ICICIBANK", "INFY", "ITC", "KOTAKBANK", "LT", "RELIANCE", "SBIN", "TCS", "TATASTEEL", "WIPRO" ] } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "list_underlying": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Underlying List", "tags": [ "options-chain" ], "x-request-schema-file": "schemas/requests/options-chain/get-optionchain-getunderlyings.json" } }, "/po-rest/positions": { "get": { "description": "GET /po-rest/positions\n\nReturns all positions for the authenticated client across exchanges and product types, with quantities, prices and P\u0026L in one canonical schema.", "operationId": "get-po-rest-positions", "parameters": [ { "allowEmptyValue": true, "example": "NET", "in": "query", "name": "ret", "required": false, "schema": { "description": "Position filter. \"NET\" (default) returns net positions. Replaces the former Position Ret API. Other values to be confirmed", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "blQty": null, "breakevenPrice": "0.0", "buyPrice": "10.7", "buyQty": "65", "dayBuyPrice": null, "dayBuyQty": null, "dayBuyValue": null, "daySellPrice": null, "daySellQty": null, "daySellValue": null, "displayName": "NIFTY 7th APR 21500 PE", "exchange": "NFO", "exchangeSeg": null, "expiry": null, "instrumentType": null, "lotSize": "65", "ltp": "11.05", "mtm": null, "mtmBuyPrice": "10.7", "mtmSellPrice": "29.5", "multiplier": "1", "netAvgPrice": "0.0", "netQty": "0", "optionType": null, "orderType": "Regular", "overnightPrice": "53.25", "overnightQty": "-65", "pdc": "29.5", "pnlLotSize": "65", "pnlMultiplier": null, "product": "NRML", "realizedPnl": "1222.0", "ret": null, "sellPrice": "53.25", "sellQty": "65", "strikePrice": null, "symbol": null, "tickSize": "0.05", "token": "40679", "tradingSymbol": "NIFTY07APR26P21500", "unrealizedPnl": "0.00" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "blQty": { "nullable": true }, "breakevenPrice": { "type": "string" }, "buyPrice": { "type": "string" }, "buyQty": { "type": "string" }, "dayBuyPrice": { "nullable": true }, "dayBuyQty": { "nullable": true }, "dayBuyValue": { "nullable": true }, "daySellPrice": { "nullable": true }, "daySellQty": { "nullable": true }, "daySellValue": { "nullable": true }, "displayName": { "type": "string" }, "exchange": { "type": "string" }, "exchangeSeg": { "nullable": true }, "expiry": { "nullable": true }, "instrumentType": { "nullable": true }, "lotSize": { "type": "string" }, "ltp": { "type": "string" }, "mtm": { "nullable": true }, "mtmBuyPrice": { "type": "string" }, "mtmSellPrice": { "type": "string" }, "multiplier": { "type": "string" }, "netAvgPrice": { "type": "string" }, "netQty": { "type": "string" }, "optionType": { "nullable": true }, "orderType": { "type": "string" }, "overnightPrice": { "type": "string" }, "overnightQty": { "type": "string" }, "pdc": { "type": "string" }, "pnlLotSize": { "type": "string" }, "pnlMultiplier": { "nullable": true }, "product": { "type": "string" }, "realizedPnl": { "type": "string" }, "ret": { "nullable": true }, "sellPrice": { "type": "string" }, "sellQty": { "type": "string" }, "strikePrice": { "nullable": true }, "symbol": { "nullable": true }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "unrealizedPnl": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Positions", "tags": [ "positions" ], "x-request-schema-file": "schemas/requests/positions/get-po-rest-positions.json" } }, "/po-rest/positions/conversion": { "post": { "description": "POST /po-rest/positions/conversion\n\nConverts an open position from one product type to another (e.g., MIS → NRML for overnight carry, or MIS → CNC for delivery). The conversion is applied to the specified quantity only.", "operationId": "post-po-rest-positions-conversion", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exchange": "NSE", "orderSource": "WEB", "posType": "DAY", "prevProduct": "MIS", "product": "CNC", "qty": "1", "token": "11536", "tradingSymbol": "TCS-EQ", "transType": "B" }, "schema": { "properties": { "exchange": { "description": "Exchange — NSE, BSE, NFO, MCX", "type": "string", "x-data-type": "string" }, "orderSource": { "description": "Source platform — MOB, WEB", "type": "string", "x-data-type": "string" }, "posType": { "description": "Position type — DAY", "type": "string", "x-data-type": "string" }, "prevProduct": { "description": "Current product — CNC, MIS, NRML", "type": "string", "x-data-type": "string" }, "product": { "description": "Target product — CNC, MIS, NRML", "type": "string", "x-data-type": "string" }, "qty": { "description": "Quantity to convert", "type": "string", "x-data-type": "string" }, "token": { "description": "Instrument token", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol", "type": "string", "x-data-type": "string" }, "transType": { "description": "Side of the open position — B (Buy) or S (Sell)", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token", "tradingSymbol", "qty", "transType", "posType", "prevProduct", "product", "orderSource" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "code": null, "message": "Position Conversion Successful", "orderId": null, "posflag": "true", "rmsStatus": "OK", "stat": "Ok" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "code": { "nullable": true }, "message": { "type": "string" }, "orderId": { "nullable": true }, "posflag": { "type": "string" }, "rmsStatus": { "type": "string" }, "stat": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Position Conversion", "tags": [ "positions" ], "x-request-schema-file": "schemas/requests/positions/post-po-rest-positions-conversion.json" } }, "/po-rest/positions/mtf": { "get": { "description": "GET /po-rest/positions/mtf\n\nReturns Margin Trading Facility (MTF) positions with a holding-level quantity breakdown (pledged, collateral, sellable and authorised quantities) and instrument details per exchange.", "operationId": "get-po-rest-positions-mtf", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "auth": true, "holdings": [ { "authFlag": false, "authQty": "0", "benQty": null, "brkCollQty": null, "btstQty": null, "buyPrice": "1158.00", "collateralQty": null, "dpQty": null, "freeQty": "100", "holdQty": null, "instruments": [ { "exchange": "NSE", "ltp": "1144.60", "pdc": "1144.6", "token": "625", "tradingSymbol": "ABREL-EQ" } ], "isin": "INE055A01016", "netPnl": "13.40", "netQty": "100", "poolPledgeQty": "0", "product": "MTF", "realizedPnl": "13.40", "sellAmount": null, "sellableQty": "100", "tradedQty": null, "unpledgedQty": "0", "unrealizedPnl": "0.00", "usedQty": null } ], "poa": false } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "auth": { "type": "boolean" }, "holdings": { "items": { "properties": { "authFlag": { "type": "boolean" }, "authQty": { "type": "string" }, "benQty": { "nullable": true }, "brkCollQty": { "nullable": true }, "btstQty": { "nullable": true }, "buyPrice": { "type": "string" }, "collateralQty": { "nullable": true }, "dpQty": { "nullable": true }, "freeQty": { "type": "string" }, "holdQty": { "nullable": true }, "instruments": { "items": { "properties": { "exchange": { "type": "string" }, "ltp": { "type": "string" }, "pdc": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" }, "isin": { "type": "string" }, "netPnl": { "type": "string" }, "netQty": { "type": "string" }, "poolPledgeQty": { "type": "string" }, "product": { "type": "string" }, "realizedPnl": { "type": "string" }, "sellAmount": { "nullable": true }, "sellableQty": { "type": "string" }, "tradedQty": { "nullable": true }, "unpledgedQty": { "type": "string" }, "unrealizedPnl": { "type": "string" }, "usedQty": { "nullable": true } }, "type": "object" }, "type": "array" }, "poa": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get MTF Positions", "tags": [ "positions" ], "x-request-schema-file": "schemas/requests/positions/get-po-rest-positions-mtf.json" } }, "/poa/getPoaDetails": { "post": { "description": "Returns the Power of Attorney (POA) status for the specified client.", "operationId": "post-poa-getpoadetails", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "userId": "1114211" }, "schema": { "properties": { "userId": { "description": "User ID to check POA status for", "type": "string", "x-data-type": "string" } }, "required": [ "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "poaStatus": "N" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "poaStatus": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get POA Details", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-poa-getpoadetails.json" } }, "/portfolio/v2/holdings": { "get": { "description": "Retrieves the client's demat holdings across scrips, including quantities held/pledged/withheld, realized and unrealized P\u0026L, and per-exchange instrument details.", "operationId": "get-portfolio-v2-holdings", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": null, "result": [ { "auth": null, "holdings": [ { "amoAuthQty": null, "authFlag": null, "authQty": null, "authorizedQuantity": null, "averageTradedPrice": null, "benQty": null, "brkCollQty": null, "bseInstrumentId": null, "bseTradingSymbol": null, "btstQty": null, "buyPrice": null, "collateralQty": null, "collateralQuantity": null, "collateralType": null, "dpQty": null, "dpQuantity": null, "formattedInstrumentName": null, "freeQty": null, "haircut": null, "holdQty": null, "isAmoAuth": null, "isin": null, "netPnl": null, "netQty": null, "nseInstrumentId": null, "nseTradingSymbol": null, "poolpledgeQty": null, "previousDayClose": null, "product": null, "realizedPnl": null, "sellAmount": null, "sellableQty": null, "symbol": [ { "exchange": null, "exchangeSeg": null, "ltp": null, "pdc": null, "token": null, "tradingSymbol": null } ], "t1Quantity": null, "totalQuantity": null, "tradedQty": null, "unpledgedQty": null, "unrealizedPnl": null, "usedQty": null, "withheldCollateralQty": null, "withheldHoldingsQty": null } ], "poa": null, "product": null } ], "status": null }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "nullable": true }, "result": { "items": { "properties": { "auth": { "nullable": true }, "holdings": { "items": { "properties": { "amoAuthQty": { "nullable": true }, "authFlag": { "nullable": true }, "authQty": { "nullable": true }, "authorizedQuantity": { "nullable": true }, "averageTradedPrice": { "nullable": true }, "benQty": { "nullable": true }, "brkCollQty": { "nullable": true }, "bseInstrumentId": { "nullable": true }, "bseTradingSymbol": { "nullable": true }, "btstQty": { "nullable": true }, "buyPrice": { "nullable": true }, "collateralQty": { "nullable": true }, "collateralQuantity": { "nullable": true }, "collateralType": { "nullable": true }, "dpQty": { "nullable": true }, "dpQuantity": { "nullable": true }, "formattedInstrumentName": { "nullable": true }, "freeQty": { "nullable": true }, "haircut": { "nullable": true }, "holdQty": { "nullable": true }, "isAmoAuth": { "nullable": true }, "isin": { "nullable": true }, "netPnl": { "nullable": true }, "netQty": { "nullable": true }, "nseInstrumentId": { "nullable": true }, "nseTradingSymbol": { "nullable": true }, "poolpledgeQty": { "nullable": true }, "previousDayClose": { "nullable": true }, "product": { "nullable": true }, "realizedPnl": { "nullable": true }, "sellAmount": { "nullable": true }, "sellableQty": { "nullable": true }, "symbol": { "items": { "properties": { "exchange": { "nullable": true }, "exchangeSeg": { "nullable": true }, "ltp": { "nullable": true }, "pdc": { "nullable": true }, "token": { "nullable": true }, "tradingSymbol": { "nullable": true } }, "type": "object" }, "type": "array" }, "t1Quantity": { "nullable": true }, "totalQuantity": { "nullable": true }, "tradedQty": { "nullable": true }, "unpledgedQty": { "nullable": true }, "unrealizedPnl": { "nullable": true }, "usedQty": { "nullable": true }, "withheldCollateralQty": { "nullable": true }, "withheldHoldingsQty": { "nullable": true } }, "type": "object" }, "type": "array" }, "poa": { "nullable": true }, "product": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "nullable": true } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Holdings", "tags": [ "holdings" ], "x-request-schema-file": "schemas/requests/holdings/get-portfolio-v2-holdings.json" } }, "/predefined/getMW": { "get": { "description": "Retrieves a paginated list of all system and research-curated predefined watchlists. Supports keyword search and pagination via query parameters. \n\n\n\nEndpoint Details", "operationId": "get-predefined-getmw", "parameters": [ { "allowEmptyValue": false, "example": 1, "in": "query", "name": "page", "required": false, "schema": { "description": "Page number (1-based, default: 1).", "minimum": 1, "type": "integer", "x-data-type": "integer" } }, { "allowEmptyValue": false, "example": 10, "in": "query", "name": "pageSize", "required": false, "schema": { "description": "Records per page (default: 10).", "type": "integer", "x-data-type": "integer" } }, { "allowEmptyValue": true, "example": "Energy", "in": "query", "name": "q", "required": false, "schema": { "description": "Keyword to filter watchlists by name or tag (e.g., \"Energy\").", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "activeStatus": 1, "description": "Renewable energy leaders in India", "flag": "NEW", "isEditable": 0, "isEnabled": 1, "logo": "/assets/logos/green_energy.png", "mwId": 1, "mwName": "Green Energy Basket", "scripCount": 8, "status": "LIVE", "subscriberCount": 1420, "tag": "THEMATIC", "topSymbols": [ "ADANIGREEN", "TATAPOWER", "SUZLON" ], "updatedAt": "2026-09-08T10:15:00Z" } ], "pagination": { "page": 1, "pageSize": 10, "totalPages": 1, "totalRecords": 1 } }, "schema": { "properties": { "data": { "items": { "properties": { "activeStatus": { "type": "integer" }, "description": { "type": "string" }, "flag": { "type": "string" }, "isEditable": { "type": "integer" }, "isEnabled": { "type": "integer" }, "logo": { "type": "string" }, "mwId": { "type": "integer" }, "mwName": { "type": "string" }, "scripCount": { "type": "integer" }, "status": { "type": "string" }, "subscriberCount": { "type": "integer" }, "tag": { "type": "string" }, "topSymbols": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalPages": { "type": "integer" }, "totalRecords": { "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Predefined Watchlists", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/get-predefined-getmw.json" } }, "/predefined/getMW/{mwId}": { "get": { "description": "Retrieves complete configuration, metadata, and all member scrips for a specific predefined watchlist identified by its mwId path parameter.\n\n\n\nEndpoint Details", "operationId": "get-predefined-getmw-mwid", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } }, { "in": "path", "name": "mwId", "required": true, "schema": { "type": "integer", "x-data-type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "error": "WATCHLIST_NOT_FOUND", "message": "No watchlist found with ID 1" } }, "success": { "description": "documented", "summary": "Success", "value": { "activeStatus": 1, "description": "Renewable energy leaders in India", "flag": "NEW", "isEditable": 0, "isEnabled": 1, "logo": "/assets/logos/green_energy.png", "mwId": 1, "mwName": "Green Energy Basket", "scrips": [ { "exchange": "NSE", "pdc": "420.50", "symbol": "TATAPOWER", "token": "3456" } ], "status": "LIVE", "subscriberCount": 1420, "tag": "THEMATIC", "updatedAt": "2026-09-08T10:15:00Z" } } }, "schema": { "anyOf": [ { "properties": { "activeStatus": { "type": "integer" }, "description": { "type": "string" }, "flag": { "type": "string" }, "isEditable": { "type": "integer" }, "isEnabled": { "type": "integer" }, "logo": { "type": "string" }, "mwId": { "type": "integer" }, "mwName": { "type": "string" }, "scrips": { "items": { "properties": { "exchange": { "type": "string" }, "pdc": { "type": "string" }, "symbol": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" }, "subscriberCount": { "type": "integer" }, "tag": { "type": "string" }, "updatedAt": { "type": "string" } }, "type": "object" }, { "properties": { "error": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Predefined Watchlist Details", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/get-predefined-getmw-mwid.json" } }, "/preferences/mob": { "get": { "description": "Returns all user preference settings for the mobile platform, including theme, layout toggles, market watch configuration, and widget visibility.", "operationId": "get-preferences-mob", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "name": "theme", "source": "MOB", "tag": "thm", "userId": "R8760002", "value": "0" }, { "name": "nifty", "source": "MOB", "tag": "n50", "userId": "R8760002", "value": "1" }, { "name": "banknifty", "source": "MOB", "tag": "bnf", "userId": "R8760002", "value": "1" }, { "name": "sensex", "source": "MOB", "tag": "snx", "userId": "R8760002", "value": "1" }, { "name": "fixed header", "source": "MOB", "tag": "fxh", "userId": "R8760002", "value": "0" }, { "name": "sticky order window", "source": "MOB", "tag": "sow", "userId": "R8760002", "value": "0" }, { "name": "singly depth", "source": "MOB", "tag": "sdp", "userId": "R8760002", "value": "0" }, { "name": "language", "source": "MOB", "tag": "lng", "userId": "R8760002", "value": "EN" }, { "name": "adding top", "source": "MOB", "tag": "mwt", "userId": "R8760002", "value": "0" }, { "name": "marketwatch view", "source": "MOB", "tag": "mwv", "userId": "R8760002", "value": "0" }, { "name": "mcard", "source": "MOB", "tag": "mcd", "userId": "R8760002", "value": "1" }, { "name": "indices", "source": "MOB", "tag": "ids", "userId": "R8760002", "value": "1" }, { "name": "screeners", "source": "MOB", "tag": "sns", "userId": "R8760002", "value": "1" }, { "name": "card", "source": "MOB", "tag": "crd", "userId": "R8760002", "value": "1" }, { "name": "topsector", "source": "MOB", "tag": "tsr", "userId": "R8760002", "value": "1" }, { "name": "funds", "source": "MOB", "tag": "fnd", "userId": "R8760002", "value": "1" }, { "name": "holdings", "source": "MOB", "tag": "hld", "userId": "R8760002", "value": "1" }, { "name": "globalmarkets", "source": "MOB", "tag": "glm", "userId": "R8760002", "value": "1" }, { "name": "fiidii", "source": "MOB", "tag": "fid", "userId": "R8760002", "value": "1" }, { "name": "heatmap", "source": "MOB", "tag": "htm", "userId": "R8760002", "value": "1" }, { "name": "fnoscan", "source": "MOB", "tag": "fns", "userId": "R8760002", "value": "1" }, { "name": "futures", "source": "MOB", "tag": "fut", "userId": "R8760002", "value": "1" }, { "name": "position", "source": "MOB", "tag": "pot", "userId": "R8760002", "value": "1" }, { "name": "notification", "source": "MOB", "tag": "note", "userId": "R8760002", "value": "1" }, { "name": "websocket", "source": "MOB", "tag": "skt", "userId": "R8760002", "value": "0" }, { "name": "exchange", "source": "MOB", "tag": "ets", "userId": "R8760002", "value": "1" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "name": { "type": "string" }, "source": { "type": "string" }, "tag": { "type": "string" }, "userId": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Mobile Preferences", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/get-preferences-mob.json" } }, "/preferences/mob/reset": { "post": { "description": "Resets all mobile preference settings to their system defaults and returns the full refreshed preference list.", "operationId": "post-preferences-mob-reset", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "nullable": true, "x-data-type": "any" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "dname": null, "group": null, "source": "MOB", "tag": "thm", "userId": "TEST1", "value": "0" }, { "dname": "NIFTY 50", "group": "pmw", "source": "MOB", "tag": "n50", "userId": "TEST1", "value": "1" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "anyOf": [ { "properties": { "dname": { "nullable": true }, "group": { "nullable": true }, "source": { "type": "string" }, "tag": { "type": "string" }, "userId": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, { "properties": { "dname": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "tag": { "type": "string" }, "userId": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } ] }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Reset Mobile Preferences", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-preferences-mob-reset.json" } }, "/preferences/mob/update": { "post": { "description": "Updates a single mobile preference tag for the authenticated user and returns the complete updated preference list.", "operationId": "post-preferences-mob-update", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "tag": "ets", "value": "1" }, "schema": { "properties": { "tag": { "description": "Preference tag code to update (e.g. \"thm\", \"ets\", \"mwt\")", "type": "string", "x-data-type": "string" }, "value": { "description": "New value — \"0\" or \"1\" for toggles", "type": "string", "x-data-type": "string" } }, "required": [ "tag", "value" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Update Mobile Preference", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-preferences-mob-update.json" } }, "/preferences/web": { "get": { "description": "Returns all user preference settings for the web platform including theme, ticker tape, market watch layout, and widget visibility flags.", "operationId": "get-preferences-web", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "dname": null, "group": null, "source": "WEB", "tag": "thm", "userId": "1014403", "value": "0" }, { "dname": null, "group": null, "source": "WEB", "tag": "tkt", "userId": "1014403", "value": "0" }, { "dname": null, "group": null, "source": "WEB", "tag": "mwo", "userId": "1014403", "value": "0" }, { "dname": null, "group": null, "source": "WEB", "tag": "sow", "userId": "1014403", "value": "0" }, { "dname": null, "group": null, "source": "WEB", "tag": "mwp", "userId": "1014403", "value": "0" }, { "dname": null, "group": null, "source": "WEB", "tag": "fpl", "userId": "1014403", "value": "0" }, { "dname": null, "group": null, "source": "WEB", "tag": "owt", "userId": "1014403", "value": "0" }, { "dname": null, "group": null, "source": "WEB", "tag": "mwt", "userId": "1014403", "value": "0" }, { "dname": "NIFTY 50", "group": "pmw", "source": "WEB", "tag": "n50", "userId": "1014403", "value": "1" }, { "dname": "NIFTY BANK", "group": "pmw", "source": "WEB", "tag": "bnf", "userId": "1014403", "value": "1" }, { "dname": "SENSEX", "group": "pmw", "source": "WEB", "tag": "snx", "userId": "1014403", "value": "1" }, { "dname": null, "group": null, "source": "WEB", "tag": "dep", "userId": "1014403", "value": "0" }, { "dname": "Mock Provider", "group": "pmw", "source": "WEB", "tag": "smw", "userId": "1014403", "value": "1" }, { "dname": "ORDER PREF", "group": null, "source": "WEB", "tag": "onp", "userId": "1014403", "value": "1" }, { "dname": "STICKY ORDER WINDOW", "group": null, "source": "WEB", "tag": "stick", "userId": "1014403", "value": "0" }, { "dname": "FLOATING DEPTH", "group": null, "source": "WEB", "tag": "ftdh", "userId": "1014403", "value": "0" }, { "dname": "QTY PREFERENCE", "group": null, "source": "WEB", "tag": "qty", "userId": "1014403", "value": "0" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "anyOf": [ { "properties": { "dname": { "nullable": true }, "group": { "nullable": true }, "source": { "type": "string" }, "tag": { "type": "string" }, "userId": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, { "properties": { "dname": { "type": "string" }, "group": { "type": "string" }, "source": { "type": "string" }, "tag": { "type": "string" }, "userId": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, { "properties": { "dname": { "type": "string" }, "group": { "nullable": true }, "source": { "type": "string" }, "tag": { "type": "string" }, "userId": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } ] }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Web Preferences", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/get-preferences-web.json" } }, "/preferences/web/reset": { "post": { "description": "Resets all web preference settings to their system defaults and returns the full refreshed preference list.", "operationId": "post-preferences-web-reset", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "nullable": true, "x-data-type": "any" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "dname": null, "group": null, "source": "WEB", "tag": "thm", "userId": "TEST1", "value": "0" }, { "dname": null, "group": null, "source": "WEB", "tag": "tkt", "userId": "TEST1", "value": "0" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "dname": { "nullable": true }, "group": { "nullable": true }, "source": { "type": "string" }, "tag": { "type": "string" }, "userId": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Reset Web Preferences", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-preferences-web-reset.json" } }, "/preferences/web/update": { "post": { "description": "Updates a single web preference tag for the authenticated user and returns the complete updated preference list.", "operationId": "post-preferences-web-update", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "tag": "mwt", "value": "1" }, "schema": { "properties": { "tag": { "description": "Preference tag code to update (e.g. \"thm\", \"tkt\", \"mwt\")", "type": "string", "x-data-type": "string" }, "value": { "description": "New value — \"0\" or \"1\" for toggles, \"EN\"/\"HI\" for language", "type": "string", "x-data-type": "string" } }, "required": [ "tag", "value" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Update Web Preference", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-preferences-web-update.json" } }, "/profile/createWsSess": { "post": { "description": "Creates a new WebSocket session for the user, enabling real-time market data streaming.", "operationId": "post-profile-createwssess", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "source": "KBMOB", "userId": "565121" }, "schema": { "properties": { "source": { "description": "Source platform identifier (e.g. \"KBMOB\", \"WEB\")", "type": "string", "x-data-type": "string" }, "userId": { "description": "User ID for whom the session is created", "type": "string", "x-data-type": "string" } }, "required": [ "source", "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "Status": "OK" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "Status": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Create WebSocket Session", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-profile-createwssess.json" } }, "/profile/freeze/status": { "post": { "description": "Returns whether the specified client account is currently frozen or active.", "operationId": "post-profile-freeze-status", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "userId": "T4560003" }, "schema": { "properties": { "userId": { "description": "User ID to check freeze status for", "type": "string", "x-data-type": "string" } }, "required": [ "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Active", "result": null, "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "nullable": true }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Account Freeze Status", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-profile-freeze-status.json" } }, "/profile/get/portfolio": { "post": { "description": "Returns the client portfolio summary including subscribed strategies, overall PnL, and total investment.", "operationId": "post-profile-get-portfolio", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "source": "WEB" }, "schema": { "properties": { "source": { "description": "Source platform (e.g. \"WEB\", \"MOB\")", "type": "string", "x-data-type": "string" } }, "required": [ "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "client_id": "1835896", "email_id": "1835896", "overall_pnl": -4360, "return_percentage": -24.22, "subscribed_strategies": [ { "realised_pnl": -4360, "status": "Running", "strategy_id": "sensex-opt-buying", "strategy_name": "SENSEX Option buying", "subscribed_amount": 18000, "subscribed_date": "2026-02-27", "subscription_id": "1835896_sensex-opt-buying" } ], "total_investment": 18000, "total_subscriptions": 1 } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "client_id": { "type": "string" }, "email_id": { "type": "string" }, "overall_pnl": { "type": "number" }, "return_percentage": { "type": "number" }, "subscribed_strategies": { "items": { "properties": { "realised_pnl": { "type": "number" }, "status": { "type": "string" }, "strategy_id": { "type": "string" }, "strategy_name": { "type": "string" }, "subscribed_amount": { "type": "number" }, "subscribed_date": { "type": "string" }, "subscription_id": { "type": "string" } }, "type": "object" }, "type": "array" }, "total_investment": { "type": "number" }, "total_subscriptions": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Portfolio", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-profile-get-portfolio.json" } }, "/profile/get/strategies": { "post": { "description": "Returns all available trading strategies with performance metrics, risk levels, and minimum investment requirements.", "operationId": "post-profile-get-strategies", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "source": "WEB" }, "schema": { "properties": { "source": { "description": "Source platform (e.g. \"WEB\", \"MOB\")", "type": "string", "x-data-type": "string" } }, "required": [ "source" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "strategies": [ { "max_drawdown": 1.68, "min_amount": 310000, "name": "BANKNIFTY Options scalping", "net_profit": 60530.5, "returns": { "one_month": 3.86, "one_year": 19.53, "six_month": 11.3, "three_month": 2.2 }, "risk_level": "Medium", "strategy_id": "banknifty-opt-scalp-limit" } ], "total_count": 3 } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "strategies": { "items": { "properties": { "max_drawdown": { "type": "number" }, "min_amount": { "type": "number" }, "name": { "type": "string" }, "net_profit": { "type": "number" }, "returns": { "properties": { "one_month": { "type": "number" }, "one_year": { "type": "number" }, "six_month": { "type": "number" }, "three_month": { "type": "number" } }, "type": "object" }, "risk_level": { "type": "string" }, "strategy_id": { "type": "string" } }, "type": "object" }, "type": "array" }, "total_count": { "type": "integer" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Strategies", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-profile-get-strategies.json" } }, "/profile/getUser": { "get": { "description": "Returns the authenticated session key (JWT or hash) for the current user, used for subsequent API calls.", "operationId": "get-profile-getuser", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "key": "51b204cffd083856d832cd86dc665811c8f81f51b59bc4338791d5e13670df47", "userId": "R8760002" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "key": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get User", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/get-profile-getuser.json" } }, "/profile/getclientdetails": { "post": { "description": "Returns the complete client profile including personal information, bank details, DP account numbers, exchange permissions, product types, and order preferences.", "operationId": "post-profile-getclientdetails", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "nullable": true, "x-data-type": "any" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "actId": "K0951424", "actStatus": "Activated", "address": "AJOY KUMAR ROY, ROY VILLA, SUKANTA PALLY, BURDWAN", "bankdetails": [ { "accNumber": "*******0764", "bankName": "STATE BANK OF INDIA", "isDefault": null } ], "branchId": "KOLKAT", "brokerName": "Mock Provider", "city": "BARDHAMAN", "clientName": "PARTHA PRATIM ROY", "createdDate": "1764591902", "createdTime": "1773026807", "dpAccountNumber": [ { "boId": null, "dpAccountName": null, "dpAccountNumber": "11183949", "dpId": null, "edisClientCode": null, "repository": null } ], "email": "partharoy1961@gmail.com", "encPan": "f4f25175f39ed953f8246c8c97438d98", "exchange": [ "BCD", "BFO", "BSE", "CDC", "MCX", "NSE", "NSLB" ], "mandateIdList": [], "mobNo": "8240114779", "officeAddress": "", "orderTypes": null, "orders": [ "LMT", "MKT", "SL-LMT", "SL-MKT", "2L", "3L", "DS" ], "pan": "******405A", "pincode": null, "poaStatus": "", "priceTypes": [ "L", "MKT", "SL", "SL-M" ], "productTypes": [ "CNC", "NRML", "MIS", "Cover", "Bracket" ], "products": [ "C", "M", "I", "H", "B" ], "state": "WEST BENGAL", "userId": "K0951424" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "actId": { "type": "string" }, "actStatus": { "type": "string" }, "address": { "type": "string" }, "bankdetails": { "items": { "properties": { "accNumber": { "type": "string" }, "bankName": { "type": "string" }, "isDefault": { "nullable": true } }, "type": "object" }, "type": "array" }, "branchId": { "type": "string" }, "brokerName": { "type": "string" }, "city": { "type": "string" }, "clientName": { "type": "string" }, "createdDate": { "type": "string" }, "createdTime": { "type": "string" }, "dpAccountNumber": { "items": { "properties": { "boId": { "nullable": true }, "dpAccountName": { "nullable": true }, "dpAccountNumber": { "type": "string" }, "dpId": { "nullable": true }, "edisClientCode": { "nullable": true }, "repository": { "nullable": true } }, "type": "object" }, "type": "array" }, "email": { "type": "string" }, "encPan": { "type": "string" }, "exchange": { "items": { "type": "string" }, "type": "array" }, "mandateIdList": { "items": {}, "type": "array" }, "mobNo": { "type": "string" }, "officeAddress": { "type": "string" }, "orderTypes": { "nullable": true }, "orders": { "items": { "type": "string" }, "type": "array" }, "pan": { "type": "string" }, "pincode": { "nullable": true }, "poaStatus": { "type": "string" }, "priceTypes": { "items": { "type": "string" }, "type": "array" }, "productTypes": { "items": { "type": "string" }, "type": "array" }, "products": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Client Details", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-profile-getclientdetails.json" } }, "/profile/invalidateWsSess": { "post": { "description": "Invalidates the active WebSocket session for the specified user.", "operationId": "post-profile-invalidatewssess", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "source": "KBMOB", "userId": "1934051" }, "schema": { "properties": { "source": { "description": "Source platform identifier (e.g. \"KBMOB\", \"WEB\")", "type": "string", "x-data-type": "string" }, "userId": { "description": "User ID of the session to invalidate", "type": "string", "x-data-type": "string" } }, "required": [ "source", "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "Status": "OK" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "Status": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Invalidate WebSocket Session", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-profile-invalidatewssess.json" } }, "/profile/mtf/client/update": { "post": { "description": "Updates the Margin Trading Facility (MTF) status for the authenticated client.", "operationId": "post-profile-mtf-client-update", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "status": "2" }, "schema": { "properties": { "status": { "description": "MTF status code — \"2\" to enable, \"0\" to disable", "type": "string", "x-data-type": "string" } }, "required": [ "status" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Updated Successfully", "result": null, "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "nullable": true }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Update MTF Client Status", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-profile-mtf-client-update.json" } }, "/profitLoss/getAnnualPL": { "get": { "description": "Retrieve Annual Profit \u0026 Loss statement with named financial line items. Available on Mock Provider broker.", "operationId": "get-profitloss-getannualpl", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "consolidated": [ { "depreciation": "28000", "ebidt": "181500", "eps": "15.80", "interest": "18000", "netProfit": "100500", "operatingExpenses": "720000", "operatingProfit": "169500", "operatingRevenue": "889500", "otherIncome": "12000", "profitBeforeTax": "135500", "tax": "35000", "totalExpenses": "780000", "totalRevenue": "901500", "year": "FY2024" } ], "standalone": [] }, "schema": { "properties": { "consolidated": { "items": { "properties": { "depreciation": { "type": "string" }, "ebidt": { "type": "string" }, "eps": { "type": "string" }, "interest": { "type": "string" }, "netProfit": { "type": "string" }, "operatingExpenses": { "type": "string" }, "operatingProfit": { "type": "string" }, "operatingRevenue": { "type": "string" }, "otherIncome": { "type": "string" }, "profitBeforeTax": { "type": "string" }, "tax": { "type": "string" }, "totalExpenses": { "type": "string" }, "totalRevenue": { "type": "string" }, "year": { "type": "string" } }, "type": "object" }, "type": "array" }, "standalone": { "items": {}, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Annual P\u0026L", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-profitloss-getannualpl.json" } }, "/profitLoss/getBalanceSheetData": { "get": { "description": "Retrieve balance sheet financial data. The response format varies by broker — Mock Provider returns a flat row-ID based array while Mock Provider returns named consolidated and standalone arrays.", "operationId": "get-profitloss-getbalancesheetdata", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "Consolidated", "in": "query", "name": "reportType", "required": false, "schema": { "description": "Report type: \"Consolidated\" or \"Standalone\" (supported by Mock Provider)", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "financialItem": "Total Share Capital", "rowId": 1, "yoy1": "6,362", "yoy2": "6,339" }, { "financialItem": "Total Reserves and Surplus", "rowId": 2, "yoy1": "6,42,756", "yoy2": "5,68,021" } ], "schema": { "items": { "properties": { "financialItem": { "type": "string" }, "rowId": { "type": "integer" }, "yoy1": { "type": "string" }, "yoy2": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Balance Sheet Data", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-profitloss-getbalancesheetdata.json" } }, "/profitLoss/getPLQuarterly": { "get": { "description": "Retrieve Quarterly Profit \u0026 Loss statement with named financial line items. Follows the same structure as the Annual P\u0026L endpoint (§4.21). Available on Mock Provider broker.", "operationId": "get-profitloss-getplquarterly", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "consolidated": [ { "depreciation": "7100", "ebidt": "46000", "eps": "3.85", "interest": "4500", "netProfit": "25600", "operatingExpenses": "182000", "operatingProfit": "42800", "operatingRevenue": "224800", "otherIncome": "3200", "profitBeforeTax": "34400", "tax": "8800", "totalExpenses": "197000", "totalRevenue": "228000", "year": "Q3FY2024" } ], "standalone": [] }, "schema": { "properties": { "consolidated": { "items": { "properties": { "depreciation": { "type": "string" }, "ebidt": { "type": "string" }, "eps": { "type": "string" }, "interest": { "type": "string" }, "netProfit": { "type": "string" }, "operatingExpenses": { "type": "string" }, "operatingProfit": { "type": "string" }, "operatingRevenue": { "type": "string" }, "otherIncome": { "type": "string" }, "profitBeforeTax": { "type": "string" }, "tax": { "type": "string" }, "totalExpenses": { "type": "string" }, "totalRevenue": { "type": "string" }, "year": { "type": "string" } }, "type": "object" }, "type": "array" }, "standalone": { "items": {}, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Quarterly P\u0026L", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-profitloss-getplquarterly.json" } }, "/profitLoss/getProfitLossData": { "get": { "description": "Retrieve Profit \u0026 Loss statement data. The response format varies by broker — Mock Provider returns a flat row-ID based array while Mock Provider returns named annual and quarterly consolidated/standalone arrays.", "operationId": "get-profitloss-getprofitlossdata", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exch", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "Consolidated", "in": "query", "name": "reportType", "required": false, "schema": { "description": "Report type: \"Consolidated\" or \"Standalone\" (supported by Mock Provider)", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "financialItem": "Total Revenue", "rowId": 1, "yoy1": "9,01,500", "yoy2": "8,74,640" }, { "financialItem": "Net Profit", "rowId": 2, "yoy1": "69,621", "yoy2": "60,705" } ], "schema": { "items": { "properties": { "financialItem": { "type": "string" }, "rowId": { "type": "integer" }, "yoy1": { "type": "string" }, "yoy2": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Profit \u0026 Loss Data", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-profitloss-getprofitlossdata.json" } }, "/profitLoss/getPutCallRatio": { "get": { "description": "Retrieve the Put/Call Ratio (PCR) for a derivative instrument. Note: This endpoint currently returns an error for invalid or missing expiry dates.", "operationId": "get-profitloss-getputcallratio", "parameters": [ { "allowEmptyValue": true, "example": "RELIANCE", "in": "query", "name": "symbol", "required": true, "schema": { "description": "Trading symbol of the derivative instrument", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "", "in": "query", "name": "expiryDate", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string", "x-data-type": "date" }, { "format": "date-dd-mmm-yyyy", "type": "string", "x-data-type": "date-dd-mmm-yyyy" }, { "enum": [ "" ], "type": "string", "x-data-type": "string" } ], "description": "Expiry date of the options contract. Pass empty string for nearest expiry", "x-data-type": "union" } } ], "responses": { "200": { "content": { "text/plain": { "example": "Invalid Parameter", "schema": { "type": "string" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Put Call Ratio", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-profitloss-getputcallratio.json" } }, "/scrip/search": { "post": { "description": "Searches tradeable contracts across segments with text-based search, exchange filtering, category filtering (EQ, FUT, OPT), and pagination. Returns matching instruments sorted by relevance.\n\n\n\nEndpoint Details", "operationId": "post-scrip-search", "parameters": [ { "description": "Explicit scenario takes priority. See response examples for names and provenance.", "in": "header", "name": "X-Mock-Scenario", "required": false, "schema": { "enum": [ "success", "failure" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "category": [ "EQ" ], "currentPage": "1", "exchange": [ "NSE", "BSE" ], "pageSize": "10", "searchText": "TATA" }, "schema": { "properties": { "category": { "description": "Instrument categories to filter (e.g., [\"EQ\"], [\"FUT\"], [\"OPT\"]).", "items": { "type": "string", "x-data-type": "string" }, "type": "array", "x-data-type": "array" }, "currentPage": { "description": "1-based page number for pagination. Defaults to \"1\".", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Filter by exchange(s) (e.g., [\"NSE\", \"BSE\"]). Omit for all exchanges.", "items": { "type": "string", "x-data-type": "string" }, "type": "array", "x-data-type": "array" }, "pageSize": { "description": "Number of results per page. Defaults to \"10\".", "type": "string", "x-data-type": "string" }, "searchText": { "description": "Keyword or symbol prefix to search for (e.g., \"TATA\").", "type": "string", "x-data-type": "string" } }, "required": [ "searchText" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "failure": { "description": "documented", "summary": "Failure", "value": { "code": "ECMW111", "message": "No record found", "result": { "currentPage": 0, "pageCount": 0, "searchResult": [] }, "status": "Not_ok" } }, "success": { "description": "documented", "summary": "Success", "value": { "code": "0", "message": "Success", "result": { "currentPage": 1, "pageCount": 5, "searchResult": [ { "companyName": "TATA MOTORS LIMITED", "exchange": "NSE", "formattedInsName": "TATAMOTORS EQ", "instrumentType": "EQ", "isin": "INE155A01022", "lotSize": "1", "symbol": "TATAMOTORS", "tickSize": "0.05", "token": "3456", "tradingSymbol": "TATAMOTORS-EQ" } ] }, "status": "Ok" } } }, "schema": { "anyOf": [ { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "currentPage": { "type": "integer" }, "pageCount": { "type": "integer" }, "searchResult": { "items": { "properties": { "companyName": { "type": "string" }, "exchange": { "type": "string" }, "formattedInsName": { "type": "string" }, "instrumentType": { "type": "string" }, "isin": { "type": "string" }, "lotSize": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "result": { "properties": { "currentPage": { "type": "integer" }, "pageCount": { "type": "integer" }, "searchResult": { "items": {}, "type": "array" } }, "type": "object" }, "status": { "type": "string" } }, "type": "object" } ] } } }, "description": "Success / Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Scrip Search", "tags": [ "watchlist" ], "x-request-schema-file": "schemas/requests/watchlist/post-scrip-search.json" } }, "/scrips/v1/contract-info": { "post": { "description": "Returns contract / listing information for a scrip, including every exchange variant of the instrument and any applicable surveillance advisories. Most brokers nest the per-exchange listings under a scrips[] array; Mock Provider returns a flat, single-exchange object.Note (Request): Sample request/response not provided for Mock Provider for this endpoint. Note (Response): Mock Provider, Mock Provider, Mock Provider, Mock Provider and Mock Provider nest per-exchange listings under scrips[]. Mock Provider returns the same fields directly on the result[] item, with no scrips[] wrapper. Mock Provider and Mock Provider add a small number of extra top-level and scrip-level fields, listed separately below.", "operationId": "post-scrips-v1-contract-info", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exch": "NSE", "token": "14366" }, "schema": { "properties": { "exch": { "description": "Exchange segment code, e.g. NSE, BSE. Supported by: Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider.", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange instrument token of the scrip. Supported by: Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider.", "type": "string", "x-data-type": "string" } }, "required": [ "token", "exch" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "prompt": null, "requestTime": null, "result": [ { "amoWindow": "1", "freezeQty": "0", "isin": "INE669E01016", "logoUrl": null, "memo": null, "scrips": [ { "colourCode": "GREY", "companyName": "VODAFONE IDEA LIMITED", "eq": true, "exchange": "NSE", "expiry": null, "fiftyWeekHigh": "18.42", "fiftyWeeklow": "6.87", "formattedInsName": "IDEA-EQ", "insType": "0", "lastTradingDate": null, "lotSize": "1", "mtf": true, "multiplier": "1", "optionFlag": 1, "pdc": "8.58", "physicalQty": "0", "pnlMultiplier": "0", "prompt": [ { "company_name": "VODAFONE IDEA LIMITED", "exch": "NSE", "isin": "INE669E01016", "msg": "Loss making - Surveillance Measure list", "prompt": null, "severity": "medium", "symbol": null, "token": null, "type": "Loss making" } ], "score": "null", "scoreText": "Not Rated", "segment": "nse_cm", "strike_price": null, "symbol": "IDEA", "tickSize": "0.01", "token": "14366", "tradingSymbol": "IDEA-EQ" } ], "shortDescription": null } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "prompt": { "nullable": true }, "requestTime": { "nullable": true }, "result": { "items": { "properties": { "amoWindow": { "type": "string" }, "freezeQty": { "type": "string" }, "isin": { "type": "string" }, "logoUrl": { "nullable": true }, "memo": { "nullable": true }, "scrips": { "items": { "properties": { "colourCode": { "type": "string" }, "companyName": { "type": "string" }, "eq": { "type": "boolean" }, "exchange": { "type": "string" }, "expiry": { "nullable": true }, "fiftyWeekHigh": { "type": "string" }, "fiftyWeeklow": { "type": "string" }, "formattedInsName": { "type": "string" }, "insType": { "type": "string" }, "lastTradingDate": { "nullable": true }, "lotSize": { "type": "string" }, "mtf": { "type": "boolean" }, "multiplier": { "type": "string" }, "optionFlag": { "type": "integer" }, "pdc": { "type": "string" }, "physicalQty": { "type": "string" }, "pnlMultiplier": { "type": "string" }, "prompt": { "items": { "properties": { "company_name": { "type": "string" }, "exch": { "type": "string" }, "isin": { "type": "string" }, "msg": { "type": "string" }, "prompt": { "nullable": true }, "severity": { "type": "string" }, "symbol": { "nullable": true }, "token": { "nullable": true }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "score": { "type": "string" }, "scoreText": { "type": "string" }, "segment": { "type": "string" }, "strike_price": { "nullable": true }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" }, "shortDescription": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Contract Info", "tags": [ "scrips" ], "x-request-schema-file": "schemas/requests/scrips/post-scrips-v1-contract-info.json" } }, "/scrips/v1/future-scrips": { "post": { "description": "Returns the list of derivative (futures) contracts available for a given underlying instrument. A sample was provided only for Mock Provider; field names should be confirmed against the other broker integrations before use.Note (Request): Sample request/response was provided only for Mock Provider; not yet documented for Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider or Mock Provider.", "operationId": "post-scrips-v1-future-scrips", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exch": "NSE", "token": "10604" }, "schema": { "properties": { "exch": { "description": "Exchange segment code, e.g. NSE. Supported by: Mock Provider.", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange instrument token of the underlying scrip. Supported by: Mock Provider.", "type": "string", "x-data-type": "string" } }, "required": [ "token", "exch" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "alterToken": null, "companyName": "BHARTI AIRTEL LIMITED", "exch": "NFO", "expiry": 1777314600000, "formattedInsName": "BHARTIARTL 28th APR FUT", "freezQty": "14250", "groupName": "XX", "insType": "FUTSTK", "isin": null, "lotSize": "475", "multiplier": 0, "optionFlag": 1, "optionType": "XX", "pdc": "1796.8", "pnlMultiplier": 0, "segment": "nse_fo", "strikePrice": "-1", "symbol": "BHARTIARTL", "tickSize": "0.1", "token": "66728", "tradingSymbol": "BHARTIARTL26APRFUT", "weekTag": "M" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "alterToken": { "nullable": true }, "companyName": { "type": "string" }, "exch": { "type": "string" }, "expiry": { "type": "integer" }, "formattedInsName": { "type": "string" }, "freezQty": { "type": "string" }, "groupName": { "type": "string" }, "insType": { "type": "string" }, "isin": { "nullable": true }, "lotSize": { "type": "string" }, "multiplier": { "type": "integer" }, "optionFlag": { "type": "integer" }, "optionType": { "type": "string" }, "pdc": { "type": "string" }, "pnlMultiplier": { "type": "integer" }, "segment": { "type": "string" }, "strikePrice": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "weekTag": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Future Scrips", "tags": [ "scrips" ], "x-request-schema-file": "schemas/requests/scrips/post-scrips-v1-future-scrips.json" } }, "/scrips/v1/search": { "post": { "description": "Searches for scrips across one or more exchanges by symbol or free-text term. Mock Provider uses a distinct request/response envelope with server-side pagination (searchText, pageSize, currentPage / pageCount, searchResult[]); all other brokers return a flat array.Note (Response): Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider and Mock Provider return result as a flat array of matches. Mock Provider instead nests matches under result.searchResult[] alongside result.pageCount and result.currentPage. Both shapes are documented below; the example shows the common array shape with the Mock Provider-only fields noted in the parameter table.", "operationId": "post-scrips-v1-search", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "currentPage": "1", "exchange": [ "ALL" ], "pageSize": "100", "searchText": "IDEA", "symbol": "IDEA" }, "schema": { "properties": { "currentPage": { "description": "Page number to fetch. (Mock Provider only)", "type": "string", "x-data-type": "string" }, "exchange": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "items": { "nullable": true, "x-data-type": "any" }, "type": "array", "x-data-type": "array" } ], "description": "Exchange(s) to search within, e.g. [\"ALL\"], [\"NSE\"]. Supported by all brokers.", "x-data-type": "union" }, "pageSize": { "description": "Number of results to return per page. (Mock Provider only)", "type": "string", "x-data-type": "string" }, "searchText": { "description": "Search keyword, used by Mock Provider in place of symbol.", "type": "string", "x-data-type": "string" }, "symbol": { "description": "Search keyword / scrip symbol. Used by Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "colourCode": "GREY", "companyName": "VODAFONE IDEA LIMITED", "exchange": "NSE", "expiry": null, "formattedInsName": "IDEA-EQ", "isFnOAvailable": true, "isin": "INE669E01016", "mtfValue": "60.05", "optionType": "", "pdc": "8.58", "score": "null", "scoreText": "Not Rated", "segment": "nse_cm", "series": "EQ", "symbol": "IDEA-EQ", "token": "14366", "weekTag": "null" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "colourCode": { "type": "string" }, "companyName": { "type": "string" }, "exchange": { "type": "string" }, "expiry": { "nullable": true }, "formattedInsName": { "type": "string" }, "isFnOAvailable": { "type": "boolean" }, "isin": { "type": "string" }, "mtfValue": { "type": "string" }, "optionType": { "type": "string" }, "pdc": { "type": "string" }, "score": { "type": "string" }, "scoreText": { "type": "string" }, "segment": { "type": "string" }, "series": { "type": "string" }, "symbol": { "type": "string" }, "token": { "type": "string" }, "weekTag": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Search", "tags": [ "scrips" ], "x-request-schema-file": "schemas/requests/scrips/post-scrips-v1-search.json" } }, "/scrips/v1/security-info": { "post": { "description": "Returns master and market-reference information for a single scrip, identified by its exchange token. Response depth varies by broker: most brokers return an array of scrip records under result, while Mock Provider returns a single object.Note (Request): Not supported by Mock Provider (returns NILL). Sample request not provided for Mock Provider. Note (Response): Mock Provider, Mock Provider and Mock Provider return result as an array of flat scrip-detail objects. Mock Provider returns result as an array wrapping a nested scrips[] list (one entry per exchange listing of the ISIN), each with its own prompt[] advisory list. Mock Provider returns result as a single object (not an array) with a different, richer field set including spotData, productLeverage, badge and screeners. The example below shows the common/array shape; Mock Provider-specific fields are listed separately in the Response Parameters table below.", "operationId": "post-scrips-v1-security-info", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exch": "NSE", "token": "24950" }, "schema": { "properties": { "exch": { "description": "Exchange segment code, e.g. NSE, BSE. Supported by: Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider.", "type": "string", "x-data-type": "string" }, "token": { "description": "Exchange instrument token of the scrip. Supported by: Mock Provider, Mock Provider, Mock Provider, Mock Provider, Mock Provider.", "type": "string", "x-data-type": "string" } }, "required": [ "token", "exch" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "requestTime": null, "result": [ { "additionalLongMargin": "NA", "additionalShortMargin": "NA", "amoWindow": null, "avmBuyMargin": "NA", "avmSellMargin": "NA", "bookClosureEndDate": "1 Jan, 1980 - 0:0:0", "bookClosureStartDate": "1 Jan, 1980", "companyName": "VODAFONE IDEA LIMITED", "deliveryMargin": "NA", "deliveryUnits": "NA", "dname": "VODAFONE IDEA LIMITED", "elmBuyMargin": "-1", "elmMargin": "0", "elmSellMargin": "NA", "endDate": "06/04/2026 15:54:01", "exchange": "NSE", "exchangeTime": "06/04/2026 15:54:01", "exerciseEndDate": "1 Jan, 1980", "exerciseStartDate": "1 Jan, 1980", "expiry": null, "exposureMargin": "NA", "faceValue": "10.00", "formattedInsName": "IDEA-EQ", "freezeQty": "0", "gp_nd": null, "instrumentName": "IDEA-EQ", "intrinsicValue": null, "isin": "INE669E01016", "issuedCapital": "5000000", "issuedate": "7 Apr, 2026", "lastTradedDate": "06/04/2026 15:54:01", "lastTradingDate": "NA", "listingDate": "7 Apr, 2026 - 0:0:0", "lotSize": "1", "lowerCircuit": "7.90", "marketType": "NA", "markettype": "NA", "multiplier": "1", "nontradableinstruments": "0", "openInterest": "0.0", "optionType": "NA", "prcftr_d": "(1.0 / 1.0) * (1.0 / 1.0) = 1.00", "pricePrecision": null, "priceQuoteQty": null, "priceUnit": null, "recordDate": null, "remarks": "NA", "scrips": [ { "colourCode": "GREY", "exchange": "BSE", "expiry": null, "formattedInsName": "IDEA", "insType": "E", "lotSize": "1", "multiplier": "1", "optionFlag": 0, "pdc": "8.6", "physicalQty": "0", "pnlMultiplier": "0", "prompt": [ { "company_name": "VODAFONE IDEA LIMITED", "exch": "BSE", "isin": "INE669E01016", "msg": "Loss making - Surveillance Measure list", "prompt": null, "severity": "medium", "symbol": null, "token": null, "type": "Loss making" } ], "score": "null", "scoreText": "Not Rated", "symbol": "IDEA", "tickSize": "0.01", "token": "532822", "tradingSymbol": "IDEA" } ], "scripupdateGsmInd": null, "segment": "nse_cm", "settlementType": "T+1", "specialLongMargin": "NA", "specialShortMargin": "NA", "spotPrice": "8.77", "startDate": "NA", "strikePrice": "NA", "symbol": "IDEA", "symbolName": "IDEA-EQ", "tenderEndEate": "NA", "tenderMargin": null, "tenderStartDate": "NA", "tickSize": "0.01", "time": "06/04/2026 15:54:01", "token": "14366", "totalTradedVolume": "26.93782 (Crs)", "tradeUnits": null, "tradingSymbol": "IDEA-EQ", "upperCircuit": "9.64", "varMargin": "20", "weekly": null } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "requestTime": { "nullable": true }, "result": { "items": { "properties": { "additionalLongMargin": { "type": "string" }, "additionalShortMargin": { "type": "string" }, "amoWindow": { "nullable": true }, "avmBuyMargin": { "type": "string" }, "avmSellMargin": { "type": "string" }, "bookClosureEndDate": { "type": "string" }, "bookClosureStartDate": { "type": "string" }, "companyName": { "type": "string" }, "deliveryMargin": { "type": "string" }, "deliveryUnits": { "type": "string" }, "dname": { "type": "string" }, "elmBuyMargin": { "type": "string" }, "elmMargin": { "type": "string" }, "elmSellMargin": { "type": "string" }, "endDate": { "type": "string" }, "exchange": { "type": "string" }, "exchangeTime": { "type": "string" }, "exerciseEndDate": { "type": "string" }, "exerciseStartDate": { "type": "string" }, "expiry": { "nullable": true }, "exposureMargin": { "type": "string" }, "faceValue": { "type": "string" }, "formattedInsName": { "type": "string" }, "freezeQty": { "type": "string" }, "gp_nd": { "nullable": true }, "instrumentName": { "type": "string" }, "intrinsicValue": { "nullable": true }, "isin": { "type": "string" }, "issuedCapital": { "type": "string" }, "issuedate": { "type": "string" }, "lastTradedDate": { "type": "string" }, "lastTradingDate": { "type": "string" }, "listingDate": { "type": "string" }, "lotSize": { "type": "string" }, "lowerCircuit": { "type": "string" }, "marketType": { "type": "string" }, "markettype": { "type": "string" }, "multiplier": { "type": "string" }, "nontradableinstruments": { "type": "string" }, "openInterest": { "type": "string" }, "optionType": { "type": "string" }, "prcftr_d": { "type": "string" }, "pricePrecision": { "nullable": true }, "priceQuoteQty": { "nullable": true }, "priceUnit": { "nullable": true }, "recordDate": { "nullable": true }, "remarks": { "type": "string" }, "scrips": { "items": { "properties": { "colourCode": { "type": "string" }, "exchange": { "type": "string" }, "expiry": { "nullable": true }, "formattedInsName": { "type": "string" }, "insType": { "type": "string" }, "lotSize": { "type": "string" }, "multiplier": { "type": "string" }, "optionFlag": { "type": "integer" }, "pdc": { "type": "string" }, "physicalQty": { "type": "string" }, "pnlMultiplier": { "type": "string" }, "prompt": { "items": { "properties": { "company_name": { "type": "string" }, "exch": { "type": "string" }, "isin": { "type": "string" }, "msg": { "type": "string" }, "prompt": { "nullable": true }, "severity": { "type": "string" }, "symbol": { "nullable": true }, "token": { "nullable": true }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "score": { "type": "string" }, "scoreText": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" }, "scripupdateGsmInd": { "nullable": true }, "segment": { "type": "string" }, "settlementType": { "type": "string" }, "specialLongMargin": { "type": "string" }, "specialShortMargin": { "type": "string" }, "spotPrice": { "type": "string" }, "startDate": { "type": "string" }, "strikePrice": { "type": "string" }, "symbol": { "type": "string" }, "symbolName": { "type": "string" }, "tenderEndEate": { "type": "string" }, "tenderMargin": { "nullable": true }, "tenderStartDate": { "type": "string" }, "tickSize": { "type": "string" }, "time": { "type": "string" }, "token": { "type": "string" }, "totalTradedVolume": { "type": "string" }, "tradeUnits": { "nullable": true }, "tradingSymbol": { "type": "string" }, "upperCircuit": { "type": "string" }, "varMargin": { "type": "string" }, "weekly": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Security Info", "tags": [ "scrips" ], "x-request-schema-file": "schemas/requests/scrips/post-scrips-v1-security-info.json" } }, "/startbar/add": { "post": { "description": "Pins a new scrip to the web startbar at the specified sort order position.", "operationId": "post-startbar-add", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exchange": "BSE", "sortOrder": "1", "token": "1" }, "schema": { "properties": { "exchange": { "description": "Exchange code (NSE, BSE, MCX, NFO, etc.)", "type": "string", "x-data-type": "string" }, "sortOrder": { "description": "Sort order/position in the startbar (1-based)", "type": "string", "x-data-type": "string" }, "token": { "description": "Instrument token", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token", "sortOrder" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ "Added successfully" ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "type": "string" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Add Scrip to Web Startbar", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-startbar-add.json" } }, "/startbar/add/mob": { "post": { "description": "Pins a new scrip (instrument) to the mobile startbar at the specified sort order position.", "operationId": "post-startbar-add-mob", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exchange": "MCX", "sortOrder": "1", "token": "554655" }, "schema": { "properties": { "exchange": { "description": "Exchange code (NSE, BSE, MCX, NFO, etc.)", "type": "string", "x-data-type": "string" }, "sortOrder": { "description": "Sort order/position in the startbar (1-based)", "type": "string", "x-data-type": "string" }, "token": { "description": "Instrument token", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token", "sortOrder" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ "Added successfully" ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "type": "string" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Add Scrip to Mobile Startbar", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/post-startbar-add-mob.json" } }, "/startbar/get": { "get": { "description": "Returns the list of scrips pinned to the web startbar with their previous-day close price.", "operationId": "get-startbar-get", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "exchange": "NSE", "expiry": null, "formattedInsName": "NIFTY 50", "pdc": "23897.95", "segment": "nse_idx", "sortOrder": 1, "source": "WEB", "symbol": "NIFTY 50", "token": "26000", "tradingSymbol": "NIFTY 50" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "exchange": { "type": "string" }, "expiry": { "nullable": true }, "formattedInsName": { "type": "string" }, "pdc": { "type": "string" }, "segment": { "type": "string" }, "sortOrder": { "type": "integer" }, "source": { "type": "string" }, "symbol": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Web Startbar Scrips", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/get-startbar-get.json" } }, "/startbar/get/mob": { "get": { "description": "Returns the list of scrips pinned to the mobile startbar along with their latest previous-day close price.", "operationId": "get-startbar-get-mob", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "exchange": "NSE", "expiry": null, "formattedInsName": "NIFTY 50", "pdc": "24173.05", "segment": "nse_idx", "sortOrder": 1, "source": "MOB", "symbol": "NIFTY 50", "token": "26000", "tradingSymbol": "NIFTY 50" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "exchange": { "type": "string" }, "expiry": { "nullable": true }, "formattedInsName": { "type": "string" }, "pdc": { "type": "string" }, "segment": { "type": "string" }, "sortOrder": { "type": "integer" }, "source": { "type": "string" }, "symbol": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get Mobile Startbar Scrips", "tags": [ "client-utils" ], "x-request-schema-file": "schemas/requests/client-utils/get-startbar-get-mob.json" } }, "/swot/get/swotdata": { "get": { "description": "Retrieve SWOT (Strengths, Weaknesses, Opportunities, Threats) analysis along with comprehensive stock price insight data. Availability and response richness varies by broker.", "operationId": "get-swot-get-swotdata", "parameters": [ { "allowEmptyValue": true, "example": "NSE", "in": "query", "name": "exchange", "required": true, "schema": { "description": "Exchange code (e.g., NSE, BSE)", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "1594", "in": "query", "name": "token", "required": true, "schema": { "description": "Unique exchange token identifying the stock", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "opportunities": [ { "description": "...", "title": "Market Expansion" } ], "stockData": { "bseCode": "500325", "dayChange": 12.5, "dayChangeP": 0.51, "exchangeForPrice": "NSE", "highPrice": 2468.8, "industryName": "Refineries", "isin": "INE002A01018", "lowPrice": 2440.1, "monthChange": -18.25, "monthChangeP": -0.74, "nseCode": "RELIANCE", "openPrice": 2448, "pageType": "equity", "prevClose": 2443.25, "priceInsight": { "color": "#16A34A", "icon": "check-circle", "longText": "Based on PE, PB, and sector comparison...", "param": "fair_value", "shortText": "Stock appears fairly valued at current levels", "title": "Fairly Valued", "url": "/stock/RELIANCE/analysis", "urlHelp": "View full analysis", "value": "2455.75" }, "sectorName": "Energy", "stockId": "10000", "stockName": "RELIANCE INDUSTRIES LTD", "updated": "2024-01-31T10:00:00Z", "volumeDay": 8542316, "weekChange": 35.75, "weekChangeP": 1.48, "yearChange": 285.5, "yearChangeP": 13.17 }, "strengths": [ { "description": "Company has demonstrated consistent revenue growth over 5 years", "title": "Strong Revenue Growth" } ], "threats": [ { "description": "...", "title": "Regulatory Risk" } ], "weaknesses": [ { "description": "...", "title": "High Debt Levels" } ] }, "schema": { "properties": { "opportunities": { "items": { "properties": { "description": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" }, "stockData": { "properties": { "bseCode": { "type": "string" }, "dayChange": { "type": "number" }, "dayChangeP": { "type": "number" }, "exchangeForPrice": { "type": "string" }, "highPrice": { "type": "number" }, "industryName": { "type": "string" }, "isin": { "type": "string" }, "lowPrice": { "type": "number" }, "monthChange": { "type": "number" }, "monthChangeP": { "type": "number" }, "nseCode": { "type": "string" }, "openPrice": { "type": "number" }, "pageType": { "type": "string" }, "prevClose": { "type": "number" }, "priceInsight": { "properties": { "color": { "type": "string" }, "icon": { "type": "string" }, "longText": { "type": "string" }, "param": { "type": "string" }, "shortText": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "urlHelp": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "sectorName": { "type": "string" }, "stockId": { "type": "string" }, "stockName": { "type": "string" }, "updated": { "type": "string" }, "volumeDay": { "type": "integer" }, "weekChange": { "type": "number" }, "weekChangeP": { "type": "number" }, "yearChange": { "type": "number" }, "yearChangeP": { "type": "number" } }, "type": "object" }, "strengths": { "items": { "properties": { "description": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" }, "threats": { "items": { "properties": { "description": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" }, "weaknesses": { "items": { "properties": { "description": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SWOT Data", "tags": [ "fundamentals-technicals" ], "x-request-schema-file": "schemas/requests/fundamentals-technicals/get-swot-get-swotdata.json" } }, "/v2/cdsl/hstoken": { "get": { "description": "Retrieves a CDSL Holding Statement (HS) token for the authenticated client. The HS token is a session-scoped credential issued by CDSL and is required for certain CDSL portal interactions such as eDIS pledge and depository operations.", "operationId": "get-v2-cdsl-hstoken", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "actid": "DVJ8266", "brkname": "Mock Provider", "hstk": "8MYVfV1Z08zta6C81WElxjre", "request_time": "10:41:56 06-04-2026", "stat": "Ok", "uid": "DVJ8266" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "actid": { "type": "string" }, "brkname": { "type": "string" }, "hstk": { "type": "string" }, "request_time": { "type": "string" }, "stat": { "type": "string" }, "uid": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "CDSL HSToken", "tags": [ "holdings" ], "x-request-schema-file": "schemas/requests/holdings/get-v2-cdsl-hstoken.json" } }, "/v2/cdsl/pledge": { "post": { "description": "Initiates a CDSL pledge/e-DIS request for one or more holdings. Returns a signed transaction blob and a CDSL verification URL that the client must visit to complete the pledge.", "operationId": "post-v2-cdsl-pledge", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "dpId": null, "transDtls": { "boId": null, "exId": null, "execDate": null, "numberOfDays": null, "recordDtls": [ { "isIn": null, "product": null, "quantity": null } ], "reqIdentifier": null, "reqType": null }, "userId": null }, "schema": { "properties": { "dpId": { "description": "Depository Participant ID of the client.", "nullable": true, "type": "string", "x-data-type": "string" }, "transDtls": { "description": "Container for the pledge transaction details.", "properties": { "boId": { "description": "Beneficiary Owner ID (demat account number).", "nullable": true, "type": "string", "x-data-type": "string" }, "exId": { "description": "Exchange identifier code (e.g. \"11\" = NSE, \"12\" = BSE).", "nullable": true, "type": "string", "x-data-type": "string" }, "execDate": { "description": "Execution date of the pledge request (format: DDMMYYYY).", "format": "date-ddmmyyyy", "nullable": true, "type": "string", "x-data-type": "date-ddmmyyyy" }, "numberOfDays": { "description": "Validity period, in days, for the pledge request.", "nullable": true, "type": "string", "x-data-type": "string" }, "recordDtls": { "description": "List of scrips included in the pledge request.", "items": { "properties": { "isIn": { "description": "ISIN of the scrip being pledged.", "nullable": true, "type": "string", "x-data-type": "string" }, "product": { "description": "Product type of the holding being pledged (e.g. \"CNC\").", "nullable": true, "type": "string", "x-data-type": "string" }, "quantity": { "description": "Quantity of the scrip being pledged.", "nullable": true, "type": "string", "x-data-type": "string" } }, "required": [ "isIn", "quantity", "product" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" }, "reqIdentifier": { "description": "Identifier code for the request category (e.g. \"S\" for sell authorization).", "nullable": true, "type": "string", "x-data-type": "string" }, "reqType": { "description": "Type of the pledge request (e.g. \"D\" for Debit/sell).", "nullable": true, "type": "string", "x-data-type": "string" } }, "required": [ "reqType", "reqIdentifier", "boId", "exId", "numberOfDays", "execDate", "recordDtls" ], "type": "object", "x-data-type": "object" }, "userId": { "description": "Identifier of the user submitting the pledge request.", "nullable": true, "type": "string", "x-data-type": "string" } }, "required": [ "dpId", "transDtls", "userId" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": null, "result": [ { "dpId": null, "reqId": null, "revokDtls": null, "transDtls": null, "url": null, "version": null } ], "status": null }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "nullable": true }, "result": { "items": { "properties": { "dpId": { "nullable": true }, "reqId": { "nullable": true }, "revokDtls": { "nullable": true }, "transDtls": { "nullable": true }, "url": { "nullable": true }, "version": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "nullable": true } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "CDSL Pledge Data", "tags": [ "holdings" ], "x-request-schema-file": "schemas/requests/holdings/post-v2-cdsl-pledge.json" } }, "/v2/cdsl/return": { "get": { "description": "CDSL redirect callback endpoint. CDSL invokes this endpoint after the client completes (or fails) TPIN/eDIS authorization on the CDSL portal. The platform processes the encrypted result, updates the authorization status, and returns the outcome. This URL is configured as the return/redirect URL in the CDSL eDIS setup and is not called directly by clients or front-end applications.", "operationId": "get-v2-cdsl-return", "parameters": [ { "allowEmptyValue": true, "example": "\u003cstring\u003e", "in": "query", "name": "ReqId", "required": true, "schema": { "description": "The unique request identifier generated during the original pledge/authorize call. Identifies which authorization transaction this callback is for.", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "\u003cstring\u003e", "in": "query", "name": "ReqType", "required": true, "schema": { "description": "Type of request that triggered the CDSL flow (e.g. \"D\" for Debit/sell authorization).", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "\u003curl-encoded-encrypted-blob\u003e", "in": "query", "name": "transDtls", "required": true, "schema": { "description": "URL-encoded, CDSL-encrypted transaction result blob containing the authorization outcome. Must be passed to the CDSL verification endpoint to confirm the status.", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": null, "result": [ { "errorCode": null, "errorMessage": null, "reqId": null, "status": null } ], "status": null }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "nullable": true }, "result": { "items": { "properties": { "errorCode": { "nullable": true }, "errorMessage": { "nullable": true }, "reqId": { "nullable": true }, "status": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "nullable": true } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "CDSL Return", "tags": [ "holdings" ], "x-request-schema-file": "schemas/requests/holdings/get-v2-cdsl-return.json" } }, "/v2/cdsl/tpin/generate": { "get": { "description": "Generates a CDSL TPIN (Transaction Personal Identification Number) for the client's Beneficiary Owner (BO) ID. CDSL sends a one-time OTP to the client's registered mobile number. The client must then use this TPIN/OTP on the CDSL portal to complete eDIS authorization before selling holdings.", "operationId": "get-v2-cdsl-tpin-generate", "parameters": [ { "allowEmptyValue": true, "example": "\u003cstring\u003e", "in": "query", "name": "dpId", "required": true, "schema": { "description": "Depository Participant ID of the client. Passed as a query parameter.", "type": "string", "x-data-type": "string" } }, { "allowEmptyValue": true, "example": "\u003cstring\u003e", "in": "query", "name": "boId", "required": true, "schema": { "description": "Beneficiary Owner ID (demat account number) of the client. Passed as a query parameter.", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": null, "result": [ { "ErrorCode": null, "ReqId": null, "ResId": null, "ResTime": null, "Status": null } ], "status": null }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "nullable": true }, "result": { "items": { "properties": { "ErrorCode": { "nullable": true }, "ReqId": { "nullable": true }, "ResId": { "nullable": true }, "ResTime": { "nullable": true }, "Status": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "nullable": true } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "CDSL Generate TPIN", "tags": [ "holdings" ], "x-request-schema-file": "schemas/requests/holdings/get-v2-cdsl-tpin-generate.json" } }, "/v2/holdings/cdsl/authorize": { "get": { "description": "Retrieves the current status of a previously submitted CDSL TPIN/OTP authorization request. Poll this endpoint after calling POST /v2/holdings/cdsl/authorize to determine whether the client has completed authorization on the CDSL portal.", "operationId": "get-v2-holdings-cdsl-authorize", "parameters": [ { "allowEmptyValue": true, "example": "\u003cstring\u003e", "in": "query", "name": "reqId", "required": true, "schema": { "description": "The request ID returned by POST /v2/holdings/cdsl/authorize. Passed as a query parameter.", "type": "string", "x-data-type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": null, "result": [ { "authStatus": null, "boId": null, "dpId": null, "errorCode": null, "errorMessage": null, "reqId": null } ], "status": null }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "nullable": true }, "result": { "items": { "properties": { "authStatus": { "nullable": true }, "boId": { "nullable": true }, "dpId": { "nullable": true }, "errorCode": { "nullable": true }, "errorMessage": { "nullable": true }, "reqId": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "nullable": true } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Get CDSL Authorization Status", "tags": [ "holdings" ], "x-request-schema-file": "schemas/requests/holdings/get-v2-holdings-cdsl-authorize.json" }, "post": { "description": "Generates an encrypted CDSL eDIS payload and redirect URL so the client can authorize demat share sales via TPIN on the CDSL portal. Must be called before placing a sell order for holdings not covered by POA. Redirect the client to the returned url to complete TPIN verification on the CDSL portal.", "operationId": "post-v2-holdings-cdsl-authorize", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "dpId": "120417500", "transDtls": { "boId": "12042", "exId": "11", "execDate": "30032026", "numberOfDays": "1", "recordDtls": [ { "isIn": "INE945F01025", "quantity": "100" }, { "isIn": "INE614G01033", "quantity": "36" } ], "reqIdentifier": "S", "reqType": "D" }, "userId": "dk2200295" }, "schema": { "properties": { "dpId": { "description": "Depository Participant ID of the broker.", "type": "string", "x-data-type": "string" }, "transDtls": { "description": "Transaction details object for authorization.", "properties": { "boId": { "description": "Client Demat (BO) account ID.", "type": "string", "x-data-type": "string" }, "exId": { "description": "Exchange ID (\"11\" = NSE, \"12\" = BSE).", "type": "string", "x-data-type": "string" }, "execDate": { "description": "Authorization execution date (format: DDMMYYYY).", "format": "date-ddmmyyyy", "type": "string", "x-data-type": "date-ddmmyyyy" }, "numberOfDays": { "description": "Number of days the authorization is valid.", "type": "string", "x-data-type": "string" }, "recordDtls": { "description": "List of securities to authorize for selling.", "items": { "properties": { "isIn": { "description": "ISIN of the security to authorize.", "type": "string", "x-data-type": "string" }, "quantity": { "description": "Quantity of the security to authorize for sale.", "type": "string", "x-data-type": "string" } }, "required": [ "isIn", "quantity" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" }, "reqIdentifier": { "description": "Request identifier (\"S\" = sell authorization).", "type": "string", "x-data-type": "string" }, "reqType": { "description": "Request type (\"D\" = Debit/sell authorization).", "type": "string", "x-data-type": "string" } }, "required": [ "reqType", "reqIdentifier", "boId", "exId", "numberOfDays", "execDate", "recordDtls" ], "type": "object", "x-data-type": "object" }, "userId": { "description": "Internal user/client ID.", "type": "string", "x-data-type": "string" } }, "required": [ "dpId", "userId", "transDtls" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "dpId": "41500", "reqId": "1231752468853", "revokDtls": null, "transDtls": "5fgmswmi2AnPGoWXswTJaI7qLgvQT/C0KeBn3dwsEVI8BF37i...", "url": "https://edis.cdslindia.com/EDIS/VerifyDIS/", "version": "1.2" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "dpId": { "type": "string" }, "reqId": { "type": "string" }, "revokDtls": { "nullable": true }, "transDtls": { "type": "string" }, "url": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Authorize CDSL Holdings", "tags": [ "holdings" ], "x-request-schema-file": "schemas/requests/holdings/post-v2-holdings-cdsl-authorize.json" } }, "/v2/holdings/mtf": { "get": { "description": "Retrieves the client's MTF (Margin Trading Facility) holdings across scrips, including quantities held/pledged, realized and unrealized P\u0026L, and per-exchange instrument details.", "operationId": "get-v2-holdings-mtf", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": null, "result": [ { "holdings": [ { "amoAuthQty": null, "authFlag": null, "authQty": null, "benQty": null, "brkCollQty": null, "btstQty": null, "buyPrice": null, "collateralQty": null, "dpQty": null, "holdQty": null, "isAmoAuth": null, "isin": null, "netPnl": null, "netQty": null, "realizedPnl": null, "sellAmount": null, "sellableQty": null, "symbol": [ { "exchange": null, "ltp": null, "pdc": null, "token": null, "tradingSymbol": null } ], "tradedQty": null, "unpledgedQty": null, "unrealizedPnl": null, "usedQty": null } ], "poa": null, "product": null } ], "status": null }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "nullable": true }, "result": { "items": { "properties": { "holdings": { "items": { "properties": { "amoAuthQty": { "nullable": true }, "authFlag": { "nullable": true }, "authQty": { "nullable": true }, "benQty": { "nullable": true }, "brkCollQty": { "nullable": true }, "btstQty": { "nullable": true }, "buyPrice": { "nullable": true }, "collateralQty": { "nullable": true }, "dpQty": { "nullable": true }, "holdQty": { "nullable": true }, "isAmoAuth": { "nullable": true }, "isin": { "nullable": true }, "netPnl": { "nullable": true }, "netQty": { "nullable": true }, "realizedPnl": { "nullable": true }, "sellAmount": { "nullable": true }, "sellableQty": { "nullable": true }, "symbol": { "items": { "properties": { "exchange": { "nullable": true }, "ltp": { "nullable": true }, "pdc": { "nullable": true }, "token": { "nullable": true }, "tradingSymbol": { "nullable": true } }, "type": "object" }, "type": "array" }, "tradedQty": { "nullable": true }, "unpledgedQty": { "nullable": true }, "unrealizedPnl": { "nullable": true }, "usedQty": { "nullable": true } }, "type": "object" }, "type": "array" }, "poa": { "nullable": true }, "product": { "nullable": true } }, "type": "object" }, "type": "array" }, "status": { "nullable": true } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Holdings MTF", "tags": [ "holdings" ], "x-request-schema-file": "schemas/requests/holdings/get-v2-holdings-mtf.json" } }, "/v2/info/gtt/orderbook": { "get": { "description": "● NEW — Newly added endpoint\n\nFetches all pending (un-triggered) GTT orders for the authenticated client, including full conditional trigger parameters.", "operationId": "get-v2-info-gtt-orderbook", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success (synthetic mock; no source response example)", "result": [ { "disclosedQty": "1", "exchange": "NSE", "formattedInsName": "mock", "gttType": "mock", "gttValue": "100.00", "lotSize": "1", "oiVariables": [ { "d": "mock", "var_name": "mock" } ], "orderNo": "MOCK-ORDER-001", "orderTime": "mock", "orderType": "Regular", "placeOrderParams": {}, "placeOrderParamsleg2": {}, "price": "100.00", "priceType": "L", "priceprecision": "100.00", "product": "CNC", "qty": "1", "remarks": "mock", "tickSize": "1", "token": "10001", "tradingSymbol": "MOCK-EQ", "transType": "B", "validity": "mock" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "disclosedQty": { "type": "string" }, "exchange": { "type": "string" }, "formattedInsName": { "type": "string" }, "gttType": { "type": "string" }, "gttValue": { "type": "string" }, "lotSize": { "type": "string" }, "oiVariables": { "items": { "properties": { "d": { "type": "string" }, "var_name": { "type": "string" } }, "type": "object" }, "type": "array" }, "orderNo": { "type": "string" }, "orderTime": { "type": "string" }, "orderType": { "type": "string" }, "placeOrderParams": { "properties": {}, "type": "object" }, "placeOrderParamsleg2": { "properties": {}, "type": "object" }, "price": { "type": "string" }, "priceType": { "type": "string" }, "priceprecision": { "type": "string" }, "product": { "type": "string" }, "qty": { "type": "string" }, "remarks": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "transType": { "type": "string" }, "validity": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GTT Orderbook", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/get-v2-info-gtt-orderbook.json" } }, "/v2/info/history": { "post": { "description": "Retrieves the detailed lifecycle of an order including every state transition, fill details, and exchange timestamps. Each element in result represents one status transition.", "operationId": "post-v2-info-history", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "orderNo": "26041000060875" }, "schema": { "properties": { "orderNo": { "type": "string", "x-data-type": "string" } }, "type": "object", "x-data-type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success (synthetic mock; no source response example)", "result": [ { "actId": "mock", "algoId": "mock", "appKey": "mock", "avgPrice": "100.00", "brokerUpdateTime": "2026-09-30 09:15:00", "cancelledQuantity": 1, "clientId": "MOCK-CLIENT-001", "companyName": "mock", "disclosedQty": "1", "exchOrderNo": "mock", "exchTime": "mock", "exchange": "NSE", "exchangeOrderId": "mock", "fillId": "mock", "fillPrice": "100.00", "fillshares": "1", "formattedInstrumentName": "mock", "gtdValidityDate": "mock", "instrumentId": "mock", "lotSize": "1", "mainLegOrderId": "mock", "mktpro": "mock", "orderNo": "MOCK-ORDER-001", "orderTag": "mock", "orderType": "Regular", "placedBy": "mock", "price": "100.00", "pricePrecision": "100.00", "priceType": "L", "product": "CNC", "quantity": "1", "rejectedReason": "", "remarks": "mock", "report": "mock", "ret": "DAY", "slTriggerPrice": 100, "source": "mock", "status": "Ok", "stopLossPrice": 100, "targetPrice": 100, "tickSize": "1", "time": "mock", "token": "10001", "tradeId": "mock", "tradingSymbol": "MOCK-EQ", "transType": "B", "triggerId": "mock", "unFillShares": "1", "userId": "MOCK-CLIENT-001" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "actId": { "type": "string" }, "algoId": { "type": "string" }, "appKey": { "type": "string" }, "avgPrice": { "type": "string" }, "brokerUpdateTime": { "type": "string" }, "cancelledQuantity": { "type": "integer" }, "clientId": { "type": "string" }, "companyName": { "type": "string" }, "disclosedQty": { "type": "string" }, "exchOrderNo": { "type": "string" }, "exchTime": { "type": "string" }, "exchange": { "type": "string" }, "exchangeOrderId": { "type": "string" }, "fillId": { "type": "string" }, "fillPrice": { "type": "string" }, "fillshares": { "type": "string" }, "formattedInstrumentName": { "type": "string" }, "gtdValidityDate": { "type": "string" }, "instrumentId": { "type": "string" }, "lotSize": { "type": "string" }, "mainLegOrderId": { "type": "string" }, "mktpro": { "type": "string" }, "orderNo": { "type": "string" }, "orderTag": { "type": "string" }, "orderType": { "type": "string" }, "placedBy": { "type": "string" }, "price": { "type": "string" }, "pricePrecision": { "type": "string" }, "priceType": { "type": "string" }, "product": { "type": "string" }, "quantity": { "type": "string" }, "rejectedReason": { "type": "string" }, "remarks": { "type": "string" }, "report": { "type": "string" }, "ret": { "type": "string" }, "slTriggerPrice": { "type": "integer" }, "source": { "type": "string" }, "status": { "type": "string" }, "stopLossPrice": { "type": "integer" }, "targetPrice": { "type": "integer" }, "tickSize": { "type": "string" }, "time": { "type": "string" }, "token": { "type": "string" }, "tradeId": { "type": "string" }, "tradingSymbol": { "type": "string" }, "transType": { "type": "string" }, "triggerId": { "type": "string" }, "unFillShares": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Order History", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-info-history.json" } }, "/v2/info/log/asmgsm": { "post": { "description": "● NEW — Newly added endpoint\n\nChecks whether a given scrip is under the ASM (Additional Surveillance Measure) or GSM (Graded Surveillance Measure) framework, and logs the user's acknowledgement. This check is typically required before placing orders on restricted scrips.", "operationId": "post-v2-info-log-asmgsm", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "action": "YES", "exch": "NSE", "message": "ASMGSM", "orderType": "S", "scripName": "HINDCOPPER-EQ", "token": "17939" }, "schema": { "properties": { "action": { "description": "\"YES\" to acknowledge the ASM / GSM restriction.", "type": "string", "x-data-type": "string" }, "exch": { "description": "Exchange code (NSE, BSE).", "type": "string", "x-data-type": "string" }, "message": { "description": "Restriction type label — \"ASMGSM\".", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Intended transaction type (B / S).", "type": "string", "x-data-type": "string" }, "scripName": { "description": "Trading symbol of the restricted scrip.", "type": "string", "x-data-type": "string" }, "token": { "description": "Scrip token.", "type": "string", "x-data-type": "string" } }, "required": [ "action", "scripName", "message", "orderType", "exch", "token" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": null, "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "nullable": true }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "ASM/GSM Log Check", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-info-log-asmgsm.json" } }, "/v2/info/orderbook": { "get": { "description": "Fetches all orders placed by the client in the current session with live status. Fields marked with \"/\" are cross-broker aliases with the same meaning.", "operationId": "get-v2-info-orderbook", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success (synthetic mock; no source response example)", "result": [ { "accountId": "1", "algoId": "mock", "appKey": "mock", "avgTradePrice": "100.00", "bqty": "1", "branchId": "mock", "broker": "mock", "brokerUpdateTime": "2026-09-30 09:15:00", "cancelledSize": "1", "clientId": "MOCK-CLIENT-001", "comments": "mock", "companyName": "mock", "continueFlag": "mock", "derivative": "mock", "disclosedQty": "1", "exchSeg": "mock", "exchUpdateTime": "2026-09-30 09:15:00", "exchange": "NSE", "exchangeOrderId": "mock", "fieldType": "mock", "fillShares": "1", "fillSize": "1", "formattedInsName": "mock", "gtdValidityDate": "mock", "initiatedBy": "mock", "isGTT": "mock", "itemId": "mock", "lotSize": "1", "ltp": "100.00", "mainLegOrderId": "mock", "mktProtection": "mock", "modifiedBy": "mock", "multiplier": "100.00", "naicCode": "mock", "namedItem": "mock", "nestOrderNumber": "mock", "numOfDays": "mock", "operation": "mock", "orderDuration": "mock", "orderInitialStatus": "OPEN", "orderNo": "MOCK-ORDER-001", "orderSource": "mock", "orderStatus": "OPEN", "orderTag": "mock", "orderTime": "mock", "orderType": "Regular", "orderValidityDate": "mock", "placedBy": "mock", "price": "100.00", "priceToFill": "100.00", "priceType": "L", "product": "CNC", "qty": "1", "qtyToFill": "1", "rejectedReason": "", "reportType": "mock", "ret": "DAY", "rprice": "100.00", "rqty": "1", "sdate": "mock", "secondsSinceBoeOrder": "mock", "slTriggerPrice": 100, "snoFillid": "mock", "snoOrderNumber": "mock", "sourceUserId": "mock", "stopLoss": "100.00", "symbol": "MOCK", "target": "100.00", "tickSize": "1", "tmOrderNumber": "mock", "token": "10001", "tradingSymbol": "MOCK-EQ", "trailingPrice": "100.00", "transType": "B", "triggerId": "mock", "triggerPrice": "100.00", "unFillShares": "1", "userId": "MOCK-CLIENT-001" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "accountId": { "type": "string" }, "algoId": { "type": "string" }, "appKey": { "type": "string" }, "avgTradePrice": { "type": "string" }, "bqty": { "type": "string" }, "branchId": { "type": "string" }, "broker": { "type": "string" }, "brokerUpdateTime": { "type": "string" }, "cancelledSize": { "type": "string" }, "clientId": { "type": "string" }, "comments": { "type": "string" }, "companyName": { "type": "string" }, "continueFlag": { "type": "string" }, "derivative": { "type": "string" }, "disclosedQty": { "type": "string" }, "exchSeg": { "type": "string" }, "exchUpdateTime": { "type": "string" }, "exchange": { "type": "string" }, "exchangeOrderId": { "type": "string" }, "fieldType": { "type": "string" }, "fillShares": { "type": "string" }, "fillSize": { "type": "string" }, "formattedInsName": { "type": "string" }, "gtdValidityDate": { "type": "string" }, "initiatedBy": { "type": "string" }, "isGTT": { "type": "string" }, "itemId": { "type": "string" }, "lotSize": { "type": "string" }, "ltp": { "type": "string" }, "mainLegOrderId": { "type": "string" }, "mktProtection": { "type": "string" }, "modifiedBy": { "type": "string" }, "multiplier": { "type": "string" }, "naicCode": { "type": "string" }, "namedItem": { "type": "string" }, "nestOrderNumber": { "type": "string" }, "numOfDays": { "type": "string" }, "operation": { "type": "string" }, "orderDuration": { "type": "string" }, "orderInitialStatus": { "type": "string" }, "orderNo": { "type": "string" }, "orderSource": { "type": "string" }, "orderStatus": { "type": "string" }, "orderTag": { "type": "string" }, "orderTime": { "type": "string" }, "orderType": { "type": "string" }, "orderValidityDate": { "type": "string" }, "placedBy": { "type": "string" }, "price": { "type": "string" }, "priceToFill": { "type": "string" }, "priceType": { "type": "string" }, "product": { "type": "string" }, "qty": { "type": "string" }, "qtyToFill": { "type": "string" }, "rejectedReason": { "type": "string" }, "reportType": { "type": "string" }, "ret": { "type": "string" }, "rprice": { "type": "string" }, "rqty": { "type": "string" }, "sdate": { "type": "string" }, "secondsSinceBoeOrder": { "type": "string" }, "slTriggerPrice": { "type": "integer" }, "snoFillid": { "type": "string" }, "snoOrderNumber": { "type": "string" }, "sourceUserId": { "type": "string" }, "stopLoss": { "type": "string" }, "symbol": { "type": "string" }, "target": { "type": "string" }, "tickSize": { "type": "string" }, "tmOrderNumber": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "trailingPrice": { "type": "string" }, "transType": { "type": "string" }, "triggerId": { "type": "string" }, "triggerPrice": { "type": "string" }, "unFillShares": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Orderbook", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/get-v2-info-orderbook.json" } }, "/v2/info/sip/orderbook": { "get": { "description": "● NEW — Newly added endpoint\n\nFetches all active, paused, and recently completed SIP orders for the authenticated client.", "operationId": "get-v2-info-sip-orderbook", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success (synthetic mock; no source response example)", "result": [ { "endPeriod": "mock", "frequency": "mock", "orderNo": "MOCK-ORDER-001", "regDate": "mock", "scrips": [], "sipName": "mock", "startDate": "mock", "status": "Ok" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "endPeriod": { "type": "string" }, "frequency": { "type": "string" }, "orderNo": { "type": "string" }, "regDate": { "type": "string" }, "scrips": { "items": {}, "type": "array" }, "sipName": { "type": "string" }, "startDate": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SIP Orderbook", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/get-v2-info-sip-orderbook.json" } }, "/v2/info/tradebook": { "get": { "description": "Returns all fully or partially executed trades for the current session with trade price, quantity, fill time and exchange reference. Only filled trades appear here.", "operationId": "get-v2-info-tradebook", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success (synthetic mock; no source response example)", "result": [ { "actId": "mock", "algoId": "mock", "bqty": "1", "brokerUpdateTime": "2026-09-30 09:15:00", "clientId": "MOCK-CLIENT-001", "exchUpdateTime": "2026-09-30 09:15:00", "exchange": "NSE", "exchangeOrderId": "mock", "exchangeTradeId": "mock", "fillId": "mock", "fillTime": "mock", "fillprc": "mock", "fillqty": "1", "fillshares": "1", "formattedInsName": "mock", "lotSize": "1", "ltp": "100.00", "multiplier": "100.00", "orderNo": "MOCK-ORDER-001", "orderTag": "mock", "orderTime": "mock", "orderType": "Regular", "placedBy": "mock", "prcftr": "mock", "price": "100.00", "pricePrecision": "100.00", "priceType": "L", "product": "CNC", "qty": "1", "ret": "DAY", "symbol": "MOCK", "tickSize": "1", "token": "10001", "tradingSymbol": "MOCK-EQ", "transType": "B", "triggerId": "mock", "userId": "MOCK-CLIENT-001" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "actId": { "type": "string" }, "algoId": { "type": "string" }, "bqty": { "type": "string" }, "brokerUpdateTime": { "type": "string" }, "clientId": { "type": "string" }, "exchUpdateTime": { "type": "string" }, "exchange": { "type": "string" }, "exchangeOrderId": { "type": "string" }, "exchangeTradeId": { "type": "string" }, "fillId": { "type": "string" }, "fillTime": { "type": "string" }, "fillprc": { "type": "string" }, "fillqty": { "type": "string" }, "fillshares": { "type": "string" }, "formattedInsName": { "type": "string" }, "lotSize": { "type": "string" }, "ltp": { "type": "string" }, "multiplier": { "type": "string" }, "orderNo": { "type": "string" }, "orderTag": { "type": "string" }, "orderTime": { "type": "string" }, "orderType": { "type": "string" }, "placedBy": { "type": "string" }, "prcftr": { "type": "string" }, "price": { "type": "string" }, "pricePrecision": { "type": "string" }, "priceType": { "type": "string" }, "product": { "type": "string" }, "qty": { "type": "string" }, "ret": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "transType": { "type": "string" }, "triggerId": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Tradebook", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/get-v2-info-tradebook.json" } }, "/v2/orders/cancel": { "post": { "description": "Cancels an existing pending or open order using the order ID. Only orders in OPEN or TRIGGER_PENDING state can be cancelled; executed orders cannot be reversed here.", "operationId": "post-v2-orders-cancel", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "deviceNumber": "960cbe75300823e3e8b120eb2d8e3110", "exchange": "NSE", "orderNo": "26041000035758", "orderType": "Regular", "source": "WEB" } ], "schema": { "items": { "properties": { "deviceNumber": { "description": "Unique device identifier of the client's device.", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange where the order exists; some brokers may omit.", "type": "string", "x-data-type": "string" }, "orderNo": { "description": "Unique identifier of the order to be cancelled. Mock Provider uses brokerOrderId.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order category (Regular, AMO, Bracket); required by some brokers.", "type": "string", "x-data-type": "string" }, "source": { "description": "Source platform (WEB, MOB).", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041000035758", "requestTime": "09:59:57 10-04-2026" } ], "status": "Ok" } ], "schema": { "items": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" }, "requestTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Cancel Orders", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-cancel.json" } }, "/v2/orders/execute": { "post": { "description": "Places a new buy or sell order. Supports all order types (LIMIT, MARKET, SL, SL-M) and product codes (CNC, MIS, NRML, NORMAL, MTF). Same schema serves /v2/orders/execute and /v2/orders/web/execute.", "operationId": "post-v2-orders-execute", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "deviceNumber": "a54222da13c1a6c32d7581130aff0baf", "disclosedQty": "0", "exchange": "NFO", "ltp": "", "mktProtection": "", "orderType": "Regular", "positionSqrOff": "", "price": 685, "priceType": "L", "product": "NRML", "qty": "65", "remarks": "Regular", "ret": "DAY", "source": "WEB", "stopLoss": "", "target": "", "token": "72200", "tradingSymbol": "NIFTY28APR26P22800", "trailingPrice": "", "trailingStopLoss": "", "transType": "B", "triggerPrice": "" } ], "schema": { "items": { "properties": { "deviceNumber": { "description": "Unique device identifier of the client. Mock Provider uses deviceId.", "type": "string", "x-data-type": "string" }, "disclosedQty": { "description": "Disclosed quantity for iceberg orders. Mock Provider uses disclosedQuantity.", "nullable": true, "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange to place the order on (NSE, BSE, NFO, BFO, MCX).", "type": "string", "x-data-type": "string" }, "ltp": { "description": "Last traded price snapshot; empty if not provided.", "type": "string", "x-data-type": "string" }, "mktProtection": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "boolean", "x-data-type": "boolean" } ], "description": "Market-protection % for MKT orders. Mock Provider/Mock Provider accept true / false / \"1\".", "x-data-type": "union" }, "orderType": { "description": "Order category. Legacy: Regular, AMO, Bracket, Cover. Mock Provider: REGULAR (orderComplexity) plus orderType = LIMIT / MARKET.", "type": "string", "x-data-type": "string" }, "positionSqrOff": { "description": "Position square-off flag (\"Y\" = square-off order).", "type": "string", "x-data-type": "string" }, "price": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Order price. 0 (or \"0.0\") for market orders.", "x-data-type": "union" }, "priceType": { "description": "Price type: L (Limit), MKT (Market), SL (Stop Loss), SL-M (Stop Loss Market).", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code. Accepted: CNC, MIS, NRML, NORMAL (Mock Provider), MTF.", "type": "string", "x-data-type": "string" }, "qty": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Order quantity. Mock Provider uses quantity as Number.", "x-data-type": "union" }, "remarks": { "description": "Custom remark or tag. Mock Provider uses orderTag (e.g., MOBANDROID_Normal_REGULAR).", "type": "string", "x-data-type": "string" }, "ret": { "description": "Order retention / validity. Values: DAY, IOC, EOS, EXPIRY, GTT.", "type": "string", "x-data-type": "string" }, "source": { "description": "Origin platform: WEB, MOB, IBT-EX, ADMINCPPAPI_MOB, API. Mock Provider secondary field: apiOrderSource.", "type": "string", "x-data-type": "string" }, "stopLoss": { "description": "Stop-loss value for bracket / cover orders. Mock Provider uses stopLossPrice.", "nullable": true, "type": "string", "x-data-type": "string" }, "target": { "description": "Target price for bracket orders. Mock Provider uses targetPrice.", "nullable": true, "type": "string", "x-data-type": "string" }, "token": { "description": "Unique scrip token for the trading symbol. Mock Provider uses instrumentId with the same meaning.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol of the instrument (e.g., NIFTY28APR26P22800).", "type": "string", "x-data-type": "string" }, "trailingPrice": { "description": "Value by which the stop-loss trails the market to lock in profits.", "type": "string", "x-data-type": "string" }, "trailingStopLoss": { "description": "Trailing stop-loss value.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type. Short form: B / S. Long form (Mock Provider): BUY / SELL.", "type": "string", "x-data-type": "string" }, "triggerPrice": { "description": "Trigger price for SL / SL-M orders; empty for others.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token", "tradingSymbol", "transType", "qty", "price", "priceType", "orderType", "product", "ret", "source" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "infoMessage": null, "message": "Success", "result": [ { "brokerOrderId": "260727000023174", "orderNo": "26040600000608", "requestTime": "09:59:34 06-04-2026", "triggerId": "", "uniqueOrderID": "1785123920384891" } ], "status": "Ok" } ], "schema": { "items": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "brokerOrderId": { "type": "string" }, "orderNo": { "type": "string" }, "requestTime": { "type": "string" }, "triggerId": { "type": "string" }, "uniqueOrderID": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Execute Orders", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-execute.json" } }, "/v2/orders/execute/basket": { "post": { "description": "● NEW — Newly added endpoint\n\nPlaces multiple orders atomically as a basket. Each element in the request array follows the same structure as Execute Orders (4.1). Orders are processed sequentially; each returns its own result object.", "operationId": "post-v2-orders-execute-basket", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "disclosedQty": null, "exchange": "NFO", "mktProtection": "", "orderNo": null, "orderType": "Regular", "price": "0", "priceType": "MKT", "product": "NRML", "qty": "195", "remark": null, "ret": "DAY", "source": "WEB", "stopLoss": "", "target": "", "token": "54805", "tradingSymbol": "NIFTY13APR26P23800", "trailingStopLoss": "", "transType": "S", "triggerPrice": "" }, { "exchange": "NFO", "qty": "195", "remark": null, "token": "54793", "tradingSymbol": "NIFTY13APR26P23500", "transType": "B" } ], "schema": { "items": { "anyOf": [ { "properties": { "disclosedQty": { "enum": [ null ], "nullable": true, "x-data-type": "null" }, "exchange": { "type": "string", "x-data-type": "string" }, "mktProtection": { "type": "string", "x-data-type": "string" }, "orderNo": { "enum": [ null ], "nullable": true, "x-data-type": "null" }, "orderType": { "type": "string", "x-data-type": "string" }, "price": { "type": "string", "x-data-type": "string" }, "priceType": { "type": "string", "x-data-type": "string" }, "product": { "type": "string", "x-data-type": "string" }, "qty": { "type": "string", "x-data-type": "string" }, "remark": { "enum": [ null ], "nullable": true, "x-data-type": "null" }, "ret": { "type": "string", "x-data-type": "string" }, "source": { "type": "string", "x-data-type": "string" }, "stopLoss": { "type": "string", "x-data-type": "string" }, "target": { "type": "string", "x-data-type": "string" }, "token": { "type": "string", "x-data-type": "string" }, "tradingSymbol": { "type": "string", "x-data-type": "string" }, "trailingStopLoss": { "type": "string", "x-data-type": "string" }, "transType": { "type": "string", "x-data-type": "string" }, "triggerPrice": { "type": "string", "x-data-type": "string" } }, "type": "object", "x-data-type": "object" }, { "properties": { "exchange": { "type": "string", "x-data-type": "string" }, "qty": { "type": "string", "x-data-type": "string" }, "remark": { "enum": [ null ], "nullable": true, "x-data-type": "null" }, "token": { "type": "string", "x-data-type": "string" }, "tradingSymbol": { "type": "string", "x-data-type": "string" }, "transType": { "type": "string", "x-data-type": "string" } }, "type": "object", "x-data-type": "object" } ], "x-data-type": "union" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041000034662", "requestTime": "09:54:57 10-04-2026" } ], "status": "Ok" }, { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041000034663", "requestTime": "09:54:57 10-04-2026" } ], "status": "Ok" } ], "schema": { "items": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" }, "requestTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Execute Basket Orders", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-execute-basket.json" } }, "/v2/orders/exit/sno": { "post": { "description": "● NEW — Newly added endpoint\n\nExits (closes out) a bracket or cover order by its order number. The request accepts an array so multiple child orders can be exited in a single call.", "operationId": "post-v2-orders-exit-sno", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "orderNo": "26041000062066", "orderType": "Bracket" }, { "orderNo": "26041000062067", "orderType": "Bracket" } ], "schema": { "items": { "properties": { "orderNo": { "description": "Order number of the bracket / cover order to exit.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order type — \"Bracket\" or \"Cover\".", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo", "orderType" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "infoMessage": null, "message": "Success", "result": [ "success" ], "status": "Ok" }, { "infoMessage": null, "message": "Success", "result": [ "success" ], "status": "Ok" } ], "schema": { "items": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "type": "string" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Exit SNO — Bracket / Cover Order", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-exit-sno.json" } }, "/v2/orders/gtt/cancel": { "post": { "description": "● NEW — Newly added endpoint\n\nCancels a pending GTT order. The full GTT order object (as returned by GTT Orderbook) must be sent in the request body.", "operationId": "post-v2-orders-gtt-cancel", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "disclosedQty": "", "exchange": "NSE", "formattedInsName": "ITC-EQ", "gttType": "LTP_B_O", "gttValue": "280.00", "lotSize": "1", "orderNo": "26040600000078", "orderTime": "10:33:12 06-04-2026", "orderType": "Regular", "price": "250.00", "priceType": "L", "priceprecision": "2", "product": "CNC", "qty": "1", "remarks": "", "tickSize": "0.05", "token": "1660", "tradingSymbol": "ITC-EQ", "transType": "S", "validity": "GTT" }, "schema": { "properties": { "disclosedQty": { "description": "Disclosed quantity; empty if not applicable.", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange of the GTT order.", "type": "string", "x-data-type": "string" }, "formattedInsName": { "description": "Formatted instrument name.", "type": "string", "x-data-type": "string" }, "gttType": { "description": "GTT trigger type.", "type": "string", "x-data-type": "string" }, "gttValue": { "description": "GTT trigger price level.", "type": "string", "x-data-type": "string" }, "lotSize": { "description": "Lot size of the instrument.", "type": "string", "x-data-type": "string" }, "orderNo": { "description": "GTT order number to cancel.", "type": "string", "x-data-type": "string" }, "orderTime": { "description": "Original order creation time.", "format": "date-time-dmy", "type": "string", "x-data-type": "date-time-dmy" }, "orderType": { "description": "Order category.", "type": "string", "x-data-type": "string" }, "price": { "description": "Order price.", "type": "string", "x-data-type": "string" }, "priceType": { "description": "Price type.", "type": "string", "x-data-type": "string" }, "priceprecision": { "description": "Price decimal precision.", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code.", "type": "string", "x-data-type": "string" }, "qty": { "description": "Order quantity.", "type": "string", "x-data-type": "string" }, "remarks": { "description": "Remarks; empty if none.", "type": "string", "x-data-type": "string" }, "tickSize": { "description": "Tick size of the instrument.", "type": "string", "x-data-type": "string" }, "token": { "description": "Scrip token.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type (B / S).", "type": "string", "x-data-type": "string" }, "validity": { "description": "Always \"GTT\".", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo", "exchange", "tradingSymbol", "token", "gttType", "gttValue", "validity", "transType", "priceType", "product", "qty", "price", "orderType", "orderTime", "priceprecision", "lotSize", "tickSize" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041100000556", "requestTime": "12:39:39 11-04-2026" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" }, "requestTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GTT Cancel", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-gtt-cancel.json" } }, "/v2/orders/gtt/execute": { "post": { "description": "● NEW — Newly added endpoint\n\nPlaces a Good Till Triggered conditional order. The order is queued and automatically placed when the market price meets the gttValue condition. GTT orders persist across sessions until triggered or cancelled.", "operationId": "post-v2-orders-gtt-execute", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exchange": "NSE", "gttType": "LTP_A_O", "gttValue": "9", "orderType": "Regular", "price": 9, "priceType": "L", "product": "CNC", "qty": "1", "ret": "DAY", "token": "14366", "tradingSymbol": "IDEA-EQ", "transType": "B", "validity": "GTT" }, "schema": { "properties": { "exchange": { "description": "Exchange (NSE, BSE, NFO, MCX).", "type": "string", "x-data-type": "string" }, "gttType": { "description": "GTT trigger type: LTP_A_O, LTP_B_O, LTP_A_52HIGH_O, LTP_B_52LOW_O.", "type": "string", "x-data-type": "string" }, "gttValue": { "description": "Price level at which the GTT order triggers.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order category (Regular).", "type": "string", "x-data-type": "string" }, "price": { "anyOf": [ { "type": "number", "x-data-type": "number" }, { "type": "integer", "x-data-type": "integer" } ], "description": "Order price when triggered.", "x-data-type": "union" }, "priceType": { "description": "Price type (L, MKT, SL).", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code (CNC, MIS, NRML).", "type": "string", "x-data-type": "string" }, "qty": { "description": "Order quantity.", "type": "string", "x-data-type": "string" }, "ret": { "description": "Order retention (DAY).", "type": "string", "x-data-type": "string" }, "token": { "description": "Unique scrip token.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol of the instrument.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type (B / S).", "type": "string", "x-data-type": "string" }, "validity": { "description": "Always \"GTT\" for GTT orders.", "type": "string", "x-data-type": "string" } }, "required": [ "tradingSymbol", "exchange", "token", "transType", "priceType", "product", "ret", "qty", "price", "orderType", "gttType", "gttValue", "validity" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041000000448", "requestTime": "10:58:35 10-04-2026" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" }, "requestTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GTT Execute (Good Till Triggered)", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-gtt-execute.json" } }, "/v2/orders/gtt/modify": { "post": { "description": "● NEW — Newly added endpoint\n\nModifies an existing pending GTT order. All original fields must be sent along with updated values and the existing orderNo.", "operationId": "post-v2-orders-gtt-modify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exchange": "NSE", "gttType": "LTP_A_O", "gttValue": "8.25", "orderNo": "26041100000556", "orderType": "Regular", "price": "9.00", "priceType": "L", "product": "CNC", "qty": "1", "ret": "DAY", "token": "14366", "tradingSymbol": "IDEA-EQ", "transType": "B", "validity": "GTT" }, "schema": { "properties": { "exchange": { "description": "Exchange (NSE, BSE, NFO, MCX).", "type": "string", "x-data-type": "string" }, "gttType": { "description": "GTT trigger type (see GTT Execute).", "type": "string", "x-data-type": "string" }, "gttValue": { "description": "Revised GTT trigger price level.", "type": "string", "x-data-type": "string" }, "orderNo": { "description": "Existing GTT order number to be modified.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order category (Regular).", "type": "string", "x-data-type": "string" }, "price": { "description": "Revised order price.", "type": "string", "x-data-type": "string" }, "priceType": { "description": "Price type (L, MKT, SL).", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code.", "type": "string", "x-data-type": "string" }, "qty": { "description": "Revised order quantity.", "type": "string", "x-data-type": "string" }, "ret": { "description": "Order retention (DAY).", "type": "string", "x-data-type": "string" }, "token": { "description": "Unique scrip token.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol of the instrument.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type (B / S).", "type": "string", "x-data-type": "string" }, "validity": { "description": "Always \"GTT\".", "type": "string", "x-data-type": "string" } }, "required": [ "tradingSymbol", "exchange", "token", "transType", "priceType", "product", "ret", "qty", "price", "orderType", "gttType", "gttValue", "validity", "orderNo" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041100000556", "requestTime": "12:31:45 11-04-2026" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" }, "requestTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "GTT Modify", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-gtt-modify.json" } }, "/v2/orders/modify": { "post": { "description": "Modifies the price, quantity, trigger price, or order type of an existing pending order. The order must be OPEN or TRIGGER_PENDING; the order ID is unchanged after modification.", "operationId": "post-v2-orders-modify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "deviceNumber": "9B48E058-D4C4-4CCF-8AB6-9E5F1097C84E", "disclosedQty": "", "exchange": "NFO", "filledQty": "0", "mktProtection": "", "multiplier": null, "orderNo": "26041000037861", "orderType": "Regular", "price": "159.00", "priceType": "SL", "product": "NRML", "qty": "715", "ret": "DAY", "stopLoss": "", "target": "", "token": "54810", "tradedQty": "0", "tradingSymbol": "NIFTY13APR26C23950", "trailingPrice": "", "trailingStopLoss": "", "transType": "S", "triggerPrice": "159.00" }, "schema": { "properties": { "deviceNumber": { "description": "Unique device identifier of the client's device.", "type": "string", "x-data-type": "string" }, "disclosedQty": { "description": "Disclosed quantity for iceberg orders.", "nullable": true, "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange where the order was placed.", "type": "string", "x-data-type": "string" }, "filledQty": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Quantity already filled for the order.", "x-data-type": "union" }, "mktProtection": { "description": "Market-protection %; empty if not applicable.", "type": "string", "x-data-type": "string" }, "multiplier": { "description": "Multiplier for bracket order target / stop loss; null if not applicable.", "nullable": true, "type": "string", "x-data-type": "string" }, "orderNo": { "description": "Existing order number to be modified.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order category (Regular / REGULAR / AMO / Bracket).", "type": "string", "x-data-type": "string" }, "price": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Revised order price; 0 for market orders.", "x-data-type": "union" }, "priceType": { "description": "Price type (L, MKT, SL, SL-M, LIMIT, MARKET).", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code (CNC, MIS, NRML, NORMAL, MTF).", "type": "string", "x-data-type": "string" }, "qty": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Revised order quantity.", "x-data-type": "union" }, "ret": { "description": "Order retention (DAY, IOC).", "type": "string", "x-data-type": "string" }, "stopLoss": { "description": "Revised stop-loss value; empty if not applicable.", "nullable": true, "type": "string", "x-data-type": "string" }, "target": { "description": "Revised target price; null / empty if not applicable.", "nullable": true, "type": "string", "x-data-type": "string" }, "token": { "description": "Unique scrip token; Mock Provider uses instrumentId.", "type": "string", "x-data-type": "string" }, "tradedQty": { "description": "Quantity already traded for the order.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol of the instrument.", "type": "string", "x-data-type": "string" }, "trailingPrice": { "description": "Trailing price for dynamic stop-loss.", "type": "string", "x-data-type": "string" }, "trailingStopLoss": { "description": "Revised trailing stop-loss.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type (B / S or BUY / SELL).", "type": "string", "x-data-type": "string" }, "triggerPrice": { "description": "Revised trigger price for SL / SL-M; empty if not applicable.", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo", "exchange", "token", "tradingSymbol", "transType", "qty", "price", "priceType", "product", "orderType", "ret" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "brokerOrderId": "260727000021493", "orderNo": "26041000037861", "requestTime": "10:59:59 10-04-2026", "uniqueOrderID": "1785123945094431" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "brokerOrderId": { "type": "string" }, "orderNo": { "type": "string" }, "requestTime": { "type": "string" }, "uniqueOrderID": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Order Modify", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-modify.json" } }, "/v2/orders/oco/cancel": { "post": { "description": "● NEW — Newly added endpoint\n\nCancels a pending OCO alert order. Both legs are cancelled when this is called.", "operationId": "post-v2-orders-oco-cancel", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "alertId": "26040200000130", "exchange": "NFO" }, "schema": { "properties": { "alertId": { "description": "OCO alert ID to cancel.", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange of the OCO order.", "type": "string", "x-data-type": "string" } }, "required": [ "alertId", "exchange" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "alertId": "26040200000130" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "alertId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "OCO Cancel", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-oco-cancel.json" } }, "/v2/orders/oco/execute": { "post": { "description": "● NEW — Newly added endpoint\n\nPlaces an OCO alert order. When one leg is triggered, the other is automatically cancelled. Used for setting take-profit and stop-loss levels simultaneously.", "operationId": "post-v2-orders-oco-execute", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "exchange": "NFO", "ocoOrders": [], "token": "167329" }, "schema": { "properties": { "exchange": { "description": "Exchange of the instrument.", "type": "string", "x-data-type": "string" }, "ocoOrders": { "description": "Array of OCO order legs (target and stop-loss conditions).", "items": { "nullable": true, "x-data-type": "any" }, "type": "array", "x-data-type": "array" }, "token": { "description": "Scrip token for the instrument.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token", "ocoOrders" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "alertId": "26040200000130" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "alertId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "OCO Execute (One-Cancels-Other)", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-oco-execute.json" } }, "/v2/orders/oco/modify": { "post": { "description": "● NEW — Newly added endpoint\n\nModifies the conditions of an existing pending OCO alert order.", "operationId": "post-v2-orders-oco-modify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "alertId": "26040200000118", "exchange": "NFO" }, "schema": { "properties": { "alertId": { "description": "Existing OCO alert ID to modify.", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange of the OCO order.", "type": "string", "x-data-type": "string" } }, "required": [ "alertId", "exchange" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "alertId": "26040200000118" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "alertId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "OCO Modify", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-oco-modify.json" } }, "/v2/orders/orderbook": { "get": { "description": "Fetches all orders placed by the client in the current session with live status. Fields marked with \"/\" are cross-broker aliases with the same meaning.", "operationId": "get-v2-orders-orderbook", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success (synthetic mock; no source response example)", "result": [ { "accountId": "1", "algoId": "mock", "appKey": "mock", "avgTradePrice": "100.00", "bqty": "1", "branchId": "mock", "broker": "mock", "brokerUpdateTime": "2026-09-30 09:15:00", "cancelledSize": "1", "clientId": "MOCK-CLIENT-001", "comments": "mock", "companyName": "mock", "continueFlag": "mock", "derivative": "mock", "disclosedQty": "1", "exchSeg": "mock", "exchUpdateTime": "2026-09-30 09:15:00", "exchange": "NSE", "exchangeOrderId": "mock", "fieldType": "mock", "fillShares": "1", "fillSize": "1", "formattedInsName": "mock", "gtdValidityDate": "mock", "initiatedBy": "mock", "isGTT": "mock", "itemId": "mock", "lotSize": "1", "ltp": "100.00", "mainLegOrderId": "mock", "mktProtection": "mock", "modifiedBy": "mock", "multiplier": "100.00", "naicCode": "mock", "namedItem": "mock", "nestOrderNumber": "mock", "numOfDays": "mock", "operation": "mock", "orderDuration": "mock", "orderInitialStatus": "OPEN", "orderNo": "MOCK-ORDER-001", "orderSource": "mock", "orderStatus": "OPEN", "orderTag": "mock", "orderTime": "mock", "orderType": "Regular", "orderValidityDate": "mock", "placedBy": "mock", "price": "100.00", "priceToFill": "100.00", "priceType": "L", "product": "CNC", "qty": "1", "qtyToFill": "1", "rejectedReason": "", "reportType": "mock", "ret": "DAY", "rprice": "100.00", "rqty": "1", "sdate": "mock", "secondsSinceBoeOrder": "mock", "slTriggerPrice": 100, "snoFillid": "mock", "snoOrderNumber": "mock", "sourceUserId": "mock", "stopLoss": "100.00", "symbol": "MOCK", "target": "100.00", "tickSize": "1", "tmOrderNumber": "mock", "token": "10001", "tradingSymbol": "MOCK-EQ", "trailingPrice": "100.00", "transType": "B", "triggerId": "mock", "triggerPrice": "100.00", "unFillShares": "1", "userId": "MOCK-CLIENT-001" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "accountId": { "type": "string" }, "algoId": { "type": "string" }, "appKey": { "type": "string" }, "avgTradePrice": { "type": "string" }, "bqty": { "type": "string" }, "branchId": { "type": "string" }, "broker": { "type": "string" }, "brokerUpdateTime": { "type": "string" }, "cancelledSize": { "type": "string" }, "clientId": { "type": "string" }, "comments": { "type": "string" }, "companyName": { "type": "string" }, "continueFlag": { "type": "string" }, "derivative": { "type": "string" }, "disclosedQty": { "type": "string" }, "exchSeg": { "type": "string" }, "exchUpdateTime": { "type": "string" }, "exchange": { "type": "string" }, "exchangeOrderId": { "type": "string" }, "fieldType": { "type": "string" }, "fillShares": { "type": "string" }, "fillSize": { "type": "string" }, "formattedInsName": { "type": "string" }, "gtdValidityDate": { "type": "string" }, "initiatedBy": { "type": "string" }, "isGTT": { "type": "string" }, "itemId": { "type": "string" }, "lotSize": { "type": "string" }, "ltp": { "type": "string" }, "mainLegOrderId": { "type": "string" }, "mktProtection": { "type": "string" }, "modifiedBy": { "type": "string" }, "multiplier": { "type": "string" }, "naicCode": { "type": "string" }, "namedItem": { "type": "string" }, "nestOrderNumber": { "type": "string" }, "numOfDays": { "type": "string" }, "operation": { "type": "string" }, "orderDuration": { "type": "string" }, "orderInitialStatus": { "type": "string" }, "orderNo": { "type": "string" }, "orderSource": { "type": "string" }, "orderStatus": { "type": "string" }, "orderTag": { "type": "string" }, "orderTime": { "type": "string" }, "orderType": { "type": "string" }, "orderValidityDate": { "type": "string" }, "placedBy": { "type": "string" }, "price": { "type": "string" }, "priceToFill": { "type": "string" }, "priceType": { "type": "string" }, "product": { "type": "string" }, "qty": { "type": "string" }, "qtyToFill": { "type": "string" }, "rejectedReason": { "type": "string" }, "reportType": { "type": "string" }, "ret": { "type": "string" }, "rprice": { "type": "string" }, "rqty": { "type": "string" }, "sdate": { "type": "string" }, "secondsSinceBoeOrder": { "type": "string" }, "slTriggerPrice": { "type": "integer" }, "snoFillid": { "type": "string" }, "snoOrderNumber": { "type": "string" }, "sourceUserId": { "type": "string" }, "stopLoss": { "type": "string" }, "symbol": { "type": "string" }, "target": { "type": "string" }, "tickSize": { "type": "string" }, "tmOrderNumber": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "trailingPrice": { "type": "string" }, "transType": { "type": "string" }, "triggerId": { "type": "string" }, "triggerPrice": { "type": "string" }, "unFillShares": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Orderbook", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/get-v2-orders-orderbook.json" } }, "/v2/orders/position/squareoff": { "post": { "description": "Places a counter order to square off all open intraday or F\u0026O positions for a given scrip. positionSqrOff must be \"Y\". Typically triggered by the client or the system at end-of-day.", "operationId": "post-v2-orders-position-squareoff", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "deviceNumber": "bff1c2ac04fde799", "disclosedQty": "", "exchange": "NFO", "mktProtection": "", "orderType": "Regular", "positionSqrOff": "Y", "price": "0", "priceType": "MKT", "product": "NRML", "qty": "500", "remarks": "", "ret": "DAY", "source": "MOB", "stopLoss": "", "target": "", "token": "133767", "tradingSymbol": "KFINTECH28APR26C920", "trailingPrice": "", "trailingStopLoss": "", "transType": "S", "triggerPrice": "" } ], "schema": { "items": { "properties": { "deviceNumber": { "description": "Unique device identifier.", "type": "string", "x-data-type": "string" }, "disclosedQty": { "description": "Disclosed quantity; empty if not applicable.", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange where the position exists.", "type": "string", "x-data-type": "string" }, "mktProtection": { "description": "Market-protection %.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order category (Regular, AMO, REGULAR).", "type": "string", "x-data-type": "string" }, "positionSqrOff": { "description": "\"Y\" to flag the order as position square-off.", "type": "string", "x-data-type": "string" }, "price": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Order price; 0 for market orders.", "x-data-type": "union" }, "priceType": { "description": "Price type (L, MKT, SL, SL-M).", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code of the open position (CNC, MIS, NRML, NORMAL).", "type": "string", "x-data-type": "string" }, "qty": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Quantity to square off.", "x-data-type": "union" }, "remarks": { "description": "Custom remark; empty if none.", "type": "string", "x-data-type": "string" }, "ret": { "description": "Order retention (DAY, IOC, EXPIRY).", "type": "string", "x-data-type": "string" }, "source": { "description": "Source platform (WEB, MOB).", "type": "string", "x-data-type": "string" }, "stopLoss": { "description": "Bracket / stop-loss related fields; empty for a plain sqroff.", "type": "string", "x-data-type": "string" }, "target": { "description": "Bracket / stop-loss related fields; empty for a plain sqroff.", "type": "string", "x-data-type": "string" }, "token": { "description": "Unique scrip token; Mock Provider uses instrumentId.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol of the instrument to square off.", "type": "string", "x-data-type": "string" }, "trailingPrice": { "description": "Bracket / stop-loss related fields; empty for a plain sqroff.", "type": "string", "x-data-type": "string" }, "trailingStopLoss": { "description": "Bracket / stop-loss related fields; empty for a plain sqroff.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type (B / S).", "type": "string", "x-data-type": "string" }, "triggerPrice": { "description": "Trigger price for SL orders; empty if not applicable.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token", "tradingSymbol", "transType", "qty", "price", "priceType", "product", "orderType", "ret", "positionSqrOff", "source" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041000063727", "requestTime": "10:59:48 10-04-2026" } ], "status": "Ok" } ], "schema": { "items": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" }, "requestTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Orders Position Square Off", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-position-squareoff.json" } }, "/v2/orders/positions/sqroff": { "post": { "description": "Places a counter order to square off all open intraday or F\u0026O positions for a given scrip. positionSqrOff must be \"Y\". Typically triggered by the client or the system at end-of-day.", "operationId": "post-v2-orders-positions-sqroff", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "deviceNumber": "bff1c2ac04fde799", "disclosedQty": "", "exchange": "NFO", "mktProtection": "", "orderType": "Regular", "positionSqrOff": "Y", "price": "0", "priceType": "MKT", "product": "NRML", "qty": "500", "remarks": "", "ret": "DAY", "source": "MOB", "stopLoss": "", "target": "", "token": "133767", "tradingSymbol": "KFINTECH28APR26C920", "trailingPrice": "", "trailingStopLoss": "", "transType": "S", "triggerPrice": "" } ], "schema": { "items": { "properties": { "deviceNumber": { "description": "Unique device identifier.", "type": "string", "x-data-type": "string" }, "disclosedQty": { "description": "Disclosed quantity; empty if not applicable.", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange where the position exists.", "type": "string", "x-data-type": "string" }, "mktProtection": { "description": "Market-protection %.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order category (Regular, AMO, REGULAR).", "type": "string", "x-data-type": "string" }, "positionSqrOff": { "description": "\"Y\" to flag the order as position square-off.", "type": "string", "x-data-type": "string" }, "price": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Order price; 0 for market orders.", "x-data-type": "union" }, "priceType": { "description": "Price type (L, MKT, SL, SL-M).", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code of the open position (CNC, MIS, NRML, NORMAL).", "type": "string", "x-data-type": "string" }, "qty": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Quantity to square off.", "x-data-type": "union" }, "remarks": { "description": "Custom remark; empty if none.", "type": "string", "x-data-type": "string" }, "ret": { "description": "Order retention (DAY, IOC, EXPIRY).", "type": "string", "x-data-type": "string" }, "source": { "description": "Source platform (WEB, MOB).", "type": "string", "x-data-type": "string" }, "stopLoss": { "description": "Bracket / stop-loss related fields; empty for a plain sqroff.", "type": "string", "x-data-type": "string" }, "target": { "description": "Bracket / stop-loss related fields; empty for a plain sqroff.", "type": "string", "x-data-type": "string" }, "token": { "description": "Unique scrip token; Mock Provider uses instrumentId.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol of the instrument to square off.", "type": "string", "x-data-type": "string" }, "trailingPrice": { "description": "Bracket / stop-loss related fields; empty for a plain sqroff.", "type": "string", "x-data-type": "string" }, "trailingStopLoss": { "description": "Bracket / stop-loss related fields; empty for a plain sqroff.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type (B / S).", "type": "string", "x-data-type": "string" }, "triggerPrice": { "description": "Trigger price for SL orders; empty if not applicable.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token", "tradingSymbol", "transType", "qty", "price", "priceType", "product", "orderType", "ret", "positionSqrOff", "source" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041000063727", "requestTime": "10:59:48 10-04-2026" } ], "status": "Ok" } ], "schema": { "items": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" }, "requestTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Orders Position Square Off", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-positions-sqroff.json" } }, "/v2/orders/sip/cancel": { "post": { "description": "● NEW — Newly added endpoint\n\nCancels an active SIP order. Once cancelled, no further periodic executions will be triggered.", "operationId": "post-v2-orders-sip-cancel", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "orderNo": "26040100000001" }, "schema": { "properties": { "orderNo": { "description": "SIP order number to cancel.", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Success", "result": [ { "orderNo": "26040100000001" } ], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SIP Cancel", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-sip-cancel.json" } }, "/v2/orders/sip/execute": { "post": { "description": "● NEW — Newly added endpoint\n\nCreates a new SIP order — a recurring scheduled order that automatically places trades at a specified frequency and duration. Each SIP can contain one or more scrips.", "operationId": "post-v2-orders-sip-execute", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "endPeriod": "1", "frequency": "3", "regDate": "11042026", "scrips": [ { "exchange": "NSE", "price": "5000", "product": "CNC", "qty": "1", "token": "11536", "tradingSymbol": "TCS-EQ" } ], "sipName": "My SIP", "startDate": "11042026" }, "schema": { "properties": { "endPeriod": { "description": "Number of periods / instalments the SIP runs for.", "type": "string", "x-data-type": "string" }, "frequency": { "description": "SIP frequency: \"0\"=daily, \"1\"=weekly, \"2\"=bi-weekly, \"3\"=monthly.", "type": "string", "x-data-type": "string" }, "regDate": { "description": "Registration date in DDMMYYYY format.", "format": "date-ddmmyyyy", "type": "string", "x-data-type": "date-ddmmyyyy" }, "scrips": { "description": "List of scrips to be included in the SIP.", "items": { "properties": { "exchange": { "description": "Exchange of the instrument.", "type": "string", "x-data-type": "string" }, "price": { "description": "Investment amount or price per unit.", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code (CNC, MIS, NRML).", "type": "string", "x-data-type": "string" }, "qty": { "description": "Quantity; used when investing by units rather than amount.", "type": "string", "x-data-type": "string" }, "token": { "description": "Scrip token.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "tradingSymbol", "product", "token", "price" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" }, "sipName": { "description": "Display name for the SIP.", "type": "string", "x-data-type": "string" }, "startDate": { "description": "SIP start date in DDMMYYYY format.", "format": "date-ddmmyyyy", "type": "string", "x-data-type": "date-ddmmyyyy" } }, "required": [ "regDate", "startDate", "frequency", "endPeriod", "sipName", "scrips" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041100000010" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SIP Execute (Systematic Investment Plan)", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-sip-execute.json" } }, "/v2/orders/sip/modify": { "post": { "description": "● NEW — Newly added endpoint\n\nModifies an existing SIP order. Can be used to activate or deactivate a SIP. Note: modification may not be allowed once execution has started.", "operationId": "post-v2-orders-sip-modify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "active": "true", "orderNo": "26033100000001" }, "schema": { "properties": { "active": { "description": "\"true\" to activate, \"false\" to deactivate the SIP.", "type": "string", "x-data-type": "string" }, "orderNo": { "description": "SIP order number to modify.", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo", "active" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "SIP execution already started", "result": [], "status": "Not ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Failure" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SIP Modify", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-sip-modify.json" } }, "/v2/orders/sip/pause": { "post": { "description": "● NEW — Newly added endpoint\n\nPauses a running SIP. While paused, no new orders will be triggered on the scheduled dates.", "operationId": "post-v2-orders-sip-pause", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "orderNo": "26033100000001" }, "schema": { "properties": { "orderNo": { "description": "SIP order number to pause.", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Paused successfully", "result": [], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SIP Pause", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-sip-pause.json" } }, "/v2/orders/sip/resume": { "post": { "description": "● NEW — Newly added endpoint\n\nResumes a previously paused SIP. Orders will resume being placed on scheduled dates from the next occurrence.", "operationId": "post-v2-orders-sip-resume", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "orderNo": "26033100000001" }, "schema": { "properties": { "orderNo": { "description": "SIP order number to resume.", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "message": "Resumed successfully", "result": [], "status": "Ok" }, "schema": { "properties": { "message": { "type": "string" }, "result": { "items": {}, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "SIP Resume", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-sip-resume.json" } }, "/v2/orders/tradebook": { "get": { "description": "Returns all fully or partially executed trades for the current session with trade price, quantity, fill time and exchange reference. Only filled trades appear here.", "operationId": "get-v2-orders-tradebook", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success (synthetic mock; no source response example)", "result": [ { "actId": "mock", "algoId": "mock", "bqty": "1", "brokerUpdateTime": "2026-09-30 09:15:00", "clientId": "MOCK-CLIENT-001", "exchUpdateTime": "2026-09-30 09:15:00", "exchange": "NSE", "exchangeOrderId": "mock", "exchangeTradeId": "mock", "fillId": "mock", "fillTime": "mock", "fillprc": "mock", "fillqty": "1", "fillshares": "1", "formattedInsName": "mock", "lotSize": "1", "ltp": "100.00", "multiplier": "100.00", "orderNo": "MOCK-ORDER-001", "orderTag": "mock", "orderTime": "mock", "orderType": "Regular", "placedBy": "mock", "prcftr": "mock", "price": "100.00", "pricePrecision": "100.00", "priceType": "L", "product": "CNC", "qty": "1", "ret": "DAY", "symbol": "MOCK", "tickSize": "1", "token": "10001", "tradingSymbol": "MOCK-EQ", "transType": "B", "triggerId": "mock", "userId": "MOCK-CLIENT-001" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "actId": { "type": "string" }, "algoId": { "type": "string" }, "bqty": { "type": "string" }, "brokerUpdateTime": { "type": "string" }, "clientId": { "type": "string" }, "exchUpdateTime": { "type": "string" }, "exchange": { "type": "string" }, "exchangeOrderId": { "type": "string" }, "exchangeTradeId": { "type": "string" }, "fillId": { "type": "string" }, "fillTime": { "type": "string" }, "fillprc": { "type": "string" }, "fillqty": { "type": "string" }, "fillshares": { "type": "string" }, "formattedInsName": { "type": "string" }, "lotSize": { "type": "string" }, "ltp": { "type": "string" }, "multiplier": { "type": "string" }, "orderNo": { "type": "string" }, "orderTag": { "type": "string" }, "orderTime": { "type": "string" }, "orderType": { "type": "string" }, "placedBy": { "type": "string" }, "prcftr": { "type": "string" }, "price": { "type": "string" }, "pricePrecision": { "type": "string" }, "priceType": { "type": "string" }, "product": { "type": "string" }, "qty": { "type": "string" }, "ret": { "type": "string" }, "symbol": { "type": "string" }, "tickSize": { "type": "string" }, "token": { "type": "string" }, "tradingSymbol": { "type": "string" }, "transType": { "type": "string" }, "triggerId": { "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success (generated sample)" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Tradebook", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/get-v2-orders-tradebook.json" } }, "/v2/orders/web/cancel": { "post": { "description": "Cancels an existing pending or open order using the order ID. Only orders in OPEN or TRIGGER_PENDING state can be cancelled; executed orders cannot be reversed here.", "operationId": "post-v2-orders-web-cancel", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "deviceNumber": "960cbe75300823e3e8b120eb2d8e3110", "exchange": "NSE", "orderNo": "26041000035758", "orderType": "Regular", "source": "WEB" } ], "schema": { "items": { "properties": { "deviceNumber": { "description": "Unique device identifier of the client's device.", "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange where the order exists; some brokers may omit.", "type": "string", "x-data-type": "string" }, "orderNo": { "description": "Unique identifier of the order to be cancelled. Mock Provider uses brokerOrderId.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order category (Regular, AMO, Bracket); required by some brokers.", "type": "string", "x-data-type": "string" }, "source": { "description": "Source platform (WEB, MOB).", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "infoMessage": null, "message": "Success", "result": [ { "orderNo": "26041000035758", "requestTime": "09:59:57 10-04-2026" } ], "status": "Ok" } ], "schema": { "items": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "orderNo": { "type": "string" }, "requestTime": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Cancel Orders", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-web-cancel.json" } }, "/v2/orders/web/execute": { "post": { "description": "Places a new buy or sell order. Supports all order types (LIMIT, MARKET, SL, SL-M) and product codes (CNC, MIS, NRML, NORMAL, MTF). Same schema serves /v2/orders/execute and /v2/orders/web/execute.", "operationId": "post-v2-orders-web-execute", "parameters": [], "requestBody": { "content": { "application/json": { "example": [ { "deviceNumber": "a54222da13c1a6c32d7581130aff0baf", "disclosedQty": "0", "exchange": "NFO", "ltp": "", "mktProtection": "", "orderType": "Regular", "positionSqrOff": "", "price": 685, "priceType": "L", "product": "NRML", "qty": "65", "remarks": "Regular", "ret": "DAY", "source": "WEB", "stopLoss": "", "target": "", "token": "72200", "tradingSymbol": "NIFTY28APR26P22800", "trailingPrice": "", "trailingStopLoss": "", "transType": "B", "triggerPrice": "" } ], "schema": { "items": { "properties": { "deviceNumber": { "description": "Unique device identifier of the client. Mock Provider uses deviceId.", "type": "string", "x-data-type": "string" }, "disclosedQty": { "description": "Disclosed quantity for iceberg orders. Mock Provider uses disclosedQuantity.", "nullable": true, "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange to place the order on (NSE, BSE, NFO, BFO, MCX).", "type": "string", "x-data-type": "string" }, "ltp": { "description": "Last traded price snapshot; empty if not provided.", "type": "string", "x-data-type": "string" }, "mktProtection": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "boolean", "x-data-type": "boolean" } ], "description": "Market-protection % for MKT orders. Mock Provider/Mock Provider accept true / false / \"1\".", "x-data-type": "union" }, "orderType": { "description": "Order category. Legacy: Regular, AMO, Bracket, Cover. Mock Provider: REGULAR (orderComplexity) plus orderType = LIMIT / MARKET.", "type": "string", "x-data-type": "string" }, "positionSqrOff": { "description": "Position square-off flag (\"Y\" = square-off order).", "type": "string", "x-data-type": "string" }, "price": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Order price. 0 (or \"0.0\") for market orders.", "x-data-type": "union" }, "priceType": { "description": "Price type: L (Limit), MKT (Market), SL (Stop Loss), SL-M (Stop Loss Market).", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code. Accepted: CNC, MIS, NRML, NORMAL (Mock Provider), MTF.", "type": "string", "x-data-type": "string" }, "qty": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Order quantity. Mock Provider uses quantity as Number.", "x-data-type": "union" }, "remarks": { "description": "Custom remark or tag. Mock Provider uses orderTag (e.g., MOBANDROID_Normal_REGULAR).", "type": "string", "x-data-type": "string" }, "ret": { "description": "Order retention / validity. Values: DAY, IOC, EOS, EXPIRY, GTT.", "type": "string", "x-data-type": "string" }, "source": { "description": "Origin platform: WEB, MOB, IBT-EX, ADMINCPPAPI_MOB, API. Mock Provider secondary field: apiOrderSource.", "type": "string", "x-data-type": "string" }, "stopLoss": { "description": "Stop-loss value for bracket / cover orders. Mock Provider uses stopLossPrice.", "nullable": true, "type": "string", "x-data-type": "string" }, "target": { "description": "Target price for bracket orders. Mock Provider uses targetPrice.", "nullable": true, "type": "string", "x-data-type": "string" }, "token": { "description": "Unique scrip token for the trading symbol. Mock Provider uses instrumentId with the same meaning.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol of the instrument (e.g., NIFTY28APR26P22800).", "type": "string", "x-data-type": "string" }, "trailingPrice": { "description": "Value by which the stop-loss trails the market to lock in profits.", "type": "string", "x-data-type": "string" }, "trailingStopLoss": { "description": "Trailing stop-loss value.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type. Short form: B / S. Long form (Mock Provider): BUY / SELL.", "type": "string", "x-data-type": "string" }, "triggerPrice": { "description": "Trigger price for SL / SL-M orders; empty for others.", "type": "string", "x-data-type": "string" } }, "required": [ "exchange", "token", "tradingSymbol", "transType", "qty", "price", "priceType", "orderType", "product", "ret", "source" ], "type": "object", "x-data-type": "object" }, "type": "array", "x-data-type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": [ { "infoMessage": null, "message": "Success", "result": [ { "brokerOrderId": "260727000023174", "orderNo": "26040600000608", "requestTime": "09:59:34 06-04-2026", "triggerId": "", "uniqueOrderID": "1785123920384891" } ], "status": "Ok" } ], "schema": { "items": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "brokerOrderId": { "type": "string" }, "orderNo": { "type": "string" }, "requestTime": { "type": "string" }, "triggerId": { "type": "string" }, "uniqueOrderID": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Execute Orders", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-web-execute.json" } }, "/v2/orders/web/modify": { "post": { "description": "Modifies the price, quantity, trigger price, or order type of an existing pending order. The order must be OPEN or TRIGGER_PENDING; the order ID is unchanged after modification.", "operationId": "post-v2-orders-web-modify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "deviceNumber": "9B48E058-D4C4-4CCF-8AB6-9E5F1097C84E", "disclosedQty": "", "exchange": "NFO", "filledQty": "0", "mktProtection": "", "multiplier": null, "orderNo": "26041000037861", "orderType": "Regular", "price": "159.00", "priceType": "SL", "product": "NRML", "qty": "715", "ret": "DAY", "stopLoss": "", "target": "", "token": "54810", "tradedQty": "0", "tradingSymbol": "NIFTY13APR26C23950", "trailingPrice": "", "trailingStopLoss": "", "transType": "S", "triggerPrice": "159.00" }, "schema": { "properties": { "deviceNumber": { "description": "Unique device identifier of the client's device.", "type": "string", "x-data-type": "string" }, "disclosedQty": { "description": "Disclosed quantity for iceberg orders.", "nullable": true, "type": "string", "x-data-type": "string" }, "exchange": { "description": "Exchange where the order was placed.", "type": "string", "x-data-type": "string" }, "filledQty": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Quantity already filled for the order.", "x-data-type": "union" }, "mktProtection": { "description": "Market-protection %; empty if not applicable.", "type": "string", "x-data-type": "string" }, "multiplier": { "description": "Multiplier for bracket order target / stop loss; null if not applicable.", "nullable": true, "type": "string", "x-data-type": "string" }, "orderNo": { "description": "Existing order number to be modified.", "type": "string", "x-data-type": "string" }, "orderType": { "description": "Order category (Regular / REGULAR / AMO / Bracket).", "type": "string", "x-data-type": "string" }, "price": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Revised order price; 0 for market orders.", "x-data-type": "union" }, "priceType": { "description": "Price type (L, MKT, SL, SL-M, LIMIT, MARKET).", "type": "string", "x-data-type": "string" }, "product": { "description": "Product code (CNC, MIS, NRML, NORMAL, MTF).", "type": "string", "x-data-type": "string" }, "qty": { "anyOf": [ { "type": "string", "x-data-type": "string" }, { "type": "number", "x-data-type": "number" } ], "description": "Revised order quantity.", "x-data-type": "union" }, "ret": { "description": "Order retention (DAY, IOC).", "type": "string", "x-data-type": "string" }, "stopLoss": { "description": "Revised stop-loss value; empty if not applicable.", "nullable": true, "type": "string", "x-data-type": "string" }, "target": { "description": "Revised target price; null / empty if not applicable.", "nullable": true, "type": "string", "x-data-type": "string" }, "token": { "description": "Unique scrip token; Mock Provider uses instrumentId.", "type": "string", "x-data-type": "string" }, "tradedQty": { "description": "Quantity already traded for the order.", "type": "string", "x-data-type": "string" }, "tradingSymbol": { "description": "Trading symbol of the instrument.", "type": "string", "x-data-type": "string" }, "trailingPrice": { "description": "Trailing price for dynamic stop-loss.", "type": "string", "x-data-type": "string" }, "trailingStopLoss": { "description": "Revised trailing stop-loss.", "type": "string", "x-data-type": "string" }, "transType": { "description": "Transaction type (B / S or BUY / SELL).", "type": "string", "x-data-type": "string" }, "triggerPrice": { "description": "Revised trigger price for SL / SL-M; empty if not applicable.", "type": "string", "x-data-type": "string" } }, "required": [ "orderNo", "exchange", "token", "tradingSymbol", "transType", "qty", "price", "priceType", "product", "orderType", "ret" ], "type": "object", "x-data-type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "infoMessage": null, "message": "Success", "result": [ { "brokerOrderId": "260727000021493", "orderNo": "26041000037861", "requestTime": "10:59:59 10-04-2026", "uniqueOrderID": "1785123945094431" } ], "status": "Ok" }, "schema": { "properties": { "infoMessage": { "nullable": true }, "message": { "type": "string" }, "result": { "items": { "properties": { "brokerOrderId": { "type": "string" }, "orderNo": { "type": "string" }, "requestTime": { "type": "string" }, "uniqueOrderID": { "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "404": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "413": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" }, "415": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Mock server request error" } }, "security": [ { "mockBearer": [] } ], "summary": "Order Modify", "tags": [ "orders" ], "x-request-schema-file": "schemas/requests/orders/post-v2-orders-web-modify.json" } } }, "servers": [ { "url": "/" } ], "tags": [ { "name": "alerts" }, { "name": "auth" }, { "name": "basket-orders" }, { "name": "brokerage" }, { "name": "chart" }, { "name": "client-utils" }, { "name": "common-utils" }, { "name": "fundamentals-technicals" }, { "name": "funds-payments" }, { "name": "holdings" }, { "name": "ipo" }, { "name": "notification" }, { "name": "options-chain" }, { "name": "orders" }, { "name": "positions" }, { "name": "scrips" }, { "name": "watchlist" } ] }