Portfolios
This section includes operations to manage portfolios of green assets, i.e. showing, adding, and removing portfolios and positions in them
Returns all portfolios of all investors
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve the portfolios of your investors.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getPortfolios |
parameters* | string | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for an investor |
asset_identifier | string | no | String identifier for an asset to include. Default is all. |
user_identifier | string | no | For limiting the output to the investors that the user has access to |
decryption_key | string | no | For decrypting personally identifiable information |
Example code
Returns all investments in green assets in a portfolio of an investor
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve all green investments in an investors portfolio.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getPortfolioPositions |
parameters* | JSON | check Operation Parameters |
Example responses
Operation Parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
portfolio_identifier | string | yes | String identifier for a portfolio |
Example code
Creates and updates the information of an existing portfolio of an investor
POST
https://api.bws.ninja/v1/call
Use this operation to create a portfolio for an investor, next to be associated with specific investments. This operation is also used to alter already existing portfolio information.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addPortfolio |
parameters* | JSON | check Operation Parameters |
Example responses
Operation Parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for an investor |
portfolio_identifier | string | yes | String identifier for a portfolio |
portfolio_identifier_changed | string | no | Used to change the portfolio identifier |
Example code
Adds an investment in a green asset to a portfolio of an investor
POST
https://api.bws.ninja/v1/call
Use this operation to associate particular investments to a portfolio. Impacts can then be consolidated on portfolio level.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addPositionToPortfolio |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identfier | string | yes | String identifier for an investor |
portfolio_identifier | string | yes | String identifier for a portfolio |
position_id | number/integer | yes | Integer identifier for an investment |
Example code
Removes an investment in a green asset from a portfolio of an investor
POST
https://api.bws.ninja/v1/call
Use this operation to remove positions from a portfolio, prior to removal of the investment as such.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | removePositionFromPortfolio |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identfier | string | yes | String identifier for an investor |
portfolio_identifier | string | yes | String identifier for a portfolio |
position_id | number/integer | yes | Integer identifier for an investment |
Example code
Removes a portfolio of an investor
POST
https://api.bws.ninja/v1/call
Use this operation to remove a portfolio, prior to removing the investor.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | removePortfolio |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for an investor |
portfolio_identifier | string | yes | String identifier for a portfolio |
Example code
Last updated