1. Introduction

The Positions API provides a consolidated view of your open and closed positions for the current trading day across all supported segments. This allows you to track real-time exposures, quantities bought/sold, and settlement data.

2. API Endpoint

GET <Base URL>/quick/user/positions

Replace <Base URL> with the relevant Kotak environment base URL provided in response from /tradeApiValidate api.

3. Headers

Name Type Description
accept string Should always be application/json
Sid string session sid generated on login
Auth string session token generated on login
neo-fin-key string static value: neotradeapi
Content-Type string Always application/x-www-form-urlencoded

4. Request

Example Request:

# Position Book
curl -X GET "<baseUrl>/quick/user/positions" \\
  -H "Auth: <session_token>" \\
  -H "Sid: <session_sid>" \\
  -H "neo-fin-key: neotradeapi"

No request body or query params required.

5. Response

Example Success Response (truncated, user-friendly)

{
  "stat": "Ok",
  "stCode": 200,
  "data": [
    {
      "actId": "******",
      "prod": "CNC",
      "exSeg": "nse_cm",
      "trdSym": "AXISBANK-EQ",
      "sym": "AXISBANK",
      "qty": "9",
      "buyAmt": "5862.90",
      "sellAmt": "0.00",
      "flBuyQty": "9",
      "flSellQty": "0",
      "brdLtQty": 1,
      "posFlg": "true",
      "sqrFlg": "Y",
      "lotSz": "1",
      "stkPrc": "0.00",
      "hsUpTm": "2022/06/21 15:11:02"
    },
    {
      "actId": "******",
      "prod": "CNC",
      "exSeg": "nse_cm",
      "trdSym": "ITC-EQ",
      "sym": "ITC",
      "qty": "15",
      "buyAmt": "4021.50",
      "sellAmt": "0.00",
      "flBuyQty": "15",
      "flSellQty": "0",
      "brdLtQty": 1,
      "posFlg": "true",
      "sqrFlg": "Y",
      "lotSz": "1",
      "stkPrc": "0.00",
      "hsUpTm": "2022/06/21 15:11:02"
    }
  ]
}

200 Response Fields

Field Type Description
stat string Overall status ("Ok" for success)
stCode int Status code (200 = success)
data array Array of position objects (see below)

Position Object (Key Fields):

Field Type Description
actId string Account ID
prod string Product code (e.g., CNC, MIS, NRML)
exSeg string Exchange segment (e.g., nse_cm, bse_cm)
trdSym string Trading symbol (e.g., AXISBANK-EQ)
sym string Symbol name (e.g., AXISBANK)
qty string Net position quantity
buyAmt string Total buy amount
sellAmt string Total sell amount
flBuyQty string Filled buy quantity
flSellQty string Filled sell quantity
brdLtQty int Board lot quantity
posFlg string Position flag ("true" if open position)
sqrFlg string Square-off flag ("Y" = allowed)
lotSz string Lot size
stkPrc string Strike price (for derivatives)
hsUpTm string Last updated time

Other available fields:

cfBuyAmt, cfSellAmt, cfBuyQty, cfSellQty, multiplier, precision, expDt, genNum, genDen, prcNum, prcDen, optTp, type