CarbonSutra Carbon Emissions API
string · email · requiredstring · password · minLength: 1 · requiredstring · required
string · email · requiredstring · password · minLength: 1 · required
Emission Clusters
Register API keys and retrieve emissions grouped under custom cluster names.
Register for a CarbonSutra API key
POST
${API_URL}
/api/v1/register_key
Registers an organization and creates a CarbonSutra API key. The returned key is a secret credential and should be stored securely.
query Parameters
emailEmail address used for registration.
passwordPassphrase used to create the token.
companyOrganization name.
Register for a CarbonSutra API key › Responses
API key registration result.
API-key registration or retrieval response.
object
CarbonSutra_API_KEYSecret CarbonSutra API key. Store securely.
successstatusRetrieve an existing API key
POST
${API_URL}
/api/v1/retrieve_key
Retrieves an existing CarbonSutra API key for a registered email address when the correct passphrase is supplied.
query Parameters
emailRegistered email address.
passwordPassphrase used when the key was created.
Retrieve an existing API key › Responses
Existing API key.
API-key registration or retrieval response.
object
CarbonSutra_API_KEYSecret CarbonSutra API key. Store securely.
successstatusRetrieve emission cluster data
GET
${API_URL}
/api/v1/cluster_data