🌍Offset

Use carbon credits from the Carbonlink Asset Library to negate carbon emissions.

API Key is required for all Offset endpoints.

Create a new Offset event.

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

Request Body

Name	Type	Description
kgCO2e*	number	Weight of carbon emissions to remove from circulation, in kilograms.
estimateId	string	ID of an existing Estimate object.
customerRef	string	Internal reference to customer. (i.e. email address or another user identifier)

200: OK Your offset is now being processing.

{
    message: 'Offset event with ID: {...} queued for processing.'
}

Retrieve an existing Offset event.

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

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

Query Parameters

Name	Type	Description
id*	string	Event ID

200: OK Offset event

{
  id: "off_12345678",
  credits: 12.30,
  credits_matched: 1.23,
  kgCO2e: 12300.45,
  cost: 18.97,
  estimate: {
    id: "est_123...",
    ...
  },
  asset: {
    id: "asset_123...",
    ...
  },
}

List all Offset events.

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

200: OK List of Offset events.

[
    {
      id: "off_12345678",
      credits: 12.30,
      credits_matched: 1.23,
      kgCO2e: 12300.45,
      cost: 18.97,
      estimate: {
        id: "est_123...",
        ...
      },
      asset: {
        id: "asset_123...",
        ...
      },
    },
    {...}
]