Issuers

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

getIssuers

Returns private or public issuers

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

Use this operation to retrieve issuers of green assets.

Request Body

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

Example responses

200: OK Successful operation (example)

[
    {
        "issuer_id": 1,
        "issuer_identifier": "35f0c1a1c08",
        "issuer_name": "X Bank",
        "issuer_currency_code": "EUR",
        "issuer_visibility": "public"
    },
    {
        "issuer_id": 6,
        "issuer_identifier": "good-bank-issuer",
        "issuer_name": "Good Bank",
        "issuer_currency_code": "SEK",
        "issuer_visibility": "private"
    }
]

400: Bad Request Error message (example)

{
    "message": "No such issuer is registered."
}

401: Unauthorized Error messagee

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
issuer_visibility	string	no	Public or private. Default is private, meaning not visible across different BWS accounts.

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": "getIssuers",
    "parameters": {
        "issuer_visibility": "public"
        }
    }

addIssuer

Creates or updates information about an existing issuer

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

Use this operation to add issuers of green assets. This operation also alters already existing issuer information.

Request Body

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

Example responses

200: OK Successful operation

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

400: Bad Request Error message (example)

{
    "message": "Invalid issuer visibility term used."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
issuer_identifier	string	yes	String identifier for an issuer
issuer_name	string	yes	Issuer name
issuer_currency_code	string	yes	Currency code of the asset, as per getCurrencies
issuer_visibility	string	no	Public or private. Default is private, meaning not visible across different BWS accounts.

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": "addIssuer",
    "parameters": {
        "issuer_identifier": "good_issuer",
        "issuer_name": "Good Bank",
        "issuer_currency_code": "EUR",
        "issuer_visibility": "private"
        }
    }

removeIssuer

Removes an issuer

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

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

Request Body

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

Example responses

200: OK Successful operation

{
    "Issuer was successfully removed."
}

400: Bad Request Error message (example)

{
    "message": "Issuer was not removed. Asset(s) exist."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
issuer_identifier	string	yes	String identifier for an issuer

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": "removeIssuer",
    "parameters": {
        "issuer_identifier": "good_issuer"
    }