v1

latestOpenAPI 3.1.02026-07-243613262.4 KB
By ocean carrier

Get CO₂e statistics for a given carrier on a given port pair.

This endpoint returns CO₂ equivalent (CO₂e) emissions statistics of a given carrier and port pair.

We calculate the itineraries operated by the carrier based on their services (and their alliance's) and for each itinerary, we calculate the CO₂e emissions of each vessel operating the service and return statistics. The response provides CO₂e emissions data at two levels:

  • at the carrier level,
  • at each itinerary level.

Response

CO₂ emissions overview

The CO₂e emissions are returned in grams.

FieldGiven at carrier levelGiven at itinerary level
co2e.minGreenest itinerary average emissionsGreenest vessel emissions of a specific itinerary
co2e.maxMost emitting itinerary emissionsMost emitting vessel emissions of a specific itinerary
co2e.averageAverage CO₂e emissions for all itinerariesAverage CO₂e emissions of all vessels of a specific itinerary
co2e.standardDeviationStandard deviation of CO₂e emissions across itinerariesStandard deviation of CO₂e emissions across vessels operating a specific itinerary

Other fields

  • CO₂ breakdown (WTT, TTW, and intensity) is provided for each CO₂e emissions value in the response.
  • Distance is only given at the itinerary level. The distance takes into account the ports of call based on the services proformas.
  • A hash (itineraries.hash) is assigned to each itinerary, acting as a unique identifier for that specific route and shipment characteristics.
    • The corresponding itinerary can be retrieved via the GET /itinerary/v2/proformas/{hash} endpoint.
    • This endpoint provides additional itinerary details, including ports of call and route geometry.

Notes & considerations

  • For the calculation of the emissions:
    • if no container info is provided but the weight is, we assume the container number based on the weight.
    • if none of the above is provided, we assume 1 TEU.
  • For the calculation of the intensity:
    • if no weight is provided but the container info is, we assume the weight based on the container info.
    • if none of the above is provided, we assume 10000 kg.
  • CO₂ calculations are based on itineraries built from carrier services and their planned route.
  • The services parameter forces the routing engine to build itineraries that include the specified services. You can provide up to three service IDs. This is an "AND" condition, meaning the returned itinerary will include all specified services, even if the result is not the most optimal. If no feasible itinerary can be built using all the provided services, no results will be returned.
  • The services sequence matters: the order in which services are provided must match their natural sequence in the itinerary. If services are listed in an order that does not align with a possible route, the request may return no results. However, intermediate services not explicitly listed may still appear between the specified services when necessary to complete the itinerary.
  • In case of an itinerary with transhipments, the minimum CO₂ emissions value is the sum of the minimum values of each leg of the itinerary.
  • Hashes are not intended to be persisted or used as permanent references.

Support endpoints and resources

  • Understand how weight and containerSizeTypeCode impact calculations across all transport modes: visit our Weight and Container Guide.
  • Retrieve maritime carriers: use our Carriers endpoint to search for carrier information based on SCAC codes or names.
  • Retrieve service IDs: use our Search service by name endpoint.
  • Find locations: access accurate data via our Geocoding endpoint.
  • Check the Supported Container size type codes for a complete list of accepted inputs.
  • Learn about our methodology: visit the Methodology for sea emissions calculation page.
get/co2/v2/plan

Query parameters

fromLocodestring required
Example:CNSHA

The UNLOCODE of the departure port.

toLocodestring required
Example:FRLEH

The UNLOCODE of the arrival port.

carrierScacstring
Example:CMDU

The Standard Carrier Alpha Code (SCAC) of the carrier. Note that you must provide either a SCAC or a carrier id.

carrierIdnumber
Example:21

The id of the carrier (can be found via the search endpoints). Note that you must provide either a SCAC or a carrier id.

servicesnumber
Example:1961

The ID of the service(s) (up to three) that must be included in the itinerary.

nContainersnumber
Example:2.5

The number of shipped containers.

containerSizeTypeCodestring
Example:20GP

Code identifying the container’s size and type (e.g., 20GP). See supported values.

weightnumber
Example:10000

The weight of shipped goods in kilograms.

Response

OK