Ledgers
Get required inputs for batch generation
Returns the required input data point types for batch generation on this ledger. Requires the ledger to have a model configured.
GET
/
ledgers
/
{ledger_id}
/
required_inputs
Get required inputs for a ledger
curl --request GET \
--url https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/required_inputs \
--header 'Authorization: <api-key>'import requests
url = "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/required_inputs"
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}/required_inputs', 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}/required_inputs",
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}/required_inputs"
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}/required_inputs")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/required_inputs")
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": 1,
"name": "Mass of Feedstock Delivery",
"slug": "feedstock-delivery-mass",
"unit": "U.S. ton",
"value_type": "number",
"category": "input",
"subcategory": null,
"is_manual_select": false,
"allocation_groups": [],
"output_of_ledgers": []
},
{
"id": 2,
"name": "Grid Emission Factor",
"slug": "grid-emission-factor",
"unit": "tCO2e/MWh",
"value_type": "number",
"category": "input",
"subcategory": null,
"is_manual_select": true,
"allocation_groups": [],
"output_of_ledgers": [
{
"id": "lgr_xyz789",
"name": "Emission Factors Ledger"
}
]
}
]
}{
"status": "error",
"statusCode": 422,
"errors": [
{
"message": "Ledger does not have a model configured"
}
]
}Previous
Preview batch generationPreviews what batches would be created for the given time range. Does not create any batches.
Next
⌘I
Get required inputs for a ledger
curl --request GET \
--url https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/required_inputs \
--header 'Authorization: <api-key>'import requests
url = "https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/required_inputs"
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}/required_inputs', 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}/required_inputs",
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}/required_inputs"
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}/required_inputs")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/required_inputs")
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": 1,
"name": "Mass of Feedstock Delivery",
"slug": "feedstock-delivery-mass",
"unit": "U.S. ton",
"value_type": "number",
"category": "input",
"subcategory": null,
"is_manual_select": false,
"allocation_groups": [],
"output_of_ledgers": []
},
{
"id": 2,
"name": "Grid Emission Factor",
"slug": "grid-emission-factor",
"unit": "tCO2e/MWh",
"value_type": "number",
"category": "input",
"subcategory": null,
"is_manual_select": true,
"allocation_groups": [],
"output_of_ledgers": [
{
"id": "lgr_xyz789",
"name": "Emission Factors Ledger"
}
]
}
]
}{
"status": "error",
"statusCode": 422,
"errors": [
{
"message": "Ledger does not have a model configured"
}
]
}