Impacts

This section deals with the impact from the green assets, as per the particular investments made in them. Any impact data is removed when the associated position is removed.

getPositionImpacts

Returns the impacts of an investment in a green asset

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

Use this operation to retrieve the ESG impacts of a particular position. The operation can return either a JSON formatted data set, or PDF file based on your template which you can provide to your customer as an investor report.

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getPositionImpacts
parameters*	JSON	check Operation parameters

200: OK Successful operation (example)

[
    {
        "position_id": 6,
        "position_amount": 2400000,
        "position_currency_code": "EUR",
        "position_days": 180,
        "investor_identifier": "3a6515809856",
        "investor_name": "John Smith",
        "asset_identifier": "XS24427682",
        "asset_name": "Asset X, 5-year",
        "issuer_identifier": "good-bank-issuer",
        "issuer_name": "Good Bank",
        "impacts": [
            {
                "category_id": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "impact_amount": 485881,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "super_indicator_id": 29,
                "super_indicator_name": "Effect",
                "indicator_id": 35,
                "indicator_name": "Effect",
                "impact_amount": 570,
                "unit_id": 26,
                "unit_name": "kW",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 67,
                "category_name": "Energy efficiency",
                "sub_category_id": 61,
                "sub_category_name": "Energy efficiency",
                "super_indicator_id": 30,
                "super_indicator_name": "Annual electricity/energy production",
                "indicator_id": 36,
                "indicator_name": "Annual electricity/energy production",
                "impact_amount": 69,
                "unit_id": 27,
                "unit_name": "MWh",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "11": "Sustainable cities and communities"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 69,
                "category_name": "Circular economy",
                "sub_category_id": 63,
                "sub_category_name": "Circular economy",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "impact_amount": 1290,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "11": "Sustainable cities and communities",
                    "12": "Responsible consumption and production"
                },
                "eu_objective": {},
                "language": "English"
            }
        ],
        "impact_amount_sum": "N/A"
    }
]

400: Bad Request Error message (example)

{
    "message": "Information is not available for this position and reporting year."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
position_id	number/integer	yes	integer identifier for a investment
reporting_year	number/4 digits	yes	Year of the taxonomy
decryption_key	string	no	For decrypting personally identifiable information
category_only	number/integer	no	Default is all
sub_category_only	number/integer	no	Default is all
super_indicator_only	number/integer	no	Default is all
indicator_only	number/integer	no	Default is all
decimals	number/integer	no	Default is 0 decimals
language_code	string	no	Language codes as per getLanguages. Default is the original language.
report_template	string	no	Input report template name
report_name	string	no	Output report name

Example code

curl

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": "getPositionImpacts",
    "parameters": {
        "position_id": 45,
        "reporting_year": 2023,
        "decryption_key": "64dh_WtAnyMK-f3dtb5-ESweLX80P__a3FjXsgg3Y=",
        "category_only": "",
        "sub_category_only": "",
        "super_indicator_only": "",
        "indicator_only": "",
        "decimals": 0;
        "language_code": "en",
        "report_template": "",
        "report_name": ""
        }
    }

getInvestorImpacts

Returns the impacts of an investor's investments in green assets

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

Use this operation to retrieve the ESG impacts of a particular investor. Here the impacts of multiple investments/positions are stacked on each other.

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getInvestorImpacts
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

[
    {
        "position_id": 6,
        "position_amount": 2400000,
        "position_currency_code": "EUR",
        "position_days": 180,
        "investor_identifier": "3a6515809856",
        "investor_name": "John Smith",
        "asset_identifier": "XS24427682",
        "asset_name": "Asset X, 5-year",
        "issuer_identifier": "good-bank-issuer",
        "issuer_name": "Good Bank",
        "impacts": [
            {
                "category_id": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "impact_amount": 485881,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "super_indicator_id": 29,
                "super_indicator_name": "Effect",
                "indicator_id": 35,
                "indicator_name": "Effect",
                "impact_amount": 570,
                "unit_id": 26,
                "unit_name": "kW",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "super_indicator_id": 30,
                "super_indicator_name": "Annual electricity/energy production",
                "indicator_id": 36,
                "indicator_name": "Annual electricity/energy production",
                "impact_amount": 1542,
                "unit_id": 27,
                "unit_name": "MWh",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            }
        ]
    },
    {
        "position_id": 14,
        "position_amount": 250000,
        "position_currency_code": "EUR",
        "position_days": 180,
        "investor_identifier": "3a6515809856",
        "investor_name": "Lukas Schoultz",
        "asset_identifier": "X123456",
        "asset_name": "Green Deposits",
        "issuer_identifier": "35f0c1a1c08",
        "issuer_name": "Nordea Bank",
        "impacts": [
            {
                "category_id": 1,
                "category_name": "Clean transportation",
                "sub_category_id": 1,
                "sub_category_name": "Electric cars",
                "super_indicator_id": 1,
                "super_indicator_name": "Annual emissions avoided",
                "indicator_id": 1,
                "indicator_name": "Annual emissions avoided",
                "impact_amount": 597,
                "unit_id": 1,
                "unit_name": "kg CO2",
                "year": 2022,
                "sdg": {
                    "11": "Sustainable cities and communities"
                },
                "eu_objective": {
                    "1": "Climate change mitigation",
                    "2": "Climate change adaptation"
                },
                "language": "English"
            },
            {
                "category_id": 1,
                "category_name": "Clean transportation",
                "sub_category_id": 2,
                "sub_category_name": "Electric trains",
                "super_indicator_id": 1,
                "super_indicator_name": "Annual emissions avoided",
                "indicator_id": 1,
                "indicator_name": "Annual emissions avoided",
                "impact_amount": 256,
                "unit_id": 1,
                "unit_name": "kg CO2",
                "year": 2022,
                "sdg": {
                    "11": "Sustainable cities and communities"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 4,
                "category_name": "Renewable energy",
                "sub_category_id": 7,
                "sub_category_name": "Wind",
                "super_indicator_id": 2,
                "super_indicator_name": "Annual energy production",
                "indicator_id": 2,
                "indicator_name": "Annual energy production",
                "impact_amount": 31,
                "unit_id": 2,
                "unit_name": "MWh",
                "year": 2022,
                "sdg": {
                    "3": "Good health and well-being",
                    "7": "Affordable and clean energy",
                    "8": "Decent work and economic growth",
                    "9": "Industry, innovation and infrastructure",
                    "11": "Sustainable cities and communities",
                    "12": "Responsible consumption and production",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            } 
        ]
    }
]

400: Bad Request Error message (example)

{
    "message": "Information is not available for this investor and reporting year."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
investor_identifier	string	yes	String identifier for an investor
asset_identifier	string	no	For a specified asset of an investor
reporting_year	number/4 digits	yes	Year of the taxonomy
decryption_key	string	no	For decrypting personally identifiable information
category_only	number/integer	no	Default is all
sub_category_only	number/integer	no	Default is all
super_indicator_only	number/integer	no	Default is all
indicator_only	number/integer	no	Default is all
decimals	number/integer	no	Default is 0 decimals
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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": "getInvestorImpacts",
    "parameters": {
        "investor_identifier": "9c809eb86ee6",
        "asset_identifier": "XS123456",
        "reporting_year": 2023,
        "decryption_key": "64dh_WtAnyMK-f3dtb5-ESweLX80P__a3FjXsgg3Y=",
        "category_only": "",
        "sub_category_only": "",
        "super_indicator_only": "",
        "indicator_only": "",
        "decimals": 0;
        "language_code": "en"
        }
    }

getPortfolioImpacts

Returns the impacts of an investor's portfolio of investments in green assets

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

Use this operation to retrieve the ESG impacts of a particular portfolio. Here the impacts of multiple investments/positions are consolidated when possibel (when the green framworks are the same).

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getPortfolioImpacts
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

[
    {
        "portfolio_identifier": "portfolio_john",
        "investor_identifier": "3a6515809856",
        "investor_name": "John Smith",
        "positions": [
            {
                "position_id": 6,
                "position_amount": 2400000,
                "position_currency_code": "EUR",
                "position_days": 180,
                "asset_identifier": "XS24427682",
                "asset_name": "Asset Y, 5-year",
                "issuer_identifier": "good-bank-issuer",
                "issuer_name": "Good Bank"
            },
            {
                "position_id": 14,
                "position_amount": 250000,
                "position_currency_code": "EUR",
                "position_days": 180,
                "asset_identifier": "X123456",
                "asset_name": "Green Deposits",
                "issuer_identifier": "35f0c1a1c08",
                "issuer_name": "X Bank"
            },
            {
                "position_id": 16,
                "position_amount": 300000,
                "position_currency_code": "NOK",
                "position_days": 365,
                "asset_identifier": "XS25798443",
                "asset_name": "Asset Y, 4-year",
                "issuer_identifier": "good-bank-issuer",
                "issuer_name": "Good Bank"
            }
        ],
        "impacts": [
            {
                "category_id": 1,
                "category_name": "Rena transporter",
                "sub_category_id": 1,
                "sub_category_name": "Elbilar",
                "super_indicator_id": 1,
                "super_indicator_name": "Årliga utsläpp undvikna",
                "indicator_id": 1,
                "indicator_name": "Årliga utsläpp undvikna",
                "impact_amount": 597,
                "unit_id": 1,
                "unit_name": "kg CO2",
                "year": 2022,
                "sdg": {
                    "11": "Hållbara städer och samhällen"
                },
                "eu_objective": {
                    "1": "Begränsning av klimatförändringar",
                    "2": "Anpassning till klimatförändringar"
                },
                "language": "Svenska"
            },
            {
                "category_id": 1,
                "category_name": "Rena transporter",
                "sub_category_id": 2,
                "sub_category_name": "Elektriska tåg",
                "super_indicator_id": 1,
                "super_indicator_name": "Årliga utsläpp undvikna",
                "indicator_id": 1,
                "indicator_name": "Årliga utsläpp undvikna",
                "impact_amount": 256,
                "unit_id": 1,
                "unit_name": "kg CO2",
                "year": 2022,
                "sdg": {
                    "11": "Hållbara städer och samhällen"
                },
                "eu_objective": {},
                "language": "Svenska"
            },
            {
                "category_id": 2,
                "category_name": "Energieffektivitet",
                "sub_category_id": 3,
                "sub_category_name": "Energieffektivitet",
                "super_indicator_id": 1,
                "super_indicator_name": "Årliga utsläpp undvikna",
                "indicator_id": 1,
                "indicator_name": "Årliga utsläpp undvikna",
                "impact_amount": 70,
                "unit_id": 1,
                "unit_name": "kg CO2",
                "year": 2022,
                "sdg": {
                    "7": "Hållbar energi för alla",
                    "8": "Anständiga arbetsvillkor och ekonomisk tillväxt",
                    "9": "Hållbar industri, innovationer och infrastruktur"
                },
                "eu_objective": {},
                "language": "Svenska"
            },
            {
                "category_id": 69,
                "category_name": "Cirkulär ekonomi",
                "sub_category_id": 63,
                "sub_category_name": "Cirkulär ekonomi",
                "super_indicator_id": 28,
                "super_indicator_name": "Årligt minskade utsläpp",
                "indicator_id": 34,
                "indicator_name": "Årligt minskade utsläpp",
                "impact_amount": 1323,
                "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"
            }
        ]
    }
]

400: Bad Request Error message (example)

{
    "message": "Information is not available for this portfolio and reporting year.."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
portfolio_identfier	string	yes	String identifier for a portfolio
asset_identifier	string	no	For a specified asset in a portfolio
reporting_year	number/4 digits	yes	Year of the taxonomy
decryption_key	string	no	For decrypting personally identifiable information
category_only	number/integer	no	Default is all
sub_category_only	number/integer	no	Default is all
super_indicator_only	number/integer	no	Default is all
indicator_only	number/integer	no	Default is all
decimals	number/integer	no	Default is 0 decimals
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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": "getPortfolioImpacts",
    "parameters": {
        "portfolio_identifier": "portfolio_green_john",
        "asset_identifier": "XS123456",
        "reporting_year": 2023,
        "decryption_key": "64dh_WtAnyMK-f3dtb5-ESweLX80P__a3FjXsgg3Y=",
        "category_only": "",
        "sub_category_only": "",
        "super_indicator_only": "",
        "indicator_only": "",
        "decimals": 0;
        "language_code": "en"
        }
    }

calculatePositionImpacts

Calculates and stores the impact of an investor's investment in a green asset

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

Use this operation to calculate the ESG impacts for a particular position already registered in ESG.Credits.

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	calculatePositionImpacts
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation

{
    "message": "Position impacts were successfully calculated."
}

400: Bad Request Error message (example)

{
    "message": "The FX-rate is not available."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
position_id	number/integer	yes	Integer identifier for a position
position_amount	number	yes	Amount of money invested
position_currency_code	string	yes	Currency code of the investment, as per getCurrencies
position_days	number/integer	no	The term of the investment, default is 365 days
reporting_year	number/ 4 digits	yes	Year of the taxonomy

Example code

curl

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": "getEUObjectives",
    "parameters": {
	"position_id": 6,
	"position_amount": 250000,
	"position_currency_code": "EUR",
	"position_days": 365,
	"reporting_year": 2023
	}
    }

calculatePositionImpactsOnly

Calculates and returns the impact of an investment in a green asset, without having to specify the investor and without storing the result

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

Use this operation to calculate the ESG impacts for a position without any data is stored or logged in ESG.Credits. This operation is applicable for cases when financial institutes wants to utilise ESG.Credits only for calculations and store and investor data in own data repositories.

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	calculatePositionImpactsOnly
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

[
    {
        "position_amount": 4856800,
        "position_currency_code": "SEK",
        "position_days": 365,
        "asset_identifier": "XS24427682",
        "asset_name": "Asset X, 5-year",
        "issuer_identifier": "good-bank-issuer",
        "issuer_name": "Good Bank",
        "impacts": [
            {
                "category_id": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "impact_amount": 196466,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 69,
                "category_name": "Circular economy",
                "sub_category_id": 63,
                "sub_category_name": "Circular economy",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "impact_amount": 521,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "11": "Sustainable cities and communities",
                    "12": "Responsible consumption and production"
                },
                "eu_objective": {},
                "language": "English"
            }
        ],
        "impact_amount_sum": "N/A"
    }
]

400: Bad Request Error message (example)

{
    "message": "Information is not available for this asset and reporting year."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
asset_identifier	string	yes	String identifier for an asset
position_amount	number	yes	Amount of money invested
position_currency_code	string	yes	Currency code of the investment, as per getCurrencies
position_days	number/integer	no	The term of the investment, default is 365 days
reporting_year	number/4 digits	yes	Year of the taxonomy
category_only	number/integer	no	Default is all
sub_category_only	number/integer	no	Default is all
super_indicator_only	number/integer	no	Default is all
indicator_only	number/integer	no	Default is all
decimals	number/integer	no	Default is 0 decimals
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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": "calculatePositionImpactsOnly",
    "parameters": {
        "asset_identifier": "XS123456",
        "position_amount": 250000,
        "position_currency_code": "EUR",
        "position_days": 365,
        "reporting_year": 2023,
        "category_only": "",
        "sub_category_only": "",
        "super_indicator_only": "",
        "indicator_only": "",
        "decimals": 0;
        "language_code": "en"
        }
    }