Skip to main content
GET
/
ledgers
/
{ledger_id}
Retrieve a ledger
curl --request GET \
  --url https://app.gomangrove.com/api/v1/ledgers/{ledger_id} \
  --header 'Authorization: <api-key>'
import requests

url = "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}"

headers = {"Authorization": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.gomangrove.com/api/v1/ledgers/{ledger_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://app.gomangrove.com/api/v1/ledgers/{ledger_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: <api-key>"
  ],
]);

$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://app.gomangrove.com/api/v1/ledgers/{ledger_id}"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "lgr_abc123def456",
  "name": "Net Carbon Removal",
  "unit": "t",
  "system_ledger_type": null,
  "partition_type": "time",
  "cadence": "monthly",
  "latest_model": {
    "id": "mdl_abc123def456",
    "name": "Carbon Calculation Model"
  },
  "asset_category": null,
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-15T10:00:00.000Z"
}
{
  "status": "error",
  "statusCode": 404,
  "errors": [
    {
      "message": "record not found"
    }
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

ledger_id
string
required

Ledger friendly ID (e.g., lgr_abc123def456)

Response

200

id
string
Example:

"lgr_abc123def456"

name
string
unit
string | null
system_ledger_type
string | null
partition_type
string | null

Batch partition strategy: time, feedstock, tracking_id, or asset

cadence
string | null
latest_model
object | null
asset_category
object | null
created_at
string<date-time>
updated_at
string<date-time>