Ledgers
Retrieve a ledger
Returns a specific ledger by ID.
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": "led_abc123def456",
"name": "Net Carbon Removal",
"unit": "t",
"system_ledger_type": null,
"partition_type": "time",
"cadence": "monthly",
"active_model": {
"id": "mod_abc123def456",
"name": "Carbon Calculation Model"
},
"asset_category": null,
"created_at": "2025-01-15T10:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z",
"ui_url": "https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/ledger/led_abc123def456"
}{
"errors": [
{
"message": "record not found"
}
]
}Authorizations
Path Parameters
Ledger friendly ID (e.g., led_abc123def456)
Response
200
Example:
"led_abc123def456"
Batch partition strategy: time, feedstock, tracking_id, asset, tracking_id_and_feedstock, or tracking_id_and_asset. The two composite strategies partition by both dimensions at once.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Link that opens this ledger in the Mangrove app.
⌘I
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": "led_abc123def456",
"name": "Net Carbon Removal",
"unit": "t",
"system_ledger_type": null,
"partition_type": "time",
"cadence": "monthly",
"active_model": {
"id": "mod_abc123def456",
"name": "Carbon Calculation Model"
},
"asset_category": null,
"created_at": "2025-01-15T10:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z",
"ui_url": "https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/ledger/led_abc123def456"
}{
"errors": [
{
"message": "record not found"
}
]
}