Skip to main content

Get a transaction emission estimate by idempotency key

Path Parameters
idempotency_keystringrequired

The order's idempotency key.

Idempotency keys must be unique per account.

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

quoterequired
emission_factorrequired

This property is null for any estimate created before 01/03/2024

search_term_matchstringrequired

The most accurate term matching the search.

The emission factor for this term is used to compute the emission estimate.

search_term_match_scorenumberfloatrequired

Populated if semantic search was used to find a match to the provided search term or category Indicates confidence in the match from 0 - 2, 0 being most confident.

diet_factorrequired
exchange_raterequired
exchange_rate_daterequired
requestobjectrequired

Parameters for estimating emissions associated with purchasing goods or services.

external_estimate_urlrequired

An external accessible URL linking to a detailed page that provides complete information about the estimate.

is_transactionrequired
transaction_processed_atrequired
  • GET /estimates/transactions/by-idempotency-key/{idempotency_key}
    • curl 'https://api.lune.co/v1/estimates/transactions/by-idempotency-key/sg5knd2' \
  -H 'Authorization: Bearer <API_KEY>'
  • Response
    • {
  "id": "04QD7GPaBx5b6Y6mJlZyONXLvrZljRE2",
  "mass": {
    "amount": "0.01388",
    "unit": "t"
  },
  "quote": {
    "estimated_quantity": "0.01388",
    "estimated_commission": "0.04",
    "estimated_total_cost": "0.38",
    "estimated_offset_cost": "0.34",
    "requested_value": null,
    "requested_quantity": "0.01388",
    "currency": "USD",
    "bundles": [
      {
        "bundle_id": "q9aKx7b6nNXMk3Yv3pD1mlW5Od2eLZE8",
        "bundle_name": "Conserving forests in Asia",
        "quantity": "0.013186",
        "unit_price": "12.8",
        "gross_unit_price": "14.22",
        "offset_cost": "0.17",
        "insufficient_available_quantity": null
      },
      {
        "bundle_id": "xWaKJL3okjD46VpJ4yGXnQNZRe1vzP0w",
        "bundle_name": "Ocean Carbon Removal",
        "quantity": "14.22",
        "unit_price": "250",
        "gross_unit_price": "277.78",
        "offset_cost": "0.17",
        "insufficient_available_quantity": null
      }
    ]
  },
  "request": {
    "value": {
      "value": "8.99",
      "currency": "USD"
    },
    "merchant": {
      "category_code": "5818",
      "name": "Netflix",
      "country_code": "USA"
    }
  },
  "diet_factor": null,
  "exchange_rate": "0.2667",
  "exchange_rate_date": "2024-01-01"
}