Get a carbon credit quote for ground freight emissions
curl --request POST \
--url https://carbon-engine.onrender.com/v1/quotes/ground-freight \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"freight_mass_kg": 123,
"distance_km": 123,
"portfolio_id": "<string>"
}
'import requests
url = "https://carbon-engine.onrender.com/v1/quotes/ground-freight"
payload = {
"freight_mass_kg": 123,
"distance_km": 123,
"portfolio_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({freight_mass_kg: 123, distance_km: 123, portfolio_id: '<string>'})
};
fetch('https://carbon-engine.onrender.com/v1/quotes/ground-freight', 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://carbon-engine.onrender.com/v1/quotes/ground-freight",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'freight_mass_kg' => 123,
'distance_km' => 123,
'portfolio_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://carbon-engine.onrender.com/v1/quotes/ground-freight"
payload := strings.NewReader("{\n \"freight_mass_kg\": 123,\n \"distance_km\": 123,\n \"portfolio_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://carbon-engine.onrender.com/v1/quotes/ground-freight")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"freight_mass_kg\": 123,\n \"distance_km\": 123,\n \"portfolio_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://carbon-engine.onrender.com/v1/quotes/ground-freight")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"freight_mass_kg\": 123,\n \"distance_km\": 123,\n \"portfolio_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"amount_kg": 123,
"price_sar_halalas": 123
}{
"error": 123,
"message": "<string>"
}Quotes
Get Quote for Ground Freight Emissions
Get a price quote for offsetting ground freight shipment carbon emissions. Will return the amount of CO2e to offset and total price.
POST
/
v1
/
quotes
/
ground-freight
Get a carbon credit quote for ground freight emissions
curl --request POST \
--url https://carbon-engine.onrender.com/v1/quotes/ground-freight \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"freight_mass_kg": 123,
"distance_km": 123,
"portfolio_id": "<string>"
}
'import requests
url = "https://carbon-engine.onrender.com/v1/quotes/ground-freight"
payload = {
"freight_mass_kg": 123,
"distance_km": 123,
"portfolio_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({freight_mass_kg: 123, distance_km: 123, portfolio_id: '<string>'})
};
fetch('https://carbon-engine.onrender.com/v1/quotes/ground-freight', 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://carbon-engine.onrender.com/v1/quotes/ground-freight",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'freight_mass_kg' => 123,
'distance_km' => 123,
'portfolio_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://carbon-engine.onrender.com/v1/quotes/ground-freight"
payload := strings.NewReader("{\n \"freight_mass_kg\": 123,\n \"distance_km\": 123,\n \"portfolio_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://carbon-engine.onrender.com/v1/quotes/ground-freight")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"freight_mass_kg\": 123,\n \"distance_km\": 123,\n \"portfolio_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://carbon-engine.onrender.com/v1/quotes/ground-freight")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"freight_mass_kg\": 123,\n \"distance_km\": 123,\n \"portfolio_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"amount_kg": 123,
"price_sar_halalas": 123
}{
"error": 123,
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Mass of freight, in kg
Distance of ground freight shipment, in km
Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.
⌘I