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.
This operation retrieves a single disclosure.
id required | string (certificate_id) <= 80 characters Certificate Identifier |
{- "ci": "string",
- "sid": "string",
- "iss": "string",
- "aud": "string",
- "v": "1",
- "s": "string",
- "e1": {
- "pf": "2019-08-24",
- "pt": "2019-08-24",
- "af": 0,
- "am": "string",
- "dt": "CCF",
- "ds": "string",
- "s1": 0,
- "s2.m": 0,
- "s2.l": 0,
- "s3": {
- "s": "string",
- "t": 0,
- "c1": 0,
- "c1.1": 0,
- "c2": 0,
- "c3": 0,
- "c4": 0,
- "c5": 0,
- "c6": 0,
- "c7": 0,
- "c8": 0,
- "c9": 0,
- "c10": 0,
- "c11": 0,
- "c12": 0,
- "c13": 0,
- "c14": 0,
- "c15": 0
}
}
}
This operation retrieves statements according to the parameters stored previously. Only owned statements can be retrieved, defined by the api token.
from required | string <date> |
to required | string <date> |
page | integer |
[- {
- "ci": "string",
- "sid": "string",
- "iss": "string",
- "v": "1",
- "s1a": {
- "pf": "2019-08-24",
- "pt": "2019-08-24",
- "ev": 0,
- "et": "string"
}
}
]
This operation creates a data statement for aggregation in the specified scope
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. |
{- "pf": "2019-08-24",
- "pt": "2019-08-24",
- "ev": 0,
- "et": "string"
}
This operation retrieves a single scope 1 statement. Only owned statements can be retrieved, defined by the api token.
id required | string (certificate_id) <= 80 characters Certificate Identifier |
{- "ci": "string",
- "sid": "string",
- "iss": "string",
- "v": "1",
- "s1a": {
- "pf": "2019-08-24",
- "pt": "2019-08-24",
- "ev": 0,
- "et": "string"
}
}
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.
from required | string <date> |
to required | string <date> |
page | integer |
[- {
- "ci": "string",
- "sid": "string",
- "iss": "string",
- "v": "1",
- "s2a": {
- "pf": "2019-08-24",
- "pt": "2019-08-24",
- "ec": {
- "it": "generic",
- "id": "string"
}, - "en": 0,
- "m": {
- "ep": {
- "it": "generic",
- "id": "string"
}, - "ef": 0,
- "em": [
- "nuclear"
], - "qc": [
- "string"
]
}, - "l": {
- "ep": {
- "it": "generic",
- "id": "string"
}, - "ef": 0,
- "em": [
- "nuclear"
], - "qc": [
- "string"
]
}
}
}
]
This operation creates a scope 2 statement for aggregation. Only energy producers can upload scope 2 statements.
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 |
{- "pf": "2019-08-24",
- "pt": "2019-08-24",
- "ec": {
- "it": "generic",
- "id": "string"
}, - "en": 0,
- "m": {
- "ep": {
- "it": "generic",
- "id": "string"
}, - "ef": 0,
- "em": [
- "nuclear"
], - "qc": [
- "string"
]
}, - "l": {
- "ep": {
- "it": "generic",
- "id": "string"
}, - "ef": 0,
- "em": [
- "nuclear"
], - "qc": [
- "string"
]
}
}
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.
id required | string (certificate_id) <= 80 characters Certificate Identifier |
{- "ci": "string",
- "sid": "string",
- "iss": "string",
- "v": "1",
- "s2a": {
- "pf": "2019-08-24",
- "pt": "2019-08-24",
- "ec": {
- "it": "generic",
- "id": "string"
}, - "en": 0,
- "m": {
- "ep": {
- "it": "generic",
- "id": "string"
}, - "ef": 0,
- "em": [
- "nuclear"
], - "qc": [
- "string"
]
}, - "l": {
- "ep": {
- "it": "generic",
- "id": "string"
}, - "ef": 0,
- "em": [
- "nuclear"
], - "qc": [
- "string"
]
}
}
}