Assets

This section deals with green assets, i.e. showing, adding, and removing assets

Returns information about private or public green assets

POST https://api.bws.ninja/v1/call

Use this operation to retrieve green assets stored in the ESG.Credits data repository.

Request Body

Name
Type
Description

solution*

string

BWS.ESG.Credits

operation*

string

getAssets

parameters

JSON

check Operation parameters

Example responses

[
    {
        "asset_id": 4,
        "asset_identifier": "XS24427682",
        "asset_name": "Asset X, 5-year",
        "asset_value_outstanding": 1100000000,
        "asset_currency_code": "EUR",
        "asset_date_issued": "2022-02-09",
        "asset_date_maturity": "2027-08-09",
        "issuer_identifier": "good-bank-issuer",
        "issuer_name": "Good Bank",
        "framework_identifier": "greenbond",
        "framework_name": "Good Bank Green Bond Framework",
        "asset_visibility": "private"
    },
    {
        "asset_id": 5,
        "asset_identifier": "XS25538443",
        "asset_name": "Asset Y, 4-year",
        "asset_value_outstanding": 1100000000,
        "asset_currency_code": "EUR",
        "asset_date_issued": "2022-11-09",
        "asset_date_maturity": "2026-11-09",
        "issuer_identifier": "good-bank-issuer",
        "issuer_name": "Good Bank",
        "framework_identifier": "greenbond",
        "framework_name": "Good Bank Green Bond Framework",
        "asset_visibility": "private"
    }
]

Operation parameters

Parameter
Type/Format
Required
Description

issuer_visibility

string

no

Public or private. Default is private, meaning not visible across different BWS accounts.

issuer_identifier

string

no

String identifier for a specified issuer to be included. Default is all.

framework_identifier

string

no

String identifier for a specified framework to be included. Default is all.

Example code

Returns framework details applicable to particular green asset

POST https://api.bws.ninja/v1/call

Use this operation to retrieve the framework details of the asset in question.

Request Body

Name
Type
Description

solution*

string

BWS.ESG.Credits

operation*

string

getAssetFrameworkDetails

parameters*

JSON

check Operation parameters

Example responses

Operation parameters

Parameter
Type/Format
Required
Description

asset_identifier

string

yes

String identifier for an asset (e.g. ISIN)

reporting_year

number/4 digits

yes

Year of the taxonomy

language_code

string

no

Language selection as per getLanguages. Default is the original language.

Example code

Creates and updates information about an existing green asset

POST https://api.bws.ninja/v1/call

Use this operation to add assets to the ESG.Credits data repository. This operation is also used to alter already existing asset information.

Request Body

Name
Type
Description

solution*

string

BWS.ESG.Credits

operation*

string

addAsset

parameters*

JSON

check Operation parameters

Example responses

Operation parameters

Parameter
Type/Format
Required
Description

asset_identifier

string

yes

String identifier for an asset (e.g. ISIN)

asset_name

string

yes

Asset name

issuer_identifier

string

yes

String identifier for the issuer of the asset

framework_identifier

string

yes

String identifier for the green framework of the asset

asset_value_outstanding

number/integer

no

Amount of money subject to green investments (framework ditto used in impact calculations)

asset_currency_code

string

yes

Currency code of the asset, as per getCurrencies

date_issued

date/YYYY-MM-DD

no

Issue date if applicable

date_maturity

date/YYYY-MM-DD

no

Maturation date if applicable

asset_visibility

string

no

Public or private. Default is private, meaning not visible across different BWS accounts.

Example code

Removes a green asset

POST https://api.bws.ninja/v1/call

Use this operation to remove green assets from the ESG.Credits data repository.

Name
Type
Description

solution*

string

BWS.ESG.Credits

operation*

string

removeAsset

parameters*

JSON

check Operation parameters

Example responses

Request Body

Operation parameters

Parameter
Type/Format
Required
Description

asset_identifier

string

yes

String identifier for an asset

Example code

Last updated

Was this helpful?