curl --request GET \
--url https://app.variable.global/api/v1/energy/{uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.variable.global/api/v1/energy/{uuid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.variable.global/api/v1/energy/{uuid}', 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.variable.global/api/v1/energy/{uuid}",
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: Bearer <token>"
],
]);
$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.variable.global/api/v1/energy/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.variable.global/api/v1/energy/{uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.variable.global/api/v1/energy/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Grid electricity",
"description": "A descriptive description",
"notes": "Internal notes about this product",
"sku": "SKU123",
"syncId": "sync123",
"cpcCode": "CPC123",
"supplierPartId": "PART-123",
"unit": "kg",
"weight": {
"quantity": 100,
"unit": "kg"
},
"packagingWeight": {
"quantity": 10,
"unit": "kg"
},
"recycledPercent": 30,
"footprint": {
"CO2e": {
"A1": "1200.0",
"A2": "30.0",
"A3": "4.0",
"A4": "0.5",
"B1": "0.06",
"B2": "0.007",
"B3": "0.0008",
"B4": "",
"B5": "",
"C1": "",
"C2": "",
"C3": "",
"C4": "",
"D": "",
"totalCarbonFootprint": "1234.5678",
"productCarbonFootprint": "1234.0",
"upstream": "1230.0",
"direct": "4.0",
"downstream": "0.5678",
"A1_A3": "1234.0"
}
},
"dataQualityIndicators": {
"description": "Primary data from the 2022 production year; background datasets from ecoinvent 3.9.",
"documentationYear": 2019,
"coveragePercent": 80,
"specificPercent": 40,
"technologicalDQR": 1,
"temporalDQR": 1,
"geographicalDQR": 1,
"completenessDQR": 1,
"reliabilityDQR": 1,
"averagePercent": 60
},
"taxonomy": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Material",
"path": "material"
},
"geoLocation": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Pittsburgh, PA"
},
"location": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Pittsburgh Office"
},
"startDate": "2021-01-01T00:00:00.000Z",
"endDate": "2021-01-01T00:00:00.000Z",
"dataSource": "model",
"image": "https://app.variable.global/uploads/image.jpg",
"modeledWeight": {
"quantity": 100,
"unit": "kg"
},
"modeledPackagingWeight": {
"quantity": 12.5,
"unit": "kg"
},
"modeledTotalWeight": {
"quantity": 112.5,
"unit": "kg"
},
"modeledRecycledPercent": 27.5,
"impacts": {
"GWP-fossil": {
"unit": "kgCO2e",
"method": "Mixed",
"totalCarbonFootprint": "10",
"A1_A3": "10"
},
"ODP": {
"unit": "kgCFC11e",
"method": "EN15804+A2 - Core impact categories and indicators",
"A1_A3": "0.0000012"
},
"AP": {
"unit": "molH+e",
"method": "EN15804+A2 - Core impact categories and indicators",
"A1_A3": "2"
}
},
"dataset": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Name",
"source": "ecoinvent 3.8",
"declaredUnit": "kg"
},
"datasetAmount": {
"quantity": 1,
"unit": "kg"
},
"dataQualityRating": 1.4,
"versionState": "draft",
"created": "2021-01-01T00:00:00.000Z",
"updated": "2021-01-31T23:59:59.000Z",
"supplier": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"syncId": "sync123",
"name": "Company Name"
}
}{
"message": "token expired"
}Get Energy
Get an energy element by UUID
curl --request GET \
--url https://app.variable.global/api/v1/energy/{uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.variable.global/api/v1/energy/{uuid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.variable.global/api/v1/energy/{uuid}', 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.variable.global/api/v1/energy/{uuid}",
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: Bearer <token>"
],
]);
$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.variable.global/api/v1/energy/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.variable.global/api/v1/energy/{uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.variable.global/api/v1/energy/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Grid electricity",
"description": "A descriptive description",
"notes": "Internal notes about this product",
"sku": "SKU123",
"syncId": "sync123",
"cpcCode": "CPC123",
"supplierPartId": "PART-123",
"unit": "kg",
"weight": {
"quantity": 100,
"unit": "kg"
},
"packagingWeight": {
"quantity": 10,
"unit": "kg"
},
"recycledPercent": 30,
"footprint": {
"CO2e": {
"A1": "1200.0",
"A2": "30.0",
"A3": "4.0",
"A4": "0.5",
"B1": "0.06",
"B2": "0.007",
"B3": "0.0008",
"B4": "",
"B5": "",
"C1": "",
"C2": "",
"C3": "",
"C4": "",
"D": "",
"totalCarbonFootprint": "1234.5678",
"productCarbonFootprint": "1234.0",
"upstream": "1230.0",
"direct": "4.0",
"downstream": "0.5678",
"A1_A3": "1234.0"
}
},
"dataQualityIndicators": {
"description": "Primary data from the 2022 production year; background datasets from ecoinvent 3.9.",
"documentationYear": 2019,
"coveragePercent": 80,
"specificPercent": 40,
"technologicalDQR": 1,
"temporalDQR": 1,
"geographicalDQR": 1,
"completenessDQR": 1,
"reliabilityDQR": 1,
"averagePercent": 60
},
"taxonomy": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Material",
"path": "material"
},
"geoLocation": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Pittsburgh, PA"
},
"location": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Pittsburgh Office"
},
"startDate": "2021-01-01T00:00:00.000Z",
"endDate": "2021-01-01T00:00:00.000Z",
"dataSource": "model",
"image": "https://app.variable.global/uploads/image.jpg",
"modeledWeight": {
"quantity": 100,
"unit": "kg"
},
"modeledPackagingWeight": {
"quantity": 12.5,
"unit": "kg"
},
"modeledTotalWeight": {
"quantity": 112.5,
"unit": "kg"
},
"modeledRecycledPercent": 27.5,
"impacts": {
"GWP-fossil": {
"unit": "kgCO2e",
"method": "Mixed",
"totalCarbonFootprint": "10",
"A1_A3": "10"
},
"ODP": {
"unit": "kgCFC11e",
"method": "EN15804+A2 - Core impact categories and indicators",
"A1_A3": "0.0000012"
},
"AP": {
"unit": "molH+e",
"method": "EN15804+A2 - Core impact categories and indicators",
"A1_A3": "2"
}
},
"dataset": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Name",
"source": "ecoinvent 3.8",
"declaredUnit": "kg"
},
"datasetAmount": {
"quantity": 1,
"unit": "kg"
},
"dataQualityRating": 1.4,
"versionState": "draft",
"created": "2021-01-01T00:00:00.000Z",
"updated": "2021-01-31T23:59:59.000Z",
"supplier": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"syncId": "sync123",
"name": "Company Name"
}
}{
"message": "token expired"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Which environmental impact indicators to include in the impacts field. Absent or empty returns only GWP-fossil. Pass all for every indicator, or a comma-separated list of canonical codes to filter (case-insensitive). all is only honored on its own — combining it with other codes (e.g. all,gwp-fossil) is treated as an unknown code. An unknown code returns 400. See the Impacts concept and the full indicator catalog.
"gwp-fossil,odp,ap"
Response
An energy element
"Grid electricity"
"A descriptive description"
"Internal notes about this product"
"SKU123"
"CPC123"
The supplier's part identifier for this product.
"PART-123"
The unit code (e.g. kg, lbs, etc.). All unit codes can be found in the List Units endpoint.
"kg"
The user-declared weight of the product. On read responses, compare with the server-computed modeledWeight to mass-balance the product against its bill of materials.
Show child attributes
Show child attributes
The user-declared weight of the product's packaging. On read responses, compare with the server-computed modeledPackagingWeight to mass-balance packaging against its bill of materials.
Show child attributes
Show child attributes
The user-declared recycled content of the product as a percentage (0–100). A 0 is a declared zero; omit the field when undeclared. On read responses, compare with the server-computed modeledRecycledPercent.
30
Deprecated — use impacts["GWP-fossil"]. Kept for backwards compatibility.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
A reference to a taxonomy category, including its machine-readable path.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ISO 8601 date
"2021-01-01T00:00:00.000Z"
ISO 8601 date
"2021-01-01T00:00:00.000Z"
model, external "model"
"https://app.variable.global/uploads/image.jpg"
Read-only. Server-computed sum of the model's A1–A3 product material
input weights (Material group "Product"; excludes packaging and
ancillary), in the same Amount shape as the declared weight. Compare
the two to mass-balance the product: weight is the value you set, while
modeledWeight is derived from the bill of materials. Present only when
the model has qualifying product inputs. Ignored on POST/PATCH.
Show child attributes
Show child attributes
Read-only. Server-computed sum of the model's A1–A3 packaging input
weights (Material group "Packaging"), in the same Amount shape as the
declared packagingWeight. Compare the two to mass-balance packaging:
packagingWeight is the value you set, while modeledPackagingWeight is
derived from the bill of materials. Present only when the model has
qualifying packaging inputs. Ignored on POST/PATCH.
Show child attributes
Show child attributes
Read-only. Gross modeled weight: the sum of modeledWeight and
modeledPackagingWeight, in the same Amount shape. Derived at read
time from the two persisted addends — a missing addend contributes
nothing — so it's present whenever at least one of the two is present;
its unit follows the first present addend. Ignored on POST/PATCH.
Show child attributes
Show child attributes
Read-only. Server-computed weight-weighted average of the contributing
inputs' recycled content (0–100). Compare against the declared
recycledPercent: recycledPercent is the value you set, while
modeledRecycledPercent is derived from the bill of materials. Present only
when the model has contributing inputs. Ignored on POST/PATCH.
27.5
Environmental impact indicators keyed by canonical code (e.g. GWP-fossil, ODP, AP). Which indicators appear is controlled by the impacts query parameter — by default only GWP-fossil is returned.
Show child attributes
Show child attributes
{
"GWP-fossil": {
"unit": "kgCO2e",
"method": "Mixed",
"totalCarbonFootprint": "10",
"A1_A3": "10"
},
"ODP": {
"unit": "kgCFC11e",
"method": "EN15804+A2 - Core impact categories and indicators",
"A1_A3": "0.0000012"
},
"AP": {
"unit": "molH+e",
"method": "EN15804+A2 - Core impact categories and indicators",
"A1_A3": "2"
}
}
The emission-factor dataset a sourced element (/v1/material, /v1/energy, /v1/process) draws its impact from. Send { uuid } to bind one at create time, or a different dataset on update to re-point the element; binding a dataset makes the element external (dataSource: external). Use /v1/database to find one. On read it carries the full reference (uuid, name, source, declaredUnit) and is present for external elements only — absent for modeled products.
Show child attributes
Show child attributes
The quantity and unit of the backing dataset this element consumes — the amount its per-unit factor scales. Optional when binding: omit to consume one declared unit of the dataset; send alone on update to re-scale an existing binding without changing the dataset. On read, present for external elements only — absent for modeled products.
Show child attributes
Show child attributes
1.4
Read-only. Where the record sits in its version workflow. draft is the editable
working copy; every other state is immutable. locked is finalized but not reviewed,
in_review has been picked up by a verifier, rejected was refused with a reason,
and verified is signed off. Ignored on POST/PATCH.
draft, locked, in_review, rejected, verified "draft"
ISO 8601 date
"2021-01-01T00:00:00.000Z"
ISO 8601 date
"2021-01-31T23:59:59.000Z"
Show child attributes
Show child attributes