Score Sets

List available batches for scoring

Returns batches available for carbon intensity scoring: batches in the source ledgers of the given model(s), ordered by start time, optionally narrowed to a date range. Use this to discover which batches can be passed to the create score set endpoint. With no model, the list is empty. Requires carbon intensity to be enabled for your account (feature_carbon_intensity in GET /feature_flags); otherwise returns 403 “Carbon intensity feature is not enabled”. Requires the read:ledger token scope.

GET

ledgers

{ledger_id}

score_sets

available_batches

List available batches for scoring

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

import requests

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

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

	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/available_batches")

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": "ba_aBcD1234eFgH5678",
      "tracking_id": "Q1-2025-001",
      "start_time": "2025-01-01T00:00:00.000Z",
      "end_time": "2025-03-31T23:59:59.000Z",
      "ledger_id": "led_aBcD1234eFgH5678",
      "ledger_name": "Feedstock Ledger",
      "ledger_type": "actual",
      "quantity": 1500,
      "unit": "t",
      "data_points": [
        {
          "name": "Mass of Feedstock",
          "data_point_type_id": 5,
          "value": 1500,
          "unit": "t"
        }
      ]
    }
  ],
  "info": {
    "items": 1,
    "page_size": 50,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [],
    "filter": []
  }
}

Authorizations

Authorization

string

header

required

Path Parameters

ledger_id

string

required

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

Query Parameters

model_ids[]

string[]

One or more score-producing model friendly IDs to filter by. Repeat the parameter for multiple values (e.g. model_ids[]=mod_aBcD1234eFgH5678&model_ids[]=mod_xYzW7890aBcD1234). A single model_id parameter is also accepted. Unknown IDs are ignored.

start_date

string<date>

Only batches whose window overlaps the range — here, batches that end after the start of this date (in the account's time zone). Must be YYYY-MM-DD.

Example:

"2025-01-01"

end_date

string<date>

Only batches whose window overlaps the range — here, batches that start before the end of this date (in the account's time zone). Must be YYYY-MM-DD.

Example:

"2025-03-31"

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:50

Values below 1 are clamped to 1 and values above 200 to 200. A non-numeric value falls back to the default.

Required range: 1 <= x <= 200

Response

A page of batches available for scoring.

data

object[]

Show child attributes

info

object

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

Show child attributes

List available batches for scoring

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

import requests

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

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

	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/available_batches")

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": "ba_aBcD1234eFgH5678",
      "tracking_id": "Q1-2025-001",
      "start_time": "2025-01-01T00:00:00.000Z",
      "end_time": "2025-03-31T23:59:59.000Z",
      "ledger_id": "led_aBcD1234eFgH5678",
      "ledger_name": "Feedstock Ledger",
      "ledger_type": "actual",
      "quantity": 1500,
      "unit": "t",
      "data_points": [
        {
          "name": "Mass of Feedstock",
          "data_point_type_id": 5,
          "value": 1500,
          "unit": "t"
        }
      ]
    }
  ],
  "info": {
    "items": 1,
    "page_size": 50,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [],
    "filter": []
  }
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

List available batches for scoring

Authorizations

Path Parameters

Query Parameters

Response