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

Asset

Wraps around a Pool or Project object to provide additional data on a carbon asset.

See the individual Pool and Project pages for details on their respective data fields and data types.

The Asset object

id string

Unique identifier for the object

type 'POOL' | 'PROJECT'

Type of carbon asset

price float

Price of 1 tCO2e for this asset, in USD

source string

Organization managing this carbon asset

data object

An object of data from the Project or Pool associated with this asset.

fallback string optional

Identifier for a fallback object populated when this object is invalid, inactive or missing. Otherwise set to null.

active boolean

Whether this asset has a sufficient supply of credits for offsetting.

// Example:
{
  id: "asset_12345678",
  type: "PROJECT",
  price: 5.23,
  supply: 123456.12,
  data: {
    id: "proj_123...",
    name: "The Kasigau Corridor REDD+ Project",
    vintages: {...},
    region: "Mombasa",
    country: "Kenya",
    latitude: 12.23,
    longitude: -1.23,
    description: "The Kasigau Corridor REDD+ Project is focused on land conservation and preservation of the local ecosystems in Kenya."
    imageUrl: "https://.../kasigau-1",
    url: "https://www.carbonlink.io/projects/612",
    registryId: "VCS-612",
    registry: "Verra",
    sdgs: "1,2,3,4,5",
  },
  fallback: null,
  active: true,
}
PreviousProductNextProject

Last updated 1 year ago

πŸ“¦