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
  • Create a new Estimate event.
  • Retrieve an existing Estimate event.
  • List all Estimate events.
  1. CORE
  2. API reference

Estimate

Track carbon emissions at the source.

API Key is required for all Estimate endpoints.

Create a new Estimate event.

POST https://api.carbonlink.io/v1/estimates

Request Body

Name
Type
Description

kgCO2e

number

Weight of carbon emissions to remove from circulation, in kilograms.

Note: If both kgCO2e and products parameters are provided, the total combined emissions will be added to this estimate.

products

object

This attribute computes the unit emission rate for this set of Products.

Key-value pairs where the key of each pair represents the ID of the Product to add to this estimate with a value corresponding to the quantity (# of units) of the Product to apply to this estimate.

Example:

{ "prod_123": 1, "prod_456": 3 }

Note: If both kgCO2e and products parameters are provided, the total combined emissions will be added to this estimate.

customerRef

string

Internal reference to customer. (i.e. email address or another user identifier)

{
    estimateId: "YOUR-ESTIMATE-ID"
}

Retrieve an existing Estimate event.

GET https://api.carbonlink.io/v1/estimates

Use query parameters to search for an Estimate event by the event ID.

Query Parameters

Name
Type
Description

id*

string

Event ID

{
  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
    },
  },
  active: true,
}

List all Estimate events.

GET https://api.carbonlink.io/v1/estimates

[
    {
      id: "est_12345678",
      kgCO2e: 123.45,
      price: 230.91,
      default_asset: "asset_123456...",
      breakdown: {...},
      products: {...},
      shipping_details: {...},
      active: true,
    }
    {...}
]
PreviousOffsetNextData objects

Last updated 1 year ago

πŸ“–
🚞