Frameworks

This section has operations to build up green frameworks to which green assets will be tied

Returns private or public green frameworks for a particular reporting year

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

Use this operation to retrieve green frameworks registered in ESG.Credits data repository.

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

getFrameworks

parameters*

JSON

check Operation parameters

[
    {
        "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"
    }
]

Operation parameters

ParameterType/FormatRequiredDescription

reporting_year

number/4 digits

yes

Year of the taxonomy

framework_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": "getFrameworks",
    "parameters": {
        "reporting_year": 2023,
        "framework_visibility": "private"
        }
    }

Returns details about a green framework for a particular reporting year

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

Use this operations to retrieve green framework details.

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

getFrameworkDetails

parameters*

JSON

check Operation parameters

[
    {
        "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": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "sub_category_volume": 11540605381,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 899034000.0,
                "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",
                "sub_category_volume": 11540605381,
                "framework_currency_code": "SEK",
                "super_indicator_id": 29,
                "super_indicator_name": "Effect",
                "indicator_id": 35,
                "indicator_name": "Effect",
                "indicator_value": 1054000.0,
                "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",
                "sub_category_volume": 11540605381,
                "framework_currency_code": "SEK",
                "super_indicator_id": 30,
                "super_indicator_name": "Annual electricity/energy production",
                "indicator_id": 36,
                "indicator_name": "Annual electricity/energy production",
                "indicator_value": 2854000.0,
                "unit_id": 27,
                "unit_name": "MWh",
                "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": 56,
                "sub_category_name": "Hydro- and solar power, biogas",
                "sub_category_volume": 1634937960,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 137922000.0,
                "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": 56,
                "sub_category_name": "Hydro- and solar power, biogas",
                "sub_category_volume": 1634937960,
                "framework_currency_code": "SEK",
                "super_indicator_id": 29,
                "super_indicator_name": "Effect",
                "indicator_id": 35,
                "indicator_name": "Effect",
                "indicator_value": 97000.0,
                "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": 56,
                "sub_category_name": "Hydro- and solar power, biogas",
                "sub_category_volume": 1634937960,
                "framework_currency_code": "SEK",
                "super_indicator_id": 30,
                "super_indicator_name": "Annual electricity/energy production",
                "indicator_id": 36,
                "indicator_name": "Annual electricity/energy production",
                "indicator_value": 438000.0,
                "unit_id": 27,
                "unit_name": "MWh",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 64,
                "category_name": "Green buildings",
                "sub_category_id": 57,
                "sub_category_name": "Green buildings",
                "sub_category_volume": 4448331209,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 1055000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 64,
                "category_name": "Green buildings",
                "sub_category_id": 57,
                "sub_category_name": "Green buildings",
                "sub_category_volume": 4448331209,
                "framework_currency_code": "SEK",
                "super_indicator_id": 31,
                "super_indicator_name": "Annual energy savings",
                "indicator_id": 37,
                "indicator_name": "Annual energy savings",
                "indicator_value": 3300.0,
                "unit_id": 27,
                "unit_name": "MWh",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 65,
                "category_name": "Sustainable forestry",
                "sub_category_id": 58,
                "sub_category_name": "Sustainable forestry",
                "sub_category_volume": 1802775422,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 112606000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "13": "Climate action",
                    "15": "Life on land"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 66,
                "category_name": "Clean transportation",
                "sub_category_id": 59,
                "sub_category_name": "Biogas/electrical buses and electrical cars",
                "sub_category_volume": 1023174120,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 8029000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "11": "Sustainable cities and communities",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 66,
                "category_name": "Clean transportation",
                "sub_category_id": 60,
                "sub_category_name": "Electric trains",
                "sub_category_volume": 1027452118,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 12913000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "11": "Sustainable cities and communities",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 67,
                "category_name": "Energy efficiency",
                "sub_category_id": 61,
                "sub_category_name": "Energy efficiency",
                "sub_category_volume": 304535860,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 79697000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "11": "Sustainable cities and communities"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 67,
                "category_name": "Energy efficiency",
                "sub_category_id": 61,
                "sub_category_name": "Energy efficiency",
                "sub_category_volume": 304535860,
                "framework_currency_code": "SEK",
                "super_indicator_id": 29,
                "super_indicator_name": "Effect",
                "indicator_id": 35,
                "indicator_name": "Effect",
                "indicator_value": 15000.0,
                "unit_id": 26,
                "unit_name": "kW",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "11": "Sustainable cities and communities"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 67,
                "category_name": "Energy efficiency",
                "sub_category_id": 61,
                "sub_category_name": "Energy efficiency",
                "sub_category_volume": 304535860,
                "framework_currency_code": "SEK",
                "super_indicator_id": 30,
                "super_indicator_name": "Annual electricity/energy production",
                "indicator_id": 36,
                "indicator_name": "Annual electricity/energy production",
                "indicator_value": 128000.0,
                "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": 68,
                "category_name": "Pollution prevention and control",
                "sub_category_id": 62,
                "sub_category_name": "Pollution prevention and control",
                "sub_category_volume": 427465972,
                "framework_currency_code": "SEK",
                "super_indicator_id": 29,
                "super_indicator_name": "Effect",
                "indicator_id": 35,
                "indicator_name": "Effect",
                "indicator_value": 60000.0,
                "unit_id": 26,
                "unit_name": "kW",
                "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",
                "sub_category_volume": 15578758,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 2386000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "11": "Sustainable cities and communities",
                    "12": "Responsible consumption and production"
                },
                "eu_objective": {},
                "language": "English"
            }
        ]
    }
]

Operation parameters

ParameterType/FormatRequiredDescription

framework_identifier

string

yes

String identifier for a framework

reporting_year

number/4 digits

yes

Year of the taxonomy

language_code

string

no

Language codes 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": "getFrameworkDetails",
    "parameters": {
        "framework_identifier": "greenbond",
        "reporting_year": 2023,
        "language_code": "en"
        }
    }

Creates and updates the information about a green framework

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

Use this operation to add green frameworks to the ESG.Credits data repository.

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

addFramework

parameters*

JSON

check Operation parameters

{
    "message": "Framework was successfully added."
}

Operation parameters

ParameterType/FormatRequiredDescription

framework_identifier

string

yes

String identifier for a framework

framework_name

string

yes

Framework name

framework_currency_code

string

yes

Currency code of the framework, as per getCurrencies

framework_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": "addFramework",
    "parameters": {
        "framework_identifier": "greenbond",
        "framework_name": "Green Bond Framework",
        "framework_currency_code": "SEK",
        "framework_visibility": "private"
        }
    }

Adds reporting year specific details to a green framework

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

Use this operation to set up the green framework with details that are year specific.

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

addYearSpecificsToFramework

parameters

JSON

check Operation parameters

{
    "message": "Year specific data for the framework has been succesfully added."
}

Operation parameters

ParameterType/FormatRequiredDescription

framework_identifier

string

yes

String identifier for a framework

value_outstanding

number

yes

Amount of funding raised to green projects for the framework as a whole, for the reporting year

allocated_amount

number

yes

Amount of funding allocated to projects for the reporting year of the framework, for the corresponding impacts registered

value_outstanding_framework

string

yes

Choose "yes" when use of proceeds relate to value outstanding, choose "no" when related to allocated amount

reporting_year

number/4 digits

yes

Year of the taxonomy

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": "addYearSpecificsToFramework",
    "parameters": {
        "framework_identifier": "greenbond",
        "value_outstanding": 22224856800,
        "allocated_amount": 22224856800,
        "value_outstanding_framework": "yes",
        "reporting_year": 2023
        }
    }

Adds and updates category and indicator values to a green framework

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

Use this operation to set up the different impact categories, indicators, and units, with specified values.

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

addCategoryIndicatorToFramework

parameters*

JSON

check Operation parameters

{
    "message": "Category volume / indicator values were successfully added."
}

Operation parameters

ParameterType/FormatRequiredDescription

framework_identifier

string

yes

String identifier for a framework

sub_category_id

number/integer

yes

Integer identifier of a sub category

sub_category_volume

number

yes

Amount of funding / use of proceeds

indicator_id

number/integer

yes

Integer identifier of an indicator

indicator_value

number

yes

ESG benefit value, in the unit specified by the taxonomy

reporting_year

number/4 digits

yes

Year of the taxonomy

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": "addCategoryIndicatorToFramework",
    "parameters": {
 	"framework_identifier": "greenbond",
	"sub_category_id": 56,
	"sub_category_volume": 1634937960,
	"indicator_id": 34,
	"indicator_value": 137922,
	"reporting_year": 2023
	}
    }

removeIndicatorFromFramework

POST

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

removeIndicatorFromFramework

parameters*

JSON

check Operation parameters

Operation parameters

ParameterType/FormatRequiredDescription

framework_identifier

string

yes

indicator_id

number/integer

yes

sub_category_id

number/integer

yes

reporting_year

number/4 digits

yes

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": "removeIndicatorFromFramework",
    "parameters": {
        "framework_identifier": "greenbond",
        "indicator_id": 34,
        "sub_category_id": 56
        "reporting_year": 2023
        }
    }

removeCategoryFromFramework

POST

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

check Operation parameters

parameters*

string

check Operation parameters

Operation parameters

ParameterType/FormatRequiredDescription

framework_identifier

string

yes

sub_category_id

number/integer

yes

reporting_year

number/4 digits

yes

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": "removeCategoryFromFramework",
    "parameters": {
        "framework_identifier": "greenbond",
        "sub_category_id": 35,
        "reporting_year": 2023
        }
    }

removeFrameworkYearSpecifics

POST

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

removeFrameworkYearSpecifics

parameters*

JSON

check Operation parameters

Operation parameters

ParameterType/FormatRequiredDescription

framework_identifier

string

yes

reporting_year

number/4 digits

yes

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": "removeFrameworkYearSpecifics",
    "parameters": {
        "framework_identifier": "greenbond",
        "reporting_year": 2023
        }
    }

removeFramework

POST

Request Body

NameTypeDescription

solution*

string

BWS.ESG.Credits

operation*

string

removeFramework

parameters*

JSON

check Operation parameters

Operation parameters

ParameterType/FormatRequiredDescription

framework_identifier

string

yes

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": "removeFramework",
    "parameters": {
        "framework_identifier": "greenbond"
        }
    }

Last updated