Positions
GET/v1.1/statement/ca/positions
This is used to get the holding log of the given customer for the given corporate action.
# | description |
---|---|
STCK_DVD | stock dividend |
REV_STCK_DVD | reverse stock dividend |
BNUS_ISS | bonus issue |
REV_BNUS_ISS | reverse bonus issue |
RGHT_ISS | right issue |
REV_RGHT_ISS | reverse right issue |
STCK_SPLT | stock split |
REV_STCK_SPLT | reversing the applied stock split |
RSTCK_SPLT | reverse stock split |
REV_RSTCK_SPLT | reversing the applied reverse stock split |
SPN_OFF | spin off |
REV_SPN_OFF | reverse spin off |
STCK_MERG_STCK_SPLT | stock merger with stock split |
REV_STCK_MERG_STCK_SPLT | reverser of stock merger with stock split |
STCK_MERG_REV_STCK_SPLT | stock merger with reverse stock split |
REV_STCK_MERG_REV_STCK_SPLT | reverse of stock merger with reverse stock split |
Request
Query Parameters
institutionCode stringrequired
customerNumber string
Possible values: >= 1
and <= 12
corporateActionType stringrequired
Possible values: [STCK_DVD
, REV_STCK_DVD
, BNUS_ISS
, REV_BNUS_ISS
, RGHT_ISS
, REV_RGHT_ISS
, STCK_SPLT
, REV_STCK_SPLT
, RSTCK_SPLT
, REV_RSTCK_SPLT
, SPN_OFF
, REV_SPN_OFF
, STCK_MERG_STCK_SPLT
, REV_STCK_MERG_STCK_SPLT
, STCK_MERG_REV_STCK_SPLT
, REV_STCK_MERG_REV_STCK_SPLT
]
startDate stringrequired
Possible values: Value must match regular expression yyyy/MM/dd
endDate stringrequired
Possible values: Value must match regular expression yyyy/MM/dd
pageNo integer
pageWidth integer
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- STCK_DVD
- REV_STCK_DVD
- BNUS_ISS
- REV_BNUS_ISS
- STCK_SPLT
- REV_STCK_SPLT
- RSTCK_SPLT
- REV_RSTCK_SPLT
- SPN_OFF
- REV_SPN_OFF
- STCK_MERG_STCK_SPLT
- REV_STCK_MERG_STCK_SPLT
- STCK_MERG_REV_STCK_SPLT
- REV_STCK_MERG_REV_STCK_SPLT
Schema
- Array [
- ]
status stringrequired
rejectCode integer
Find error codes here
isNextPageAvailable boolean
pageNo integer
pageWidth integer
totalNoOfRecords integer
list object[]
exchange string
date string
accountNumber string
symbol string
netHolding number
quantity number
averageCost number
narration string
corporateActionType string
eligibleShare number
{
"status": "string",
"rejectCode": 0,
"isNextPageAvailable": true,
"pageNo": 0,
"pageWidth": 0,
"totalNoOfRecords": 0,
"list": [
{
"exchange": "string",
"date": "string",
"accountNumber": "string",
"symbol": "string",
"netHolding": 0,
"quantity": 0,
"averageCost": 0,
"narration": "string",
"corporateActionType": "string",
"eligibleShare": 0
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-12:32:44",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": 103,
"averageCost": 95.4335,
"narration": "Stock dividend - AAPL AT RATIO OF 1.03",
"corporateActionType": "STCK_DVD",
"eligibleShare": 100
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-12:36:01",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": -103,
"averageCost": 193.73,
"narration": "Cancellation Stock dividend - AAPL AT RATIO OF 1.03",
"corporateActionType": "REV_STCK_DVD",
"eligibleShare": 100
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:03:53",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": 60,
"averageCost": 357.68168,
"narration": "BOUNS SHARES 10%",
"corporateActionType": "BNUS_ISS",
"eligibleShare": 603
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:05:15",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": -60,
"averageCost": 393.2719,
"narration": "Incorrect rate",
"corporateActionType": "REV_BNUS_ISS",
"eligibleShare": 603
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:09:29",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": 6633,
"averageCost": 32.77266,
"narration": "STOCK SPLIT ON AAPL AT A RATIO 1 for 11, TD 07.19.2023",
"corporateActionType": "STCK_SPLT",
"eligibleShare": 603
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:24:46",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": -6633,
"averageCost": 393.2719,
"narration": "Cancellation - STOCK SPLIT ON AAPL AT A RATIO 1 for 11, TD 07.19.2023",
"corporateActionType": "REV_STCK_SPLT",
"eligibleShare": 603
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:26:48",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": -302,
"averageCost": 787.85035,
"narration": "REVERSE STOCK SPLIT ON AAPL AT A RATIO 1 for 2, TD 07.19.2023",
"corporateActionType": "RSTCK_SPLT",
"eligibleShare": 603
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:27:44",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": 302,
"averageCost": 393.2719,
"narration": "Cancellation - REVERSE STOCK SPLIT ON AAPL AT A RATIO 1 for 2, TD 07.19.2023",
"corporateActionType": "REV_RSTCK_SPLT",
"eligibleShare": 603
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/20-04:20:30",
"accountNumber": "P000282178",
"symbol": "PEBO",
"netHolding": 1204,
"averageCost": 0,
"narration": "SPIN OFF-AAPL TO PEBO AT RATE 1:2 07.19.2023",
"corporateActionType": "SPN_OFF",
"eligibleShare": 602
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 1,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/20-04:49:06",
"accountNumber": "P000282178",
"symbol": "PEBO",
"netHolding": -1204,
"averageCost": 0,
"narration": "Cancellation : SPIN OFF-AAPL TO PEBO AT RATE 1:2 07.19.2023",
"corporateActionType": "REV_SPN_OFF",
"eligibleShare": 602
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 2,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:34:19",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": -603,
"averageCost": 393.2719,
"narration": "STOCK MERGER FROM AAPL TO GO @ 1 :3 RATIO 19/07/2023",
"corporateActionType": "STCK_MERG_STCK_SPLT",
"eligibleShare": 603
},
{
"exchange": "NSDQ",
"date": "2023/07/19-17:34:19",
"accountNumber": "P000282178",
"symbol": "GO",
"netHolding": 1809,
"averageCost": 131.09063,
"narration": "STOCK MERGER FROM AAPL TO GO @ 1 :3 RATIO 19/07/2023",
"corporateActionType": "STCK_MERG_STCK_SPLT",
"eligibleShare": 0
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 2,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:34:50",
"accountNumber": "P000282178",
"symbol": "GO",
"netHolding": -1809,
"averageCost": 0,
"narration": "REVERSE STOCK MERGER FROM AAPL TO GO @ 1 :3 RATIO 19/07/2023",
"corporateActionType": "REV_STCK_MERG_STCK_SPLT",
"eligibleShare": 1809
},
{
"exchange": "NSDQ",
"date": "2023/07/19-17:34:50",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": 603,
"averageCost": 393.2719,
"narration": "REVERSE STOCK MERGER FROM AAPL TO GO @ 1 :3 RATIO 19/07/2023",
"corporateActionType": "REV_STCK_MERG_STCK_SPLT",
"eligibleShare": 0
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 2,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:39:15",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": -603,
"averageCost": 393.2719,
"narration": "STOCK MERGER FROM AAPL TO BRAG @ 2 :1 RATIO 19/07/2023",
"corporateActionType": "STCK_MERG_REV_STCK_SPLT",
"eligibleShare": 603
},
{
"exchange": "NSDQ",
"date": "2023/07/19-17:39:15",
"accountNumber": "P000282178",
"symbol": "BRAG",
"netHolding": 301,
"averageCost": 787.85035,
"narration": "STOCK MERGER FROM AAPL TO BRAG @ 2 :1 RATIO 19/07/2023",
"corporateActionType": "STCK_MERG_REV_STCK_SPLT",
"eligibleShare": 0
}
]
}
{
"status": "SUCCESS",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 2,
"list": [
{
"exchange": "NSDQ",
"date": "2023/07/19-17:40:17",
"accountNumber": "P000282178",
"symbol": "BRAG",
"netHolding": -301,
"averageCost": 0,
"narration": "REVERSE STOCK MERGER FROM AAPL TO BRAG @ 2 :1 RATIO 19/07/2023",
"corporateActionType": "REV_STCK_MERG_REV_STCK_SPLT",
"eligibleShare": 301
},
{
"exchange": "NSDQ",
"date": "2023/07/19-17:40:17",
"accountNumber": "P000282178",
"symbol": "AAPL",
"netHolding": 603,
"averageCost": 393.2719,
"narration": "REVERSE STOCK MERGER FROM AAPL TO BRAG @ 2 :1 RATIO 19/07/2023",
"corporateActionType": "REV_STCK_MERG_REV_STCK_SPLT",
"eligibleShare": 0
}
]
}
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": "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.1/statement/ca/positions",
"rejectCode": "1008"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Expired Token",
"path": "/api/v1.1/statement/ca/positions",
"rejectCode": "1007"
}
Loading...
Is this page helpful for you?