List score sets for a ledger

GET

ledgers

{ledger_id}

score_sets

curl --request GET \
  --url https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/score_sets \
  --header 'Authorization: <api-key>'

import requests

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

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}/score_sets', 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}/score_sets",
  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}/score_sets"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "id": "scr_aBcD1234eFgH5678",
      "reporting_period_id": "cirp_aBcD1234eFgH5678",
      "model_id": "mod_aBcD1234eFgH5678",
      "ledger_id": "led_aBcD1234eFgH5678",
      "status": "completed",
      "score": "12.345",
      "score_name": "Carbon Intensity",
      "score_unit": "kgCO2e/MJ",
      "reporting_period_label": "2025 Q1 (2025-01-01 - 2025-03-31)",
      "window_label": "2025 Q1 (2025-01-01 - 2025-03-31)",
      "start_date": "2025-01-01",
      "end_date": "2025-03-31",
      "model_label": "Carbon Intensity Model",
      "error_message": null,
      "created_at": "2025-01-15T10:00:00.000Z",
      "updated_at": "2025-01-15T10:05:00.000Z"
    }
  ],
  "info": {
    "items": 1,
    "page_size": 20,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [],
    "filter": [],
    "fields": null
  }
}

Authorizations

Authorization

string

header

required

Path Parameters

ledger_id

string

required

The ledger's friendly ID (e.g. led_aBcD1234eFgH5678).

Query Parameters

page

integer<int32>

default:1

The page to return, starting at 1. A value below 1 or a non-numeric value returns 400.

Required range: x >= 1

page_size

integer<int32>

default:20

Rows per page, from 1 to 200. A value below 1 counts as 1 and a value above 200 as 200; a non-numeric value uses the default.

Required range: 1 <= x <= 200

sort

string

Sortable fields: created_at, updated_at.

Example:

"-created_at"

response_mode

enum<string>

default returns a page of rows. summary returns the number of matching records and up to 10 sample rows. This endpoint doesn't support summary_with_export, which returns 400.

Available options:

default,

summary

Response

Paginated list. With response_mode=summary, a count and up to 10 samples instead.

Option 1
Option 2

data

object[]

required

Show child attributes

info

object

required

Where this page sits in the full result, and the sort, filters and fields the request applied.

Show child attributes

List score sets for a ledger

curl --request GET \
  --url https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/score_sets \
  --header 'Authorization: <api-key>'

import requests

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

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}/score_sets', 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}/score_sets",
  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}/score_sets"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "id": "scr_aBcD1234eFgH5678",
      "reporting_period_id": "cirp_aBcD1234eFgH5678",
      "model_id": "mod_aBcD1234eFgH5678",
      "ledger_id": "led_aBcD1234eFgH5678",
      "status": "completed",
      "score": "12.345",
      "score_name": "Carbon Intensity",
      "score_unit": "kgCO2e/MJ",
      "reporting_period_label": "2025 Q1 (2025-01-01 - 2025-03-31)",
      "window_label": "2025 Q1 (2025-01-01 - 2025-03-31)",
      "start_date": "2025-01-01",
      "end_date": "2025-03-31",
      "model_label": "Carbon Intensity Model",
      "error_message": null,
      "created_at": "2025-01-15T10:00:00.000Z",
      "updated_at": "2025-01-15T10:05:00.000Z"
    }
  ],
  "info": {
    "items": 1,
    "page_size": 20,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [],
    "filter": [],
    "fields": null
  }
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Authorizations

Path Parameters

Query Parameters

Response