Get Positions
GET/v1.2/customer/account/security/summary
This is used to get detailed information about the customer positions currently held under the given account.
Request
Query Parameters
Security account number
Example: P000128310
Header Parameters
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Equity/Option
- Fixed Income
- Mutual Funds
- Spot
Schema
- Array [
- ]
Possible values: [SUCCESS
, FAILED
]
Find error codes here
positions object[]
The security account number
This is only for equity, option, fund and spot orders
This is only for equity,option,spot and fund orders
This is only for equity, option, bond and spot orders
This is only for equity, option and spot orders
This is only for equity, option and spot orders
lotSizeThis is only for equity, option and spot orders
Possible values: [1
, 2
]
1 - Long, 2 - Short (This is only for equity, option and spot orders)
This is only for equity, option and spot orders
This is only for equity, option and spot orders
This is only for bond and fund orders
This is only for bond and fund orders
This is only for fund orders
This is only for fund orders
This is only for fund orders
This is only for fund orders
This is only for bond orders
This is only for bond orders
This is only for bond orders
This is only for bond orders
{
"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,
"amount": 0,
"startDate": "string",
"costValue": 0,
"investmentId": "string",
"redeemAmount": 0,
"fullyRedeem": 0,
"accruedInterest": 0,
"isin": "string",
"collectedCoupons": 0,
"totalCost": 0
}
]
}
{
"status": "SUCCESS",
"reason": "Customer positions retrieved successfully",
"rejectCode": 0,
"positions": [
{
"accountNumber": "P000284400",
"exchange": "DFM",
"symbol": "ABCW",
"quantity": 15000,
"averageCost": 26.60087,
"averagePrice": 25.33336,
"pendingSell": 0,
"pendingBuy": 0,
"currency": "USD",
"availableQuantity": 15000,
"symbolDesc": "",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 15000
},
{
"accountNumber": "P000284400",
"exchange": "DFM",
"symbol": "EMAAR",
"quantity": 4411,
"averageCost": 1.30664,
"averagePrice": 1.05011,
"pendingSell": 0,
"pendingBuy": 417,
"currency": "AED",
"availableQuantity": 4411,
"symbolDesc": "EMAAR",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 4411
},
{
"accountNumber": "P000284400",
"exchange": "NSDQ",
"symbol": "AAL",
"quantity": 3927,
"averageCost": 0,
"averagePrice": 0,
"pendingSell": 0,
"pendingBuy": 0,
"currency": "USD",
"availableQuantity": 3927,
"symbolDesc": "AAL",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 3927
},
{
"accountNumber": "P000284400",
"exchange": "NSDQ",
"symbol": "AAPL",
"quantity": 2237366.969545,
"averageCost": 520.13749,
"averagePrice": 111.71214,
"pendingSell": 0,
"pendingBuy": 10081.5,
"currency": "USD",
"availableQuantity": 2237366.969545,
"symbolDesc": "AAPL",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 2237366.969545
},
{
"accountNumber": "P000284400",
"exchange": "NSDQ",
"symbol": "GOOG",
"quantity": 5,
"averageCost": 34.19358,
"averagePrice": 18.43532,
"pendingSell": 0,
"pendingBuy": 0,
"currency": "USD",
"availableQuantity": 5,
"symbolDesc": "GOOG",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 5
},
{
"accountNumber": "P000284400",
"exchange": "NSDQ",
"symbol": "ISTB",
"quantity": 0,
"averageCost": 0,
"averagePrice": 0,
"pendingSell": 0,
"pendingBuy": 1,
"currency": "USD",
"availableQuantity": 0,
"symbolDesc": "ISHARES TRUST CORE 1-5 YEAR USD BOND ETF",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 0
},
{
"accountNumber": "P000284400",
"exchange": "NYSE",
"symbol": "ABA",
"quantity": 0,
"averageCost": 0,
"averagePrice": 0,
"pendingSell": 0,
"pendingBuy": 5000,
"currency": "USD",
"availableQuantity": 0,
"symbolDesc": "",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 0
},
{
"accountNumber": "P000284400",
"exchange": "NYSE",
"symbol": "ABB",
"quantity": 1,
"averageCost": 1,
"averagePrice": 0,
"pendingSell": 0,
"pendingBuy": 0,
"currency": "USD",
"availableQuantity": 1,
"symbolDesc": "",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 1
},
{
"accountNumber": "P000284400",
"exchange": "NYSE",
"symbol": "OSI",
"quantity": 0,
"averageCost": 0,
"averagePrice": 0,
"pendingSell": 0,
"pendingBuy": 100000,
"currency": "USD",
"availableQuantity": 0,
"symbolDesc": "",
"lotSize": 1,
"holdingType": 1,
"manualHoldingBlock": 0,
"netHolding": 0
},
{
"accountNumber": "P000284400",
"exchange": "OPRA",
"symbol": "AAPL\\\\24P19\\\\100.0",
"quantity": 0,
"averageCost": 0,
"averagePrice": 0,
"pendingSell": 0,
"pendingBuy": 10,
"currency": "USD",
"availableQuantity": 0,
"symbolDesc": "AAPL\\24P19\\100.0",
"lotSize": 100,
"holdingType": 0,
"manualHoldingBlock": 0,
"netHolding": 0
},
{
"accountNumber": "P000284400",
"exchange": "OPRA",
"symbol": "AAPL\\\\24D19\\\\105.0",
"quantity": 0,
"averageCost": 0,
"averagePrice": 0,
"pendingSell": 0,
"pendingBuy": 550,
"currency": "USD",
"availableQuantity": 0,
"symbolDesc": "AAPL\\24D19\\105.0",
"lotSize": 100,
"holdingType": 0,
"manualHoldingBlock": 0,
"netHolding": 0
}
]
}
{
"status": "SUCCESS",
"reason": "Customer positions retrieved successfully",
"rejectCode": 0,
"positions": [
{
"accountNumber": "P000284369",
"exchange": "GTNFI",
"symbol": "ANZ 3.652 01/20/26",
"averagePrice": 250.154,
"pendingSell": 0,
"pendingBuy": 102000,
"currency": "USD",
"amount": 4000,
"accruedInterest": 0,
"startDate": "2024/01/10-06:54:53",
"isin": "XS2577127884",
"totalCost": 10149.24,
"collectedCoupons": 0
},
{
"accountNumber": "P000284369",
"exchange": "BOND",
"symbol": "ANF 1",
"averagePrice": 10,
"pendingSell": 102020,
"pendingBuy": 414030,
"currency": "USD",
"amount": 1000000000000,
"accruedInterest": 0,
"startDate": "2023/10/16-06:01:07",
"isin": "USU0029TAA89",
"totalCost": 100000000000,
"collectedCoupons": 0
},
{
"accountNumber": "P000284369",
"exchange": "GTNFI",
"symbol": "ANF 07/15/25 8.75",
"averagePrice": 7,
"pendingSell": 0,
"pendingBuy": 2000,
"currency": "USD",
"amount": 20000,
"accruedInterest": 9.93171,
"startDate": "2023/12/08-11:14:15",
"isin": "ANF 07/15/25 8.75",
"totalCost": 1410.2,
"collectedCoupons": 0
}
]
}
{
"status": "SUCCESS",
"reason": "Customer positions retrieved successfully",
"rejectCode": 0,
"positions": [
{
"accountNumber": "P000296800",
"exchange": "MFSFUNDS",
"symbol": "KESH1",
"quantity": 8.33,
"averageCost": 18.60744,
"pendingSell": 0,
"pendingBuy": 0,
"currency": "USD",
"amount": 150,
"startDate": "2024/03/25-05:20:53",
"costValue": 416.5,
"investmentId": "FO240325-2-000006",
"redeemAmount": 0,
"fullyRedeem": 0
},
{
"accountNumber": "P000296800",
"exchange": null,
"symbol": null,
"quantity": 6.67,
"averageCost": 15.74213,
"pendingSell": 0,
"pendingBuy": 0,
"currency": null,
"amount": 100,
"startDate": "2024/03/25-05:14:17",
"costValue": 0,
"investmentId": "FO240325-2-000003",
"redeemAmount": 0,
"fullyRedeem": 0
}
]
}
{
"status": "SUCCESS",
"reason": "Customer positions retrieved successfully",
"rejectCode": 0,
"positions": [
{
"accountNumber": "P000283568",
"exchange": "GTNSPOT",
"symbol": "XAUUSD",
"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
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Invalid Token
- Expired Token
Schema
{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string",
"rejectCode": "string"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Invalid Token",
"path": "/api/v1.2/customer/account/security/summary",
"rejectCode": "1008"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Expired Token",
"path": "/api/v1.2/customer/account/security/summary",
"rejectCode": "1007"
}