--- title: "List holding activities" method: GET path: "/financial-data/v2beta/portfolios/{pid}/holdings/{hid}/activities" tags: ["Investments"] --- # List holding activities `GET /financial-data/v2beta/portfolios/{pid}/holdings/{hid}/activities` ## Request - Base URL: `https://api.atlar.com` - URL: `https://api.atlar.com/financial-data/v2beta/portfolios/{pid}/holdings/{hid}/activities` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Holding 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. ## Path parameters - `pid` string, required - `hid` string, required ## Query parameters - `date` union - string, date: Include only activity with `date` equal to the given value. - object - `gte` string, date: Include only activity with `date` after or equal to given date. - `lte` string, date: Include only activity with `date` before or equal to given date. - `eq` string, date: Include only activity with `date` equal to given date. - `limit` integer - `token` string ## Response `200` List of holding activities. - object - `items` HoldingActivity[], required: A list of resources. - `id` string, required: Unique resource identifier. - `organizationId` string, required: Unique resource identifier for an Organization. - `portfolioId` string, required: Unique resource identifier. - `holdingId` string, required: Unique resource identifier. - `date` string, date, required: `full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`. - `tradeDate` string, date: `full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`. - `amount` Amount, required - `currency` string, required: Three-letter ISO 4217 currency code. - `stringValue` string, required: A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator. - `value` integer, required: The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502). - `nav` Amount - `currency` string, required: Three-letter ISO 4217 currency code. - `stringValue` string, required: A string representation of the amount value. This will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with locale specific thousand separator) and always contains the dot `.` character as decimal separator. - `value` integer, required: The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502). - `scaledNav` ScaledAmount - `currency` string, required: Three-letter ISO 4217 currency code. - `value` integer, required: The amount value as a scaled integer (int64). The number of decimal places is given by the `decimals` field, not by the currency. E.g. value=10004 with decimals=4 represents 1.0004. - `decimals` integer, required: The number of decimal places in `value`. - `stringValue` string, required: A string representation of the amount value as a decimal number. - `shares` number, double: Number of shares traded - `type` 'PURCHASE' | 'REDEEM' | 'DIVIDEND', required: The type of the activity on the holding. - `created` string, date-time, required: Time at which the resource was created. - `updated` string, date-time, required: Time at which the resource was last updated. - `version` integer, required: Resource version. Starts at value `1` when the resource is created and increases by one for each successive update. - `etag` string, required: [ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the resource version. This can be passed along in `If-Match` HTTP header when updating a resource to perform a conditional update. - `metadata` Metadata, nullable: Metadata is a `string-string` key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement. Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars. By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the [Metadata keys page](https://app.atlar.com/metadata-keys). Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set. - `nextToken` string, required: Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched. - `token` string, required: The pagination token that was used for this request. The value will be an empty string if no `token` query parameter was provided with the request. - `limit` integer, required: The page limit that was used for this request. ## Other responses - `400`: Bad request. ## Changes - **2026-11-03** `b49df1e4b3e9`: 1 info - added the optional property `details/items/metadata` to the response with the `400` status [Operation history](https://skmtc.dev/atlar/apis/atlar-api-v2/changes/financial-data/v2beta/portfolios/:pid/holdings/:hid/activities/get.md) --- [API](https://skmtc.dev/atlar/apis/atlar-api-v2.md) - [All operations](https://skmtc.dev/atlar/apis/atlar-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/atlar/apis/atlar-api-v2/revisions/b49df1e4b3e9?raw)