This is a preview version of the API intended for early testing and integration. Preview versions are not stable and may include breaking changes before general availability.

Depot Account

A securities depot account (Wertpapierdepot) holding funds, equities, ETFs and other securities.

companystring

Company where the financial product has been collected from. Examples: de-trade-republic, de-scalable-capital, de-ing, de-comdirect, de-commerzbank, de-dkb, de-consorsbank, de-n26.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

financialInformationProductFinancialInformation

Financial details of the product, like value, performance etc.

holdingsArray<GermanDepotAccount.GermanHolding>

List of holdings within the depot account.

idstring

Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., productNumber, accountNumber, or loanId) for that.

personalInformationobject

Details of the person collecting the data.

productNamestring

Name of the financial product.

productNumberstring

The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.

typestring

Type of the financial product.

Possible Enum values are DEPOT_ACCOUNT.

Example

{
  "company": "de-trade-republic",
  "companyDisplayName": "Trade Republic",
  "financialInformation": {
    "currentValue": {
      "amount": 26982.66,
      "currency": "EUR"
    },
    "performanceSinceStart": 0.1605
  },
  "holdings": [
    {
      "acquisitionValue": {
        "amount": 18883.51,
        "currency": "EUR"
      },
      "csdBic": "DAKVDEFFXXX",
      "feeVariable": 0.002,
      "isin": "IE00B4L5Y983",
      "name": "iShares Core MSCI World UCITS ETF",
      "quantity": 54.076858,
      "type": "ETF",
      "value": {
        "amount": 22468.39,
        "currency": "EUR"
      }
    }
  ],
  "id": "df2e7a28-d871-45c1-a01e-515b7aeaf7da",
  "personalInformation": {},
  "productName": "Depot",
  "productNumber": "987654321",
  "type": "DEPOT_ACCOUNT"
}

{  "company": "de-trade-republic",  "companyDisplayName": "Trade Republic",  "financialInformation": {    "currentValue": {      "amount": 26982.66,      "currency": "EUR"    },    "performanceSinceStart": 0.1605  },  "holdings": [    {      "acquisitionValue": {        "amount": 18883.51,        "currency": "EUR"      },      "csdBic": "DAKVDEFFXXX",      "feeVariable": 0.002,      "isin": "IE00B4L5Y983",      "name": "iShares Core MSCI World UCITS ETF",      "quantity": 54.076858,      "type": "ETF",      "value": {        "amount": 22468.39,        "currency": "EUR"      }    }  ],  "id": "df2e7a28-d871-45c1-a01e-515b7aeaf7da",  "personalInformation": {},  "productName": "Depot",  "productNumber": "987654321",  "type": "DEPOT_ACCOUNT"}