Issuers
This section deals with issuers of green assets, i.e. showing, adding, and removing issuers of green assets
Returns private or public issuers
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve issuers of green assets.
Request Body
solution*
string
BWS.ESG.Credits
operation*
string
getIssuers
parameters
JSON
check Operation parameters
Example responses
[
{
"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"
}
]
Operation parameters
issuer_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": "getIssuers",
"parameters": {
"issuer_visibility": "public"
}
}
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
solution*
string
BWS.ESG.Credits
operation*
string
addIssuer
parameters*
JSON
check Operation parameters
Example responses
{
"message": "Issuer was successfully added."
}
Operation parameters
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 --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"
}
}
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
solution*
string
BWS.ESG.Credits
operation*
string
removeIssuer
parameters*
JSON
check Operation parameters
Example responses
{
"Issuer was successfully removed."
}
Operation parameters
issuer_identifier
string
yes
String identifier for an issuer
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": "removeIssuer",
"parameters": {
"issuer_identifier": "good_issuer"
}
Last updated
Was this helpful?