Positions
This section has operations to manage positions taken by investors in green assets, i.e. showing, adding, and removing positions
Returns the investments in green assets by an investor
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve the investments of a particlar investor.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getPositions |
parameters* | JSON | check Operation parameters |
Example response
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for an investor |
asset_identifier | string | no | String identifier for a specified asset to include. Default is all. |
issuer_identifier | string | no | String identifier for a specified issuer 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
Creates and updates an investment in a green asset of an investor
POST
https://api.bws.ninja/v1/call
Use this operation to register investments to a particular investor.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | addPosition |
parameters* | JSON | check Operation parameters |
Example response
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for an investor |
asset_identifier | string | yes | String identifier for an asset |
position_amount | number/integer | yes | Amount of money invested |
position_currency_code | string | yes | Currency code of the investment, as per getCurrencies |
reporting_year | number/4 digits | no | Year of the taxonomy (if impact calculation is to be done at this stage) |
position_days | number/integer | no | The term of the investment, default is 365 days (if impact calculation is to be done at this stage) |
position_start_date | date/YYYY-MM-DD | no | Date of investment (for ESG Credits certificate generation) |
Example code
Removes an investment in a green asset, and also its impact
POST
https://api.bws.ninja/v1/call
Use this operation to remove an investment from a particular investor, where also any associated ESG impact records will be removed.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | removePosition |
parameters* | JSON | check Operation Parameters |
Example response
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for an investor |
position_id | number/integer | yes | Integer identfier for an investment |
Example code
Last updated