API Reference
DocumentationChangelogConsoleWebsite
  • API Guides
  • Overview
    • API design
    • Errors
    • Webview
    • Fair usage policy
    • Authentication
  • USER CONNECTIONS
    • Users
    • Connectors
    • Connections
  • PRODUCTS
    • DATA AGGREGATION
      • Bank accounts
      • Bank transactions
      • Transactions attachments
      • Categorization
      • Bank account types
      • Balances
      • Currencies
      • Account Ownerships
      • Identities (obsolete)
      • Categories (obsolete)
      • Invoices
      • Credit notes
      • Advisory (obsolete)
      • Indicators
    • WEALTH AGGREGATION
      • Investments
      • Market orders
      • Pockets
      • Loan amortizations
    • DOCUMENTS AGGREGATION
      • Subscriptions
      • Documents
      • Document types
      • Connection Identity
    • PAYMENTS
      • Payments
      • Payment Links
      • Transfers (obsolete)
  • API SETUP
    • Configuration
    • Client applications
Powered by GitBook
On this page
  • API endpoints
  • List investments
  • Get an investment
  • Get history of an investment
  • Data model
  • InvestmentsList object
  • Investment object
  • InvestmentDetails object
  • InvestmentHistoryValuesList object
  • InvestmentHistoryValue object

Was this helpful?

  1. PRODUCTS
  2. WEALTH AGGREGATION

Investments

PreviousWEALTH AGGREGATIONNextMarket orders

Last updated 1 month ago

Was this helpful?

API endpoints

Authentication: endpoints listed in this page require with a user token.

List investments

GET https://{domain}.biapi.pro/2.0/users/{userId}/investments

List investments related to a user.

Path Parameters

Name
Type
Description

userId*

Integer or "me"

ID of the related user.

Query Parameters

Name
Type
Description

label

String

Filter investments using keywords in labels.

code

String

Filter investments by ISIN code.

Response body: InvestmentsList object

Filtering route aliases:
/users/{userId}/accounts/{accountId}/investments
/users/{userId}/connections/{connectionId}/investments

Get an investment

GET https://{domain}.biapi.pro/2.0/investments/{investmentId}

Get a single investment by ID.

Path Parameters

Name
Type
Description

investmentId*

Integer

ID of the investment.

Response body: Investment object

Get history of an investment

GET https://{domain}.biapi.pro/2.0/investments/{investmentId}/history

Get history of a single investment by ID.

Path Parameters

Name
Type
Description

investmentId*

Integer

ID of the investment.

Response body: InvestmentHistoryValuesList object

Data model

InvestmentsList object

Property
Type
Description

valuation

Decimal

Total valuation of all investments.

diff

Decimal

Total absolute capital gain or loss.

diff_percent

Decimal

Total relative capital gain or loss.

prev_diff

Decimal

Total absolute capital gain or loss since the previous value.

prev_diff_percent

Decimal

Total relative capital gain or loss since the previous value (in ratio, 1 meaning 100%).

calculated

Array of strings

List of properties of this response that has been calculated rather than directly obtained from the source.

investments

List of investments.

Investment object

Property
Type
Description

id

Integer

ID of the investment.

id_account

Integer

ID of the related account.

label

String

Display name of the investment.

code

String or null

Technical code of the investment.

code_type

String

Code type: ISIN or AMF.

stock_symbol

String or null

Stock ticker symbol of the investment in the associated stock market.

source

String

Source of the ISIN code: website or notFound.

description

String or null

Description of the investment.

quantity

Decimal

Quantity of stocks of this investment.

unitprice

Decimal

Buy price of one stock.

unitvalue

Decimal

Current value of one stock.

valuation

Decimal

Total current value of the investment.

diff

Decimal

Absolute capital gain or loss.

diff_percent

Decimal

Relative capital gain or loss (in ratio, 1 meaning 100%).

prev_diff

Decimal or null

Absolute capital gain or loss since the previous value.

prev_diff_percent

Decimal or null

Relative capital gain or loss since the previous value (in ratio, 1 meaning 100%).

vdate

Date

Value date of the investment.

prev_vdate

Date or null

Value date of the investment when the previous synchronization occurred.

portfolio_share

Decimal

Allocation ratio of the investment in the portfolio (1 meaning 100%).

calculated

Array of strings

List of properties of this response that has been calculated rather than directly obtained from the source.

deleted

Date or null

Deletion date for investments that no longer exist (null if still present).

last_update

DateTime

Date of the last synchronization of the investment.

original_currency

For international investments, currency of the investment (if different from the bank account).

original_valuation

Decimal or null

For international investments, valuation of the inverstment in the original currency.

original_unitvalue

Decimal or null

For international investments, current value of one stock in the original currency.

original_unitprice

Decimal or null

For international investments, buy price of the investment in the original currency.

original_diff

Decimal or null

For international investments, difference between the buy price and the current valuation in the original currency.

details

Additional information for the investment (if available and activated).

InvestmentDetails object

Property
Type
Description

performance_1_year

Decimal or null

Performance of the stock between one year ago and today (in ratio, 1 meaning 100%).

performance_3_years

Decimal or null

Performance of the stock between three years ago and today (in ratio, 1 meaning 100%).

performance_5_years

Decimal or null

Performance of the stock between five years ago and today (in ratio, 1 meaning 100%).

srri

Decimal or null

Synthetic Risk and Reward Indicator of the stock (from 1 to 7).

asset_category

String or null

Asset category of the stock (Actions, Obligations…).

recommended_period

String or null

Minimum recommended period of investment.

last_update

DateTime or null

Date of the last synchronization of the additional information.

InvestmentHistoryValuesList object

Property
Type
Description

investmentvalues

List of investment history values.

InvestmentHistoryValue object

Property
Type
Description

id

Integer

ID of the investment history.

id_investment

Integer

ID of the related investment.

vdate

Date

Date of the investment history.

unitvalue

Decimal

Value of one stock at the date indicated in vdate.

original_currency

Original currency of the investment history (if different from the account currency).

original_unitvalue

Decimal or null

Value of one stock in the original currency at the date indicated in vdate.

Array of objects

object or null

object or null

Array of objects

or null

header authentication
Currency
Investment
InvestmentDetails
InvestmentHistory
Currency