Investments
API endpoints
Authentication: endpoints listed in this page require header authentication 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
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 |
---|---|---|
| Decimal | Total valuation of all investments. |
| Decimal | Total absolute capital gain or loss. |
| Decimal | Total relative capital gain or loss. |
| Decimal | Total absolute capital gain or loss since the previous value. |
| Decimal | Total relative capital gain or loss since the previous value (in ratio, 1 meaning 100%). |
| Array of strings | List of properties of this response that has been calculated rather than directly obtained from the source. |
| Array of Investment objects | List of investments. |
Investment object
Property | Type | Description |
---|---|---|
| Integer | ID of the investment. |
| Integer | ID of the related account. |
| Integer | ID of the related security. |
| FinanceSecurityType integer or null | ID of the finance security type. |
| String | Display name of the investment. |
| String or null | Technical code of the investment. |
| String | Code type: |
| String or null | Stock ticker symbol of the investment in the associated stock market. |
| String | Source of the ISIN code: |
| String or null | Description of the investment. |
| Decimal | Quantity of stocks of this investment. |
| Decimal | Buy price of one stock. |
| Decimal | Current value of one stock. |
| Decimal | Total current value of the investment. |
| Decimal | Absolute capital gain or loss. |
| Decimal | Relative capital gain or loss (in ratio, 1 meaning 100%). |
| Decimal or null | Absolute capital gain or loss since the previous value. |
| Decimal or null | Relative capital gain or loss since the previous value (in ratio, 1 meaning 100%). |
| Date | Value date of the investment. |
| Date or null | Value date of the investment when the previous synchronization occurred. |
| Decimal | Allocation ratio of the investment in the portfolio (1 meaning 100%). |
| Array of strings | List of properties of this response that has been calculated rather than directly obtained from the source. |
| Date or null | Deletion date for investments that no longer exist ( |
| DateTime | Date of the last synchronization of the investment. |
| Currency object or null | For international investments, currency of the investment (if different from the bank account). |
| Decimal or null | For international investments, valuation of the inverstment in the original currency. |
| Decimal or null | For international investments, current value of one stock in the original currency. |
| Decimal or null | For international investments, buy price of the investment in the original currency. |
| Decimal or null | For international investments, difference between the buy price and the current valuation in the original currency. |
| InvestmentDetails object or null | Additional information for the investment (if available and activated). |
InvestmentDetails object
Property | Type | Description |
---|---|---|
| Decimal or null | Performance of the stock between one year ago and today (in ratio, 1 meaning 100%). |
| Decimal or null | Performance of the stock between three years ago and today (in ratio, 1 meaning 100%). |
| Decimal or null | Performance of the stock between five years ago and today (in ratio, 1 meaning 100%). |
| Decimal or null | Synthetic Risk and Reward Indicator of the stock (from 1 to 7). |
| String or null | Asset category of the stock (Actions, Obligations…). |
| String or null | Minimum recommended period of investment. |
| DateTime or null | Date of the last synchronization of the additional information. |
FinanceSecurityType values
Value | Description |
---|---|
1 | OPCVM |
2 | Trackers - ETF |
3 | Actions |
Forward compatibility requirement: additional values may be added in the future. When implementing ID matching, always fallback to a generic case for unknown ids.
InvestmentHistoryValuesList object
Property | Type | Description |
---|---|---|
| Array of InvestmentHistory objects | List of investment history values. |
InvestmentHistoryValue object
Property | Type | Description |
---|---|---|
| Integer | ID of the investment history. |
| Integer | ID of the related investment. |
| Date | Date of the investment history. |
| Decimal | Value of one stock at the date indicated in |
| Currency or null | Original currency of the investment history (if different from the account currency). |
| Decimal or null | Value of one stock in the original currency at the date indicated in |
Last updated