Retrieve a product
Read one product by its ID, optionally in another language.
Returns one product with its projects' locations, certifications, files and prices.
Request
GET /v2/products/{id}
idstringrequiredThe product's ID, such as product_2rsg35sfsdf.
localestringLanguage of the description: de, en, es, fr, hi, it, ja, pt, pt-BR or zh-CN.
GET /v2/products/{id} in the API referencecurl "https://api.sandbox.squake.earth/v2/products/product_2rsg35sfsdf?locale=de" \
--header "Authorization: Bearer $SQUAKE_API_KEY"Response
The values in this example are illustrative.
{
"id": "product_2rsg35sfsdf",
"title": "Biochar carbon removal",
"description": "Turns agricultural residues into biochar, which stores carbon in soil for centuries.",
"locations": [ { "country": "DE", "region": "150", "sub_region": "155" } ],
"certifications": [ "Puro.earth" ],
"sdgs": [ 13, 15 ],
"files": [
{
"id": "file_asfg454s25",
"filename": "biochar-project.jpg",
"purpose": "project_image",
"size": 482113,
"type": "jpg",
"download_url": "https://squake.s3.eu-central-1.amazonaws.com/..."
}
],
"prices": [
{
"id": "price_1MMroL2eZvKYlo2CxbxAACvb",
"product": "product_2rsg35sfsdf",
"unit_amount": 15000,
"carbon_unit": "tonne",
"currency": "EUR"
}
],
"categories": [ { "code": "Biochar", "title": "Biochar" } ],
"impact_types": [ { "code": "Removal", "title": "Removal" } ],
"classes": [ { "code": "Technology-based", "title": "Technology-based" } ]
}unit_amount is the price per carbon_unit in the smallest unit of the currency, so this product costs 150.00 EUR per tonne. For the meaning of each field, see Products.
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing or invalid. |
404 | No product has this ID. |
Related
- List products
- Quote a price
- Retrieve a Product in the API reference