List holding activities
Changed onHolding activities are the individual transactions on an investment holding: purchases (PURCHASE), redemptions (REDEEM) and dividend payouts (DIVIDEND). Each activity carries the traded amount, the number of shares, the NAV per share, the trade date and the settlement date.
Request
- Base URLhttps://api.atlar.com
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Include only activity on holdings in the portfolio identified by pid. If value - is specified, activity across all portfolios will be queried
Include only activity on the holding identified by hid. If value - is specified, activity across all holdings will be queried
Query parameters
Include only activity with property date matching the given value. The parameter value may be either a string for equality matching, or an object for range-like matching criteria.
Limit the number of items in resulting query response.
If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.
Response
List of holding activities.
Example response
{
"items": [
{
"id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
"portfolioId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"holdingId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"date": "2022-05-07",
"tradeDate": "2022-05-07",
"amount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
},
"nav": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
},
"scaledNav": {
"currency": "EUR"
},
"type": "PURCHASE",
"created": "2022-05-04T18:31:12.889104898Z",
"updated": "2022-05-04T18:47:32.213842599Z",
"version": 1,
"etag": "version:3",
"metadata": {
"my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
}
}
],
"nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
"token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
"limit": 100
}Changes
- info
added the optional property
//to the response with the status
- info