Retrieve a score set

GET

ledgers

{ledger_id}

score_sets

{id}

Retrieve a score set

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

import requests

url = "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/score_sets/{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}/score_sets/{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}/score_sets/{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}/score_sets/{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))

}

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/score_sets/{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": "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,
  "has_workbook": true,
  "ui_url": "https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/ledger/led_aBcD1234eFgH5678/score-set/scr_aBcD1234eFgH5678",
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-15T10:05:00.000Z"
}

Authorizations

Authorization

string

header

required

Path Parameters

ledger_id

string

required

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

string

required

The score set's friendly ID (e.g. scr_aBcD1234eFgH5678).

Example:

"scr_aBcD1234eFgH5678"

Response

The score set.

string

Example:

"scr_aBcD1234eFgH5678"

reporting_period_id

string | null

Example:

"cirp_aBcD1234eFgH5678"

model_id

string | null

Example:

"mod_aBcD1234eFgH5678"

ledger_id

string | null

Example:

"led_aBcD1234eFgH5678"

status

enum<string>

Available options:

initialized,

running,

completed,

failed

score

string | null

The score as a decimal string (e.g. "12.345"; a whole number renders as "12.0"). Null until the calculation completes.

score_name

string | null

score_unit

string | null

reporting_period_label

string | null

The reporting period's label with its dates. Null for an ad-hoc score set; use window_label, which is always populated.

window_label

string

Human-readable label for the scored window, whether it came from a reporting period or an ad-hoc start/end range.

start_date

string<date> | null

end_date

string<date> | null

model_label

string | null

error_message

string | null

Failure cause when status is failed — the model run's per-node error summary when it recorded any, otherwise the calculation task's message. Null otherwise.

created_at

string<date-time>

updated_at

string<date-time>

has_workbook

boolean

Whether the score set's run produced a downloadable Excel workbook or openLCA pathway file.

ui_url

string<uri>

Link that opens this score set in the Mangrove app, built from the project, ledger and score set friendly IDs.

Example:

"https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/ledger/led_aBcD1234eFgH5678/score-set/scr_aBcD1234eFgH5678"

Retrieve a score set

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

import requests

url = "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/score_sets/{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}/score_sets/{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}/score_sets/{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}/score_sets/{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))

}

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/score_sets/{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": "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,
  "has_workbook": true,
  "ui_url": "https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/ledger/led_aBcD1234eFgH5678/score-set/scr_aBcD1234eFgH5678",
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-15T10:05:00.000Z"
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Authorizations

Path Parameters

Response