Documentation

Post Ghg Statement

curl --request POST \
  --url https://api.sandbox.isometric.com/mrv/v0/ghg_statements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "end_on": "2023-12-25",
  "project_id": "prj_1CTWZQGKE1S0VAXA"
}
'

import requests

url = "https://api.sandbox.isometric.com/mrv/v0/ghg_statements"

payload = {
    "end_on": "2023-12-25",
    "project_id": "prj_1CTWZQGKE1S0VAXA"
}
headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-secret': '<x-client-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({end_on: '2023-12-25', project_id: 'prj_1CTWZQGKE1S0VAXA'})
};

fetch('https://api.sandbox.isometric.com/mrv/v0/ghg_statements', 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/mrv/v0/ghg_statements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'end_on' => '2023-12-25',
    'project_id' => 'prj_1CTWZQGKE1S0VAXA'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/mrv/v0/ghg_statements"

	payload := strings.NewReader("{\n  \"end_on\": \"2023-12-25\",\n  \"project_id\": \"prj_1CTWZQGKE1S0VAXA\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.isometric.com/mrv/v0/ghg_statements")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"end_on\": \"2023-12-25\",\n  \"project_id\": \"prj_1CTWZQGKE1S0VAXA\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/mrv/v0/ghg_statements")

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

request = Net::HTTP::Post.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"end_on\": \"2023-12-25\",\n  \"project_id\": \"prj_1CTWZQGKE1S0VAXA\"\n}"

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

{
  "credit_allocation": {
    "buffer_pool_contribution_kg": 123,
    "supplier_allocation_kg": 123
  },
  "credits_issued_at": "2023-11-07T05:31:56Z",
  "ghg_entry_ids": [
    "rmv_1EEM6NJXX1S0EXKD"
  ],
  "ghg_statement_report_url": "<string>",
  "id": "ggs_1GDQJ99Z51S0DYW9",
  "pending_total_co2e_removed_kg": 123,
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "removal_ids": [
    "rmv_1EEM6NJXX1S0EXKD"
  ],
  "reporting_period_end_at": "2023-12-25",
  "reporting_period_start_at": "2023-12-25",
  "status": "DRAFT",
  "submitted_at": "2023-11-07T05:31:56Z",
  "verifier": "<string>"
}

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

POST

ghg_statements

Post Ghg Statement

curl --request POST \
  --url https://api.sandbox.isometric.com/mrv/v0/ghg_statements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "end_on": "2023-12-25",
  "project_id": "prj_1CTWZQGKE1S0VAXA"
}
'

import requests

url = "https://api.sandbox.isometric.com/mrv/v0/ghg_statements"

payload = {
    "end_on": "2023-12-25",
    "project_id": "prj_1CTWZQGKE1S0VAXA"
}
headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-secret': '<x-client-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({end_on: '2023-12-25', project_id: 'prj_1CTWZQGKE1S0VAXA'})
};

fetch('https://api.sandbox.isometric.com/mrv/v0/ghg_statements', 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/mrv/v0/ghg_statements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'end_on' => '2023-12-25',
    'project_id' => 'prj_1CTWZQGKE1S0VAXA'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/mrv/v0/ghg_statements"

	payload := strings.NewReader("{\n  \"end_on\": \"2023-12-25\",\n  \"project_id\": \"prj_1CTWZQGKE1S0VAXA\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.isometric.com/mrv/v0/ghg_statements")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"end_on\": \"2023-12-25\",\n  \"project_id\": \"prj_1CTWZQGKE1S0VAXA\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/mrv/v0/ghg_statements")

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

request = Net::HTTP::Post.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"end_on\": \"2023-12-25\",\n  \"project_id\": \"prj_1CTWZQGKE1S0VAXA\"\n}"

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

{
  "credit_allocation": {
    "buffer_pool_contribution_kg": 123,
    "supplier_allocation_kg": 123
  },
  "credits_issued_at": "2023-11-07T05:31:56Z",
  "ghg_entry_ids": [
    "rmv_1EEM6NJXX1S0EXKD"
  ],
  "ghg_statement_report_url": "<string>",
  "id": "ggs_1GDQJ99Z51S0DYW9",
  "pending_total_co2e_removed_kg": 123,
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "removal_ids": [
    "rmv_1EEM6NJXX1S0EXKD"
  ],
  "reporting_period_end_at": "2023-12-25",
  "reporting_period_start_at": "2023-12-25",
  "status": "DRAFT",
  "submitted_at": "2023-11-07T05:31:56Z",
  "verifier": "<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"

Body

application/json

end_on

string<date>

required

The inclusive end date of the GHG Statement

project_id

string

required

Required string length: 20 - 37

Examples:

"prj_1CTWZQGKE1S0VAXA"

"prj_1E0QTWB22SBX34D1"

Response

Successful Response

credit_allocation

CreditAllocation · object | null

required

The split of issuable credits between the supplier and buffer pool. None if any entry's risk_of_reversal_percentage is not set.

Show child attributes

credits_issued_at

string<date-time> | null

required

ghg_entry_ids

string[]

required

Required string length: 20 - 37

ghg_statement_report_url

string | null

required

string

required

Required string length: 20 - 37

Examples:

"ggs_1GDQJ99Z51S0DYW9"

"ggs_1FWVEQRWSSBXK3NB"

pending_total_co2e_removed_kg

number | null

required

If the GHG statement has pending changes, this is the net CO₂e removed by the entries in the GHG statement, including any changes that are pending. If the GHG statement has no pending changes, this is None.

project_id

string

required

Required string length: 20 - 37

Examples:

"prj_1CTWZQGKE1S0VAXA"

"prj_1E0QTWB22SBX34D1"

removal_ids

string[]

required

deprecated

Required string length: 20 - 37

reporting_period_end_at

string<date>

required

End date of the reporting period (inclusive)

reporting_period_start_at

string<date>

required

Start date of the reporting period (inclusive)

status

enum<string>

required

Available options:

DRAFT,

AWAITING_VERIFICATION,

VERIFIED,

CREDITS_ISSUED,

FAILED_VERIFICATION

submitted_at

string<date-time> | null

required

verifier

string | null

required

Name of the verifier of the GHG statement

Overview

Certify

Registry

Post Ghg Statement

Authorizations

Headers

Body

Response