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
  • Search for a set of emission factors
  • Search for potential emission factors related to a Product
  1. CORE
  2. API reference

Factor

Find emission factors in the Carbonlink Emission Factor Database

[Public] - API Key is not required to call Factor endpoints.

Search for a set of emission factors

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

Query Parameters

Name
Type
Description

criteria

string

Set of fields and operations to parse into Search Query Language for filtering the Emission Factor Database

fullTextSearch

string

Raw set of words or phrases to search for in the Emission Factor Database.

[
    {
      id: "fct_12345678",
      rate: 12,
      unit: "usd",
      basis: "SPEND",
      name: "Mid-sized Freight Ship",
      code: "MID_FREIGHT",
      sector: "transport",
      category: "transport freight by ship",
      releaseYear: 2023,
      version: 0,
      source: 'EXIOBASE',
    },
    ...
]

Search for potential emission factors related to a Product

GET https://api.carbonlink.io/v1/factors/searchByProduct

Query Parameters

Name
Type
Description

name*

string

Name of Product to find related factors for

description*

string

Description of Product to find related factors for

[
    {
      id: "fct_12345678",
      rate: 12,
      unit: "usd",
      basis: "SPEND",
      name: "Mid-sized Freight Ship",
      code: "MID_FREIGHT",
      sector: "transport",
      category: "transport freight by ship",
      releaseYear: 2023,
      version: 0,
      source: 'EXIOBASE',
    },
    ...
]
PreviousProductNextAsset

Last updated 1 year ago

πŸ“–
🧩