Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Investments

Get holding activity

Retrieve a specific holding activity.

get/financial-data/v2beta/portfolios/{pid}/holdings/{hid}/activities/{id}

Path parameters

pidstring required
Example:654d7617-1cd3-46ab-921a-56fd92acf4a4

ID of the portfolio

hidstring required
Example:b1c629e2-6463-4c76-9ddc-58aab54340c3

ID of the holding

idstring required
Example:84efb834-3524-4030-a524-237019264f93

Holding activity ID.

Response

Holding activity.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

portfolioIdstring required

Unique resource identifier.

holdingIdstring required

Unique resource identifier.

datestring date required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

tradeDatestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

sharesnumber double

Number of shares traded

type'PURCHASE' | 'REDEEM' | 'DIVIDEND' required

The type of the activity on the holding.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

etagstring required

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.

metadataMetadata 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. 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.

Example response

{
  "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"
  }
}