Get Positions

GET 
/v1.1/customer/account/security/summary

This is used to get detailed information about the customer positions currently held under the given account.

Request

Query Parameters

accountNumber stringrequired

Security account number

Example: P000128310

Responses

200

OK

application/json

Schema

Schema

status stringrequired

Possible values: [SUCCESS, FAILED]

reason string
rejectCode integer

Find error codes here

positions object[]
Array [
accountNumber string
The security account number
exchange string
symbol string
quantity number
averageCost number
averagePrice number
pendingSell number
pendingBuy number
currency string
availableQuantity number
symbolDesc string
lotSize integer
holdingType integer
Possible values: [1, 2]
1 - Long, 2 - Short
manualHoldingBlock number
netHolding number
]

Example (from schema)

{
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0,
  "positions": [
    {
      "accountNumber": "string",
      "exchange": "string",
      "symbol": "string",
      "quantity": 0,
      "averageCost": 0,
      "averagePrice": 0,
      "pendingSell": 0,
      "pendingBuy": 0,
      "currency": "string",
      "availableQuantity": 0,
      "symbolDesc": "string",
      "lotSize": 0,
      "holdingType": 1,
      "manualHoldingBlock": 0,
      "netHolding": 0
    }
  ]
}

example

{
  "status": "SUCCESS",
  "reason": "Customer positions retrieved successfully",
  "rejectCode": 0,
  "positions": [
    {
      "accountNumber": "P000283568",
      "exchange": "NSDQ",
      "symbol": "AAPL",
      "quantity": 64800,
      "averageCost": 13.23278,
      "averagePrice": 19.84917,
      "pendingSell": 0,
      "pendingBuy": 400,
      "currency": "USD",
      "availableQuantity": 64800,
      "symbolDesc": "AAPL",
      "lotSize": 1,
      "holdingType": 1,
      "manualHoldingBlock": 0,
      "netHolding": 64800
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.1/customer/account/security/summary",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.1/customer/account/security/summary",
  "rejectCode": "1007"
}

Loading...