ESG Data Exchange Network API (1.1)

Download OpenAPI specification:Download

The ESG Data Exchange Network API allows the retrieval of published disclosures and the creation and retrieval of transactional scope 1 and 2 statements that are accumulated within disclosures.

Disclosures

Get a specific published disclosure.

This operation retrieves a single disclosure.

Authorizations:
BearerAuth
path Parameters
id
required
string (certificate_id) <= 80 characters

Certificate Identifier

Responses

Response samples

Content type
{
  • "ci": "string",
  • "sid": "string",
  • "iss": "string",
  • "aud": "string",
  • "v": "1",
  • "s": "string",
  • "e1": {
    }
}

Scope 1

Get scope 1 statements.

This operation retrieves statements according to the parameters stored previously. Only owned statements can be retrieved, defined by the api token.

Authorizations:
BearerAuth
query Parameters
from
required
string <date>
to
required
string <date>
page
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post a single scope 1 statement.

This operation creates a data statement for aggregation in the specified scope

Authorizations:
BearerAuth
Request Body schema: application/json
pf
required
string <date>

Period start date (from)

pt
required
string <date>

Period end date (to)

ev
required
number

An emission value in tCO2.

et
required
string <= 255 characters

A subject title of this direct emission.

Responses

Request samples

Content type
application/json
{
  • "pf": "2019-08-24",
  • "pt": "2019-08-24",
  • "ev": 0,
  • "et": "string"
}

Get a scope 1 statement.

This operation retrieves a single scope 1 statement. Only owned statements can be retrieved, defined by the api token.

Authorizations:
BearerAuth
path Parameters
id
required
string (certificate_id) <= 80 characters

Certificate Identifier

Responses

Response samples

Content type
{
  • "ci": "string",
  • "sid": "string",
  • "iss": "string",
  • "v": "1",
  • "s1a": {
    }
}

Delete a scope 1 statement.

This operation deletes a single statement from scope 1. Only owned statements can be deleted, defined by the api token.

Authorizations:
BearerAuth
path Parameters
id
required
string (certificate_id) <= 80 characters

Certificate Identifier

Responses

Scope 2

Get scope 2 statements.

This operation retrieves scope 2 statements according to the parameters stored previously. The energy producer that uploaded the statements and the consumer can retrieve statements previously uploaded.

Authorizations:
BearerAuth
query Parameters
from
required
string <date>
to
required
string <date>
page
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post a single scope 2 statement.

This operation creates a scope 2 statement for aggregation. Only energy producers can upload scope 2 statements.

Authorizations:
BearerAuth
Request Body schema: application/json
pf
required
string <date>

Period start date (from)

pt
required
string <date>

Period end date (to)

required
object (location)

The energy consumer

en
required
number

The energy reading in kWh.

required
object (energy)

Market based energy production information

required
object (energy)

Location based energy production information

Responses

Request samples

Content type
application/json
{
  • "pf": "2019-08-24",
  • "pt": "2019-08-24",
  • "ec": {
    },
  • "en": 0,
  • "m": {
    },
  • "l": {
    }
}

Get a single scope 2 statement.

This operation retrieves a single scope 2 statement. The statement can be retrieved by the energy producer who uploaded it and the consumer this statement is for.

Authorizations:
BearerAuth
path Parameters
id
required
string (certificate_id) <= 80 characters

Certificate Identifier

Responses

Response samples

Content type
{
  • "ci": "string",
  • "sid": "string",
  • "iss": "string",
  • "v": "1",
  • "s2a": {
    }
}

Delete a scope 2 statement.

This operation deletes a single statement from scope 2. Only owned statements can be deleted, defined by the api token.

Authorizations:
BearerAuth
path Parameters
id
required
string (certificate_id) <= 80 characters

Certificate Identifier

Responses