Carbonlink API
  • 🌿Welcome to Carbonlink
  • 🌟How Carbonlink Works
  • πŸ’ΎInstallation
  • ⁉️Handling Errors & Limits
    • Response Codes
    • Rate Limiting
  • GUIDES
    • Use Cases
      • E-Commerce
      • Carbon Accounting
      • Carbon Solution Providers
  • CORE
    • πŸ“–API reference
      • πŸ‘œProduct
      • 🧩Factor
      • πŸ—ΊοΈAsset
      • 🌍Offset
      • 🚞Estimate
    • πŸ“¦Data objects
      • Factor
      • Product
      • Asset
        • Project
          • Vintage
        • Pool
      • Estimate
      • Offset
  • Resources
    • Defining Emissions
      • The Scope System
      • CO2 Equivalents
    • Carbon Markets 101
      • What is A Carbon Credit?
      • Environmental Impact of Offsetting
      • How Are Credits Generated & Verified?
    • Methodologies
      • Carbon Credit Methodologies
      • Estimate Methodology
Powered by GitBook
On this page
  1. CORE
  2. Data objects

Estimate

Contains data related to the emission estimation of one or more goods and services.

The Estimate object

id string

Unique identifier for the object

kgCO2e float

Total weight of emissions

price float

Total price of offsetting this amount of kgCO2e using carbon assets from the default_asset asset, in USD

default_asset string

breakdown object

Breakdown of GHG emissions by various constituent gases, in kilograms.

products object

shipping_details object optional

Optional object containing details about the shipping these Product(s).

customerRef string optional

Customer reference ID

createdAt string

Time of Estimate creation

// Example:
{
  id: "est_12345678",
  kgCO2e: 123.45,
  price: 230.91,
  default_asset: "asset_123456...",
  breakdown: {
    "co2": 0.12,
    "ch4": 0.48,
    "sf6": 0.40
  },
  products: {
    "prod_123...": {
        id: "prod_123...",
        ...
    },
    "prod_456...": {
        id: "prod_456...",
        ...
    }
  },
  shipping_details: {
    distance: {
      unit: "mile",
      value: 12.12
    },
    route: "land",
    weight: {
      unit: "kg",
      value: 100
    },
  },
  customerRef: "jane@company.com",
  createdAt: "2011-10-05T14:48:00.000Z",
}
PreviousPoolNextOffset

Last updated 1 year ago

Identifier for the object used to estimate the price of a future offset.

Object containing one or more objects

πŸ“¦
Asset
Product