- HTTP request
- Request body
- Response body
- Scope3FlightSegment
- CabinClass
- Scope3FlightEmissions
- Scope3DataType
- Try it!
Stateless method to retrieve GHG emissions estimates for a set of flight segments for Scope 3 reporting.
The response will contain all entries that match the input Scope3FlightSegment
flight segments, in the same order provided. The estimates will be computed using the following cascading logic (using the first one that is available):
- TIM-based emissions given
origin
,destination
,carrier
,flightNumber
,departureDate
, andcabinClass
. - Typical flight emissions given
origin
,destination
, year indepartureDate
, andcabinClass
. - Distance-based emissions calculated using
distanceKm
, year indepartureDate
, andcabinClass
.
If there is a future flight requested in this calendar year, we do not support Tier 1 emissions and will fallback to Tier 2 or 3 emissions. If the requested future flight is in not in this calendar year, we will return an empty response. We recommend that for future flights, computeFlightEmissions
API is used instead.
If there are no estimates available for a certain flight with any of the three methods, the response will return a Scope3FlightEmissions
object with empty emission fields. The request will still be considered successful. Generally, missing emissions estimates occur when the flight is unknown to the server (e.g. no specific flight exists, or typical flight emissions are not available for the requested pair).
The request will fail with an INVALID_ARGUMENT
error if:
- The request contains more than 1,000 flight legs.
- The input flight leg is missing one or more identifiers. For example, missing origin/destination without a valid distance for
TIM_EMISSIONS
orTYPICAL_FLIGHT_EMISSIONS
type matching, or missing distance for aDISTANCE_BASED_EMISSIONS
type matching (if you want to fallback to distance-based emissions or want a distance-based emissions estimate, you need to specify a distance). - The flight date is before 2019 (Scope 3 data is only available for 2019 and after).
- The flight distance is 0 or lower.
- Missing cabin class.
Because the request is processed with fallback logic, it is possible that misconfigured requests return valid emissions estimates using fallback methods. For example, if a request has the wrong flight number but specifies the origin and destination, the request will still succeed, but the returned emissions will be based solely on the typical flight emissions. Similarly, if a request is missing the origin for a typical flight emissions request, but specifies a valid distance, the request could succeed based solely on the distance-based emissions. Consequently, one should check the source of the returned emissions (source
) to confirm the results are as expected.
HTTP request
POST https://travelimpactmodel.googleapis.com/v1/flights:computeScope3FlightEmissions
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "flights": [ { object ( |
Fields | |
---|---|
flights[] |
Required. Flights to return emission estimates for. |
modelVersion |
Optional. The model version under which emission estimates for all flights in this request were computed. |
Response body
A list of flights with Scope 3 emission estimates.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "flightEmissions": [ { object ( |
Fields | |
---|---|
flightEmissions[] |
List of flight segments with emission estimates. |
modelVersion |
The model version under which emission estimates for all flights in this response were computed. |
Scope3FlightSegment
Flight parameters with which the Scope 3 emissions are fetched.
JSON representation |
---|
{ "departureDate": { object ( |
Fields | |
---|---|
departureDate |
Required. Date of the flight in the time zone of the origin airport. Only year is required for typical flight and distance-based emissions models (month and day values are ignored and therefore, can be either omitted, set to 0, or set to a valid date for those cases). Correspondingly, if a specific date is not provided for TIM emissions, we will fallback to typical flight (or distance-based) emissions. |
cabinClass |
Required. The cabin class of the flight. |
origin |
Optional. IATA airport code for flight origin, e.g. |
destination |
Optional. IATA airport code for flight destination, e.g. |
carrierCode |
Optional. IATA carrier code, e.g. |
flightNumber |
Optional. Flight number, e.g. |
distanceKm |
Optional. Distance in kilometers, e.g. |
CabinClass
The cabin class of the flight.
Enums | |
---|---|
CABIN_CLASS_UNSPECIFIED |
Unspecified cabin class. |
ECONOMY |
Economy class. |
PREMIUM_ECONOMY |
Premium economy class. |
BUSINESS |
Business class. |
FIRST |
First class. |
Scope3FlightEmissions
Scope 3 flight with emission estimates.
JSON representation |
---|
{ "flight": { object ( |
Fields | |
---|---|
flight |
Required. Matches the flight identifiers in the request. |
wtwEmissionsGramsPerPax |
Optional. Total flight emissions (sum of well-to-tank and tank-to-wake) per passenger based on the requested info. This is the total emissions and unless you have specific reasons for using TTW or WTT emissions, you should use this number. |
ttwEmissionsGramsPerPax |
Optional. Tank-to-wake flight emissions per passenger based on the requested info. |
wttEmissionsGramsPerPax |
Optional. Well-to-tank flight emissions per passenger based on the requested info. |
source |
Optional. The source of the emissions data. |
Scope3DataType
The type of matching used to compute Scope 3 emissions. This is used for the Scope 3 response, marking which of the methods was used to compute the emissions.
Enums | |
---|---|
SCOPE3_DATA_TYPE_UNSPECIFIED |
Unspecified data type. |
TIM_EMISSIONS |
TIM-based emissions given origin, destination, carrier, flight number, departure date, and year. |
TYPICAL_FLIGHT_EMISSIONS |
Typical flight emissions given origin, destination, and year. |
DISTANCE_BASED_EMISSIONS |
Distance-based emissions based on the distance traveled and year. |