CII Calculation API (1.874.0)
Download OpenAPI specification:Download
This Carbon Intensity Indicator(CII) API can be used to calculate voyage CII, year-to-date CII and year-end CII ratings.
Case specific correction factors and voyage adjustments are not included in the calculations.
Request a CII rating calculation
Request a CII rating calculation by supplying information about a vessel.
Authorizations:
Request Body schema: application/json
| ciiVesselType required | string The CII vessel type. detailsThe selected vessel type affects which measure of capacity (deadweight vs gross tonnage) is required.
| ||||||||||||||||||||||||||
| deadweight required | number <Tonnes (t)> ( 0 .. 500000 ] The deadweight of the vessel. | ||||||||||||||||||||||||||
| distanceTravelled required | number <Nautical Miles (nm)> > 0 The total distance travelled to be factored into the CII Rating | ||||||||||||||||||||||||||
| ratingYear required | integer [ 2020 .. 2026 ] The year to calculate a rating for. detailsThe rating year controls what reduction factor (relative to the 2019 reference ) is applied when calculating the required CII:
| ||||||||||||||||||||||||||
| totalEmissions required | number <Grams (g)> >= 0 The total emissions to be factored into the CII Rating | ||||||||||||||||||||||||||
| grossTonnage | number ( 0 .. 300000 ] The gross tonnage of the vessel. |
Responses
Response Schema: application/json
| apiVersion required | string Version of the API this response was generated from |
| attainedCii required | number <CII (gCO2/capacity.nm)> The CII attained with the given inputs. |
required | string Enum: "A" "B" "C" "D" "E" The CII Rating calculated with the given input. |
| correlationId required | string Internal identifier of the request |
| referenceCii required | number <CII (gCO2/capacity.nm)> The reference CII for 2019 for the selected vessel type and capacity. |
| requiredCii required | number <CII (gCO2/capacity.nm)> The required annual operational CII for the selected year calculated by applying appropriate reduction factor on reference CII |
| warnings required | Array of strings Human-readable explanations specific to this occurrence. |
Request samples
- Payload
{- "totalEmissions": 12953,
- "distanceTravelled": 54289,
- "ratingYear": 2023,
- "deadweight": 41820,
- "grossTonnage": 76500,
- "ciiVesselType": "ContainerVessel"
}Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{- "correlationId": "PsFtKHanDoEF2Gg=",
- "warnings": [
- "string"
], - "apiVersion": "1.874.0",
- "attainedCii": 0.82,
- "referenceCii": 1.95,
- "requiredCii": 1.85,
- "ciiRating": "A"
}