Skip to main content

Create a passenger transportation emission estimate

Estimate emissions produced by passenger transportation, for instance commercial flight, rail, road.

Parameters
passengersnumber

Number of passengers the calculation should be applied to.

legsarray of oneOfrequired

An array representing all passenger travel legs.

bundle_selectionarray of object

Bundle selection percentages.

The sum of all percentages must equal 100.

If not specified, the preconfigured allocation ratios are going to be used.

If, for each selection, percentage is not provided, the selection is divided equally (best effort) between bundles. percentage must be provided for all or none of the bundles.

quantity_truncenum

Unit, t for tonne, kg for kilogram, g for gram

Enum:
  • g
  • kg
  • t
namestring

A name to reference this calculation.

metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

  1. Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
  2. Clients can use idempotency_key to reconcile estimates with entities on their system.
Returns
massobjectrequired
metadataobject

An arbitrary dictionary (key-value pairs) to store application-specific information.

Lune doesn't use this information for order processing. Its purpose is for the API clients to be able to attach arbitrary information (to an order for example) and then retrieve it.

idempotency_keystring

Account-unique identifier provided by the client.

idempotency_key has two purposes:

  1. Clients can safely retry estimate requests without accidentally performing the same operation multiple times.
  2. Clients can use idempotency_key to reconcile estimates with entities on their system.
idstringrequired

The emission calculation unique identifier

legsarray of objectrequired
quoterequired
requestobjectrequired

Parameters for estimating emissions for passenger transportation

  • POST /estimates/passenger-transportation
    • curl 'https://api.lune.co/v1/estimates/passenger-transportation' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -X POST \
  -d '{
    "legs": [
      {
        "route": {
          "amount": "40.501",
          "unit": "km"
        },
        "vehicle_type": "car_mini"
      }
    ]
  }'
  • Response
    • {
  "mass": {
    "amount": "40.501",
    "unit": "t"
  },
  "idempotency_key": "5bd808a954e",
  "id": "90ng23MKvLqbkpMwMw7yMBD4wJQrV6O6",
  "legs": [
    {
      "mass": {
        "amount": "40.501",
        "unit": "t"
      },
      "idempotency_key": "5bd808a954e"
    }
  ],
  "quote": {
    "errors": [
      {
        "error_code": "account_suspended",
        "message": "message"
      }
    ],
    "error": {
      "error_code": "account_suspended",
      "message": "message"
    }
  },
  "request": {
    "passengers": 1,
    "legs": [
      {
        "route": {
          "amount": "40.501",
          "unit": "km"
        },
        "vehicle_type": "car_mini"
      }
    ],
    "bundle_selection": [
      {
        "bundle_id": "BmWxrvXo29eGqzA1qjANL5PwnkgaO8R3",
        "percentage": 34
      },
      {
        "bundle_id": "VndoQ0PZjGMzvYOZGwqy6kbgN1eOJx9B",
        "percentage": 66
      }
    ],
    "quantity_trunc": "t",
    "name": "name",
    "idempotency_key": "5bd808a954e"
  }
}