Documentation

Project

curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

import requests

url = "https://api.sandbox.isometric.com/registry/v0/projects/{id}"

headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-secret': '<x-client-secret>', Authorization: 'Bearer <token>'}
};

fetch('https://api.sandbox.isometric.com/registry/v0/projects/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.isometric.com/registry/v0/projects/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-client-secret: <x-client-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/registry/v0/projects/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.isometric.com/registry/v0/projects/{id}")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/registry/v0/projects/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "country_code": "GBR",
  "crediting_period_end": "2023-12-25",
  "crediting_period_start": "2023-12-25",
  "current_verifier_name": "<string>",
  "durability": "over_one_thousand_years",
  "id": "prj_1CTWZQGKE1S0VAXA",
  "issued_buffer_pool_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "issued_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "location": {
    "country_code": "GBR",
    "country_name": "<string>",
    "latitude": 51.5072,
    "longitude": -0.1276,
    "description": "<string>"
  },
  "name": "<string>",
  "pathway": "biomass_carbon_removal_and_storage",
  "protocol_data": {
    "baseline_version": "1.0",
    "current_version": "1.0",
    "name": "Biochar Production and Storage",
    "slug": "direct-air-capture"
  },
  "protocol_slug": "direct-air-capture",
  "retired_buffer_pool_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "retired_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "short_code": "F5X7",
  "status": "draft",
  "supplier": {
    "id": "spl_1CC712KFS1S0YKPS",
    "location": {
      "country_code": "GBR",
      "country_name": "<string>",
      "latitude": 51.5072,
      "longitude": -0.1276,
      "description": "<string>"
    },
    "long_description": "<string>",
    "organisation": {
      "domain": "isometric.com",
      "id": "org_1GB56M1ST1S0GVNA",
      "name": "Isometric"
    },
    "short_description": "<string>"
  },
  "url": "<string>",
  "validator_name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

GET

projects

{id}

Project

curl --request GET \
  --url https://api.sandbox.isometric.com/registry/v0/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

import requests

url = "https://api.sandbox.isometric.com/registry/v0/projects/{id}"

headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-secret': '<x-client-secret>', Authorization: 'Bearer <token>'}
};

fetch('https://api.sandbox.isometric.com/registry/v0/projects/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.isometric.com/registry/v0/projects/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-client-secret: <x-client-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/registry/v0/projects/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.isometric.com/registry/v0/projects/{id}")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/registry/v0/projects/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "country_code": "GBR",
  "crediting_period_end": "2023-12-25",
  "crediting_period_start": "2023-12-25",
  "current_verifier_name": "<string>",
  "durability": "over_one_thousand_years",
  "id": "prj_1CTWZQGKE1S0VAXA",
  "issued_buffer_pool_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "issued_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "location": {
    "country_code": "GBR",
    "country_name": "<string>",
    "latitude": 51.5072,
    "longitude": -0.1276,
    "description": "<string>"
  },
  "name": "<string>",
  "pathway": "biomass_carbon_removal_and_storage",
  "protocol_data": {
    "baseline_version": "1.0",
    "current_version": "1.0",
    "name": "Biochar Production and Storage",
    "slug": "direct-air-capture"
  },
  "protocol_slug": "direct-air-capture",
  "retired_buffer_pool_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "retired_credits_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "short_code": "F5X7",
  "status": "draft",
  "supplier": {
    "id": "spl_1CC712KFS1S0YKPS",
    "location": {
      "country_code": "GBR",
      "country_name": "<string>",
      "latitude": 51.5072,
      "longitude": -0.1276,
      "description": "<string>"
    },
    "long_description": "<string>",
    "organisation": {
      "domain": "isometric.com",
      "id": "org_1GB56M1ST1S0GVNA",
      "name": "Isometric"
    },
    "short_description": "<string>"
  },
  "url": "<string>",
  "validator_name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

Authorization

string

header

required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret

string

required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

string

required

Required string length: 20 - 37

Examples:

"prj_1CTWZQGKE1S0VAXA"

"prj_1E0QTWB22SBX34D1"

Response

Project · object | null

Successful Response

country_code

string

required

An ISO 3166-1 alpha-3 country code

Required string length: 3

Pattern: ^[A-Z]{3}$

Examples:

"GBR"

"USA"

crediting_period_end

string<date> | null

required

crediting_period_start

string<date> | null

required

current_verifier_name

string | null

required

The name of the organization currently responsible for verifying this project, if assigned

durability

enum<string>

required

The durability of the carbon removal performed by this project

Available options:

permanent,

over_one_thousand_years,

over_two_hundred_years,

over_one_hundred_years,

over_eighty_years,

over_sixty_years,

over_forty_years

Example:

"over_one_thousand_years"

string

required

Required string length: 20 - 37

Examples:

"prj_1CTWZQGKE1S0VAXA"

"prj_1E0QTWB22SBX34D1"

issued_buffer_pool_credits_total

CreditQuantity · object

required

The total number of credits from this project that have been allocated to the supplier's buffer pool

Show child attributes

issued_credits_total

CreditQuantity · object

required

The total number of credits Isometric has issued to this project, including those allocated to the buffer pool

Show child attributes

location

Location · object | null

required

Show child attributes

name

string

required

pathway

enum<string>

required

The pathway this project is following

Available options:

biomass_carbon_removal_and_storage,

biosphere,

direct_air_capture,

enhanced_weathering,

carbon_mineralization,

marine,

superpollutants,

environmental_attribute_certificates

Example:

"biomass_carbon_removal_and_storage"

protocol_data

ProjectProtocolData · object

required

Information about the protocol this project is following, including versions

Show child attributes

protocol_slug

string

required

deprecated

A protocol's URL-friendly identifier: lowercase alphanumeric groups separated by single hyphens

Required string length: 1 - 100

Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$

Examples:

"direct-air-capture"

"enhanced-weathering-agriculture"

retired_buffer_pool_credits_total

CreditQuantity · object

required

The total number of credits from this project that have been retired from the supplier's buffer pool

Show child attributes

retired_credits_total

CreditQuantity · object

required

The total number of credits from this project that have been retired, including those allocated to the buffer pool

Show child attributes

short_code

string

required

A random short code, uniquely identifying the project

Example:

"F5X7"

status

enum<string>

required

The project status

Available options:

draft,

preview,

under_validation,

validated,

validation_unsuccessful,

cancelled

supplier

Supplier · object

required

Show child attributes

url

string

required

The url to the Isometric page for this project

validator_name

string | null

required

The name of the organization responsible for validating this project, if assigned

Overview

Certify

Registry

Project

Authorizations

Headers

Path Parameters

Response