💾Installation

Get setup with our developer toolkits.

Receiving an Access Code: Our API is currently in Beta. To gain Beta access, please Book a Demo to learn more about our API and receive your Access Code! Your Access Code will be required before you can generate your API Key.

Get your API Keys

The Carbonlink API uses API Keys to authenticate requests. You can generate, view and manage your API Keys from within the Carbonlink Dashboard.

Your API Keys carry many privileges and should be kept secure at all times! Under no circumstances do we recommend you share your secret API Keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Depending on your framework, you may use your API Key in the initial configuration of the Carbonlink SDK within your application code or in a cURL request header. Each request to the API that is configured with a valid API Key will be authenticated and sent through.

It's worth noting that all API requests must be made over HTTPS. API requests made over an unsecure HTTP channel or without a valid API Key will fail.

Development & Testing: ⚒️ We are working on a solution to provide API Keys for a testing environment for you to use while your application is still in development.

Install the SDK

SDK Unavailable: While we work on bringing you the most accessible and safe-to-use Software Development Kit for your specific runtime, please continue using HTTPS requests with your command line tool or web API of choice.

The best way to interact with our API is to use our official library and SDK. Open a command terminal and type the following expression according to your programming language of choice:

Node

// Install via NPM (Not available)
// npm install --save carbonlink

Python

# Install via pip (Not available)
# pip install carbonlink

If you received an error on this step, please be sure to install the latest version of NPM or your preferred language's default package manager. Otherwise, contact [e-mail] and we will be happy to answer any questions you may have.

Make your first request

Now that you have your API Key, you can send an authenticated request to the estimate endpoint to generate an Estimate.

🚞pageEstimate

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl https://api.carbonlink.io/v1/estimates  
    -u {YOUR_API_KEY}:  
    -d kgCO2e=123.23    
    -d customerRef='CUSTOMER-EMAIL'

Node

// require the myapi module and set it up with your API key
const carbonlink = require('carbonlink')(YOUR_API_KEY);

const estimateObject = await carbonlink.estimate.create({
    kgCO2e: 123.12,
    customerRef: 'id_1AneEH19c42',
})

console.log('My first estimate!', estimateObject.estimateId);

Python

from carbonlink import Carbonlink

// Set your API key before making the request
carbonlink = Carbonlink('YOUR_API_KEY')

estimate_object = carbonlink.estimate.create(
    kgCO2e: 123.12,
    customerRef: 'id_1AneEH19c42',
)

print(f'My first estimate! {estimate_object.estimateId}')