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
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
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
curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
"solution": "BWS.ESG.Credits",
"operation": "getAssets",
"parameters": {
"issuer_visibility": "public",
"issuer_identifier": "good_issuer",
"framework_identifier:" "greenbond"
}
}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
solution*
string
BWS.ESG.Credits
operation*
string
getAssetFrameworkDetails
parameters*
JSON
check Operation parameters
Example responses
[
{
"framework_id": 3,
"framework_identifier": "greenbond",
"framework_name": "Good Bank Green Bond Framework",
"framework_value_outstanding": 22224856800,
"framework_allocated_amount": 22224856800,
"framework_active_percentage": 1.0,
"framework_currency_code": "SEK",
"value_outstanding_framework": "yes",
"framework_visibility": "private",
"framework": [
{
"category_id": 63,
"category_name": "Förnyelsebar energi",
"sub_category_id": 55,
"sub_category_name": "Vindkraft",
"sub_category_volume": 11540605381,
"currency_code": "SEK",
"super_indicator_id": 28,
"super_indicator_name": "Årligt minskade utsläpp",
"indicator_id": 34,
"indicator_name": "Årligt minskade utsläpp",
"indicator_value": 899034000.0,
"unit_id": 25,
"unit_name": "CO2e kg",
"year": 2022,
"sdg": {
"7": "Hållbar energi för alla",
"13": "Bekämpa klimatförändringar"
},
"eu_objective": {},
"language": "Svenska"
},
{
"category_id": 63,
"category_name": "Förnyelsebar energi",
"sub_category_id": 55,
"sub_category_name": "Vindkraft",
"sub_category_volume": 11540605381,
"currency_code": "SEK",
"super_indicator_id": 29,
"super_indicator_name": "Effekt",
"indicator_id": 35,
"indicator_name": "Effekt",
"indicator_value": 1054000.0,
"unit_id": 26,
"unit_name": "kW",
"year": 2022,
"sdg": {
"7": "Hållbar energi för alla",
"13": "Bekämpa klimatförändringar"
},
"eu_objective": {},
"language": "Svenska"
},
{
"category_id": 69,
"category_name": "Cirkulär ekonomi",
"sub_category_id": 63,
"sub_category_name": "Cirkulär ekonomi",
"sub_category_volume": 15578758,
"currency_code": "SEK",
"super_indicator_id": 28,
"super_indicator_name": "Årligt minskade utsläpp",
"indicator_id": 34,
"indicator_name": "Årligt minskade utsläpp",
"indicator_value": 2386000.0,
"unit_id": 25,
"unit_name": "CO2e kg",
"year": 2022,
"sdg": {
"11": "Hållbara städer och samhällen",
"12": "Hållbar konsumtion och produktion"
},
"eu_objective": {},
"language": "Svenska"
}
]
}
]Operation parameters
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
curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
"solution": "BWS.ESG.Credits",
"operation": "getAssetFrameworkDetails",
"parameters": {
"asset_identifier": "XS123456",
"reporting_year": 2023,
"language_code": "en"
}
}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
solution*
string
BWS.ESG.Credits
operation*
string
addAsset
parameters*
JSON
check Operation parameters
Example responses
{
"message": "Asset successfully added. Asset needs to be private."
}Operation parameters
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
curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
"solution": "BWS.ESG.Credits",
"operation": "addAsset",
"parameters": {
"asset_identifier": "XS123456",
"asset_name": "Green deposit, 4-year",
"issuer_identifier": "good_issuer",
"framework_identifier": "greenbond",
"asset_value_outstanding": 1100000000,
"asset_currency_code": "EUR",
"date_issued": "2022-11-09",
"date_maturity": "2026-11-09",
"asset_visibility": "private"
}
}Removes a green asset
POST https://api.bws.ninja/v1/call
Use this operation to remove green assets from the ESG.Credits data repository.
solution*
string
BWS.ESG.Credits
operation*
string
removeAsset
parameters*
JSON
check Operation parameters
Example responses
{
"Asset was successfully removed."
}Request Body
Operation parameters
asset_identifier
string
yes
String identifier for an asset
Example code
curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
"solution": "BWS.ESG.Credits",
"operation": "removeAsset",
"parameters": {
"asset_identifier": "XS123456"
}
}Last updated
Was this helpful?