Skip to navigation
Data modelsBanking

Investments

Securities accounts, stocks, funds and private pension plans
View as Markdown

Where it lives: at investments in the Financial Position — with accounts, stocks, funds and pensions inside it — and one by one from their own endpoints.

accountslist of objectsOptional
Investment accounts
stockslist of objectsOptional
Investment stocks
fundslist of objectsOptional
Investment funds
pensionslist of objectsOptional
Pension plans

Investment accounts

The wrapper: the securities account the holdings sit in, with its own valuation and performance.

idstringRequiredformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"financial_account"Required
sub_family"financial_account:investments"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
data_enrichmentenumRequired
Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data.
Allowed values:
identifierobjectRequired
Account identifier
customer_segmentenumRequired
product_namestringRequired
Product name
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
opening_datedateOptional
Account opening date
valuation_datedateOptional
Valuation date
valuationobjectOptional

Valuation of the assets held in the account. (Deprecated, use balance instead)

appreciationobjectOptional
Monetary appreciation of the assets held in the account
performanceobjectOptional
Account performance

Stocks

Listed holdings, identified by isin and ticker, with the quantity held and the price used to value it.

idstringRequiredformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"investment_asset"Required
sub_family"investment_asset:stock"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
accountobjectRequired
Account identifier
customer_segmentenumRequired
product_namestringRequired
Product name
contractobjectOptional
Contract if present
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
isinstringOptional
ISIN code
tickerstringOptional
Ticker
marketstringOptional
Market
categorystringOptional
Category
unit_priceobjectOptional
Unit price
quantitystringOptionalformat: "number"Defaults to nan
The number of units of a financial instrument held by the account.
valuationobjectOptional
The monetary value of a financial instrument held by the account.
valuation_datedateOptional
Valuation date
appreciationobjectOptional
The monetary value of the appreciation of a financial instrument held by the account.
performanceobjectOptional
Performance

Funds

idstringRequiredformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"investment_asset"Required
sub_familyenumRequired
Allowed values:
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
accountobjectRequired
Account identifier
customer_segmentenumRequired
product_namestringRequired
Product name
contractobjectOptional
Contract if present
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
isinstringOptional
ISIN code
tickerstringOptional
Ticker
marketstringOptional
Market
categorystringOptional
Category
unit_priceobjectOptional
Unit price
quantitystringOptionalformat: "number"Defaults to nan
The number of units of a financial instrument held by the account.
valuationobjectOptional
The monetary value of a financial instrument held by the account.
valuation_datedateOptional
Valuation date
appreciationobjectOptional
The monetary value of the appreciation of a financial instrument held by the account.
performanceobjectOptional
Performance

Private pension plans

The retirement saving held at this institution, with contributions and valuation. Public pension entitlements are a different thing entirely and come from the administration — see Public Pensions.

idstringRequiredformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"pension_plan"Required
sub_familyenumRequired
Pension plan type
Allowed values:
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
identifierobjectRequired
Plan number
customer_segmentenumRequired
product_namestringRequired
Product name
linked_accountobjectOptional
Account identifier
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
categorystringOptional
Plan Category
begin_datedateOptional
Begin date
end_datedateOptional
End Date
total_contributionobjectOptional
Total contribution
year_to_date_contributionobjectOptional
Year to date contribution
unit_priceobjectOptional
Unit price
quantitystringOptionalformat: "number"Defaults to nan
The number of units of a financial instrument held by the account.
valuationobjectOptional
The monetary value of a financial instrument held by the account.
valuation_datedateOptional
Valuation date
performanceobjectOptional
Total Performance
performance_year_to_dateobjectOptional
Year to date performance
performance_last_12_monthsobjectOptional
Last 12 months performance
appreciationobjectOptional
The monetary value of the appreciation of a financial instrument held by the account.
Allowed values:

Every valuation is a snapshot, not a quote. valuation_date is when the institution calculated it — usually the previous close, sometimes older for a fund. Do not present these figures as live market values, and do not compare two extractions taken at different times as if they were.