Get Holding Statement
GET/v1.1/statement/positions
This is used to get the current position details of a given customer under a given account number.
Request
Query Parameters
year integerrequired
only accepts current year or a previous year
Example: 2022
month integerrequired
Possible values: >= 1
and <= 12
if current year is given, month must be current month or a previous month
customerNumber stringrequired
Possible values: <= 20 characters
accountNumber string
Possible values: <= 50 characters
Security account number
contentType stringrequired
currently only accepts json format
Example: json
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- JSON
Schema
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
status stringrequired
reason string
rejectCode integer
Find error codes here
customerNumber string
month integer
year integer
period string
list object[]
accountNumber string
accountType integer
list object[]
exchangeAccountId string
exchange string
list object[]
symbol string
totalHolding number
list object[]
transactionDate string
Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$
narration string
quantity number
{
"status": "string",
"reason": "string",
"rejectCode": 0,
"customerNumber": "string",
"month": 0,
"year": 0,
"period": "string",
"list": [
{
"accountNumber": "string",
"accountType": 0,
"list": [
{
"exchangeAccountId": "string",
"exchange": "string",
"list": [
{
"symbol": "string",
"totalHolding": 0,
"list": [
{
"transactionDate": "string",
"narration": "string",
"quantity": 0
}
]
}
]
}
]
}
]
}
{
"status": "SUCCESS",
"customerNumber": "ASI446440071",
"month": 8,
"year": 2023,
"period": "2023/08/01 to 2023/08/31",
"list": [
{
"accountNumber": "P000284060",
"accountType": 1,
"list": [
{
"exchangeAccountId": "686566",
"exchange": "NSDQ",
"list": [
{
"symbol": "AAPL - AAPL",
"totalHolding": 200,
"list": [
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237910 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
},
{
"transactionDate": "2023/08/22",
"narration": "Ord:2237920 Buy 10.00000000@ 175.84000",
"quantity": 10
}
]
}
]
}
]
}
]
}
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/positions",
"rejectCode": "1008"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Expired Token",
"path": "/api/v1.1/statement/positions",
"rejectCode": "1007"
}
Loading...
Is this page helpful for you?