Skip to main content

Available Tools

ToolEndpointDescription
get_categoriesGET /api/v1/categoriesGHG Protocol categories
get_emission_factorsGET /api/v1/emission-factors/customCustom emission factors
get_recommended_inputsGET /api/v1/inputs/recommendedRecommended inputs by country
get_suppliersGET /api/v1/suppliersSuppliers and clients
get_waste_operatorsGET /api/v1/waste-operatorsWaste operators
get_usersGET /api/v1/usersOrganization users

Usage Examples

"What GHG categories are available in Scope 3?"
→ get_categories({ level: "subcategory" })

"What are my company's custom emission factors?"
→ get_emission_factors({ companyId: "uuid" })

"What electricity inputs do you recommend for the US?"
→ get_recommended_inputs({ country: "US", type: "electricity" })

"List my company's suppliers"
→ get_suppliers({ companyId: "uuid" })

"Who are the users in my organization?"
→ get_users({ companyId: "uuid" })

GHG Category Levels

LevelDescription
scopeScope 1, 2, 3
categoryMain categories (e.g. Stationary combustion)
subcategoryDetailed subcategories (e.g. Natural gas, Gasoline E5)
Use get_categories?level=subcategory to get the categoryId needed when creating consumption records.