List products
List the products available to your account, filtered by category, class or impact type.
Returns the products you can buy, 25 per page by default.
Request
GET /v2/products
localestringLanguage of the product descriptions: de, en, es, fr, hi, it, ja, pt, pt-BR or zh-CN.
pageintegerPage number, starting at 1.
itemsintegerProducts per page, from 1 to 25. Defaults to 25.
categorystringReturn only products with this category code.
classstringReturn only products with this project class code.
impact_typestringReturn only products with this impact type code.
GET /v2/products in the API referencecurl "https://api.sandbox.squake.earth/v2/products?locale=en&items=10" \
--header "Authorization: Bearer $SQUAKE_API_KEY"The filters match the code of a category, class or impact type, as returned in a product's categories, classes and impact_types. List the products without filters first to see the codes available to your account.
Response
The body is a JSON array of products. 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" } ]
}
]For the meaning of each field, see Products.
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing or invalid. |
Related
- Retrieve a product
- Quote a price
- Retrieve Products in the API reference