v1
latestOpenAPI 3.1.02026-07-243613262.4 KBGet CO₂e for inland waters
This endpoint returns CO2e emissions (i.e CO2e equivalent emissions) in grams (g) for a voyage from a given inland port to another using the inland waterways network.
Origin and destination
The origin and destination ports can be given either as locodes or as coordinates. You must provide either fromLocode or fromCoordinates and either toLocode or toCoordinates. You can use the parameter distance (in meters) to pass your own distance (the origin and destination remain mandatory because the co2 computation is region dependent).
Cargo specifications
Several parameters allow you to define the specification of the cargo carried : nContainers, containerSizeTypeCode, weight. The following container types are supported by our API : 20GP, 22G1, 2200, 22G0, 2202, 2210 (20ft, General purpose (Standard)) [Default] 40GP, 42G1, 42G0, 40G1 (40ft, General purpose (Standard)), 40HC, 45G1, 45G0, 4500, 4510 (40ft High cube, General Purpose), 22R1, 2231 (20ft, Reefer), 40NOR, 42R1, 4531 (40ft, Reefer), 40REHC, 45R1, 45R8 (40ft High cube, Reefer), 53GP (53ft High cube).
Here are common use cases :
FCL
use the parameters nContainers and containerSizeTypeCode. We recommend to use the parameter containerSizeTypeCode to precise the size and type of the containers. We will estimate the weight of the cargi based on the container specifications providesd.
LCL
use the parameters weight in combination with an appropriate containerTypeSizeCode (In case of reefer, you can choose 22R1)
Default
Use the parameters weight without container specifications.
Vessel
If known, the type of inland vessel can be given. By default, a motor vessel is always used to compute CO2e (MOTOR_VESSEL).
Response
The response contains WTT (well-to-tank) and TTW (tank-to-wheels) CO2e emissions in grams (g) for the amount of goods carried. It also contains the intensity factor (kg of CO2e per ton.kilometer) which is calculated from the WTW CO2e emissions, the distance and the weight (in properties).
The response contains a parameters field which contains all the parameters that were passed in the query and the default values if some parameters were not passed.
The response contains a properties field which contains the useful information that was used for the calculation, for example the distance of the route calculated. The property dataType precises if the data used to calculate the CO2 emissions is default data (representative of average operating practices) or modeled data (taking into account vehicle information).
Methodology references
The emissions are calculated using the GLEC framework.
Query parameters
The LOCODE of the departure inland port.
The coordinates of the departure inland port given as lon,lat
The LOCODE code of the arrival inland port.
The coordinates of the arrival inland port given as lon,lat
Your own computed distance (if known) in meters.
The weight of shipped goods in kilograms. Default is 1000 kg (1 metric ton). When nContainers is passed, the weight is ignored.
The type of inland vessel. Can be MOTOR_VESSEL, COUPLED_CONVOY, PUSHED_CONVOY, TANKER, CONTAINER_VESSEL_110, CONTAINER_VESSEL_135 or CONTAINER_COUPLED.
The number of containers.
Code to identify the size and the type of the container. Supported values are 20GP, 22G1, 2200, 22G0, 2202, 2210, 40GP, 42G1, 42G0, 40G1, 40HC, 45G1, 4500, 45G0, 22R1, 2231, 42R1, 4531, 40NOR, 45R1, 45R8, 40REHC, 53GP. We recommend to use this parameter instead of containerType and containerSize.
The size of the containers (20, 40 or 45). We recommend to use of the parameter containerSizeTypeCode instead.
The type of the containers (either STANDARD or HIGH_CUBE). Default is STANDARD. We recommend to use of the parameter containerSizeTypeCode instead.
Response
OK