Skip to content
Carbon API/emission_calculations

Coolset Carbon API (1.0)

Read-only access to emissions calculations, charts, and carbon footprint data.

Download OpenAPI description
carbon-api.json
carbon-api.yaml
Overview
URL
https://coolset.com
E-mail
support@coolset.com
Languages
Servers
Mock server
https://api.coolset.com/_mock/carbon-api/
Production server
https://developers-scranton.coolset.com/api/

emission_calculations

Operations

Emission Calculations Charts List

Request

Security
Bearer
Query
journalstring

journal

journal__icontainsstring

journal__icontains

journal__istartswithstring

journal__istartswith

journal__iendswithstring

journal__iendswith

journal__isnullstring

journal__isnull

titlestring

title

title__icontainsstring

title__icontains

title__istartswithstring

title__istartswith

title__iendswithstring

title__iendswith

descriptionstring

description

description__icontainsstring

description__icontains

description__istartswithstring

description__istartswith

description__iendswithstring

description__iendswith

description__isnullstring

description__isnull

vendor_namestring

vendor_name

vendor_name__icontainsstring

vendor_name__icontains

vendor_name__istartswithstring

vendor_name__istartswith

vendor_name__iendswithstring

vendor_name__iendswith

vendor_name__isnullstring

vendor_name__isnull

accounting_datestring

accounting_date

accounting_date__gtestring

accounting_date__gte

accounting_date__ltestring

accounting_date__lte

is_activity_based_emissionstring

is_activity_based_emission

classification_category_idstring

classification_category_id

classification_category_namestring

classification_category_name

classification_category_name__icontainsstring

classification_category_name__icontains

classification_category_name__istartswithstring

classification_category_name__istartswith

classification_category_name__iendswithstring

classification_category_name__iendswith

sub_category_idstring

sub_category_id

category_idstring

category_id

ghg_category_idstring

ghg_category_id

is_tag_alongstring

is_tag_along

confidence_statusstring

confidence_status

Enum"confident""needs_attention"
co2_kgstring

co2_kg

co2_kg__gtstring

co2_kg__gt

co2_kg__ltstring

co2_kg__lt

co2_kg__gtestring

co2_kg__gte

co2_kg__ltestring

co2_kg__lte

scopestring

scope

Enum"1""2""3""Offset""Excluded"
company_tagsstring

company_tags

flags_key_valuestring

flags_key_value

relative_tostring

relative_to

Enum"absolute""per_employee""per_revenue_unit"
group_byArray of strings

Fields to group by

Default ["date"]
Items Enum"date""main_emission""category_name""sub_category_name""ghg_category_name""scope""title""vendor_name"
delimit_bystring

delimit_by

Enum"yearly""monthly""daily"
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Fields to order by (prefix with '-' for descending)

Enum"date""-date""transaction_count""-transaction_count""total_co2_kg""-total_co2_kg"
curl -i -X GET \
  'https://api.coolset.com/_mock/carbon-api/emission_calculations/charts?journal=string&journal__icontains=string&journal__istartswith=string&journal__iendswith=string&journal__isnull=string&title=string&title__icontains=string&title__istartswith=string&title__iendswith=string&description=string&description__icontains=string&description__istartswith=string&description__iendswith=string&description__isnull=string&vendor_name=string&vendor_name__icontains=string&vendor_name__istartswith=string&vendor_name__iendswith=string&vendor_name__isnull=string&accounting_date=string&accounting_date__gte=string&accounting_date__lte=string&is_activity_based_emission=string&classification_category_id=string&classification_category_name=string&classification_category_name__icontains=string&classification_category_name__istartswith=string&classification_category_name__iendswith=string&sub_category_id=string&category_id=string&ghg_category_id=string&is_tag_along=string&confidence_status=confident&co2_kg=string&co2_kg__gt=string&co2_kg__lt=string&co2_kg__gte=string&co2_kg__lte=string&scope=1&company_tags=string&flags_key_value=string&relative_to=absolute&group_by=date&delimit_by=yearly&limit=0&offset=0&ordering=date' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
nextstring or null(uri)
previousstring or null(uri)
resultsArray of objects(EmissionChart)required
results[].​transaction_countinteger(Transaction count)required
results[].​total_co2_kgnumber(Total co2 kg)required
results[].​datestring(date-time)(Date)
results[].​main_emissioninteger(Main emission)
results[].​categoryinteger(Category)
results[].​category_namestring(Category name)non-empty
results[].​sub_categoryinteger(Sub category)
results[].​sub_category_namestring(Sub category name)non-empty
results[].​ghg_categoryinteger(Ghg category)
results[].​ghg_category_namestring(Ghg category name)non-empty
results[].​scopestring(Scope)non-empty
results[].​titlestring(Title)non-empty
results[].​vendor_namestring(Vendor name)non-empty
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

Emission Calculations Emissions List

Request

Security
Bearer
Query
journalstring

journal

journal__icontainsstring

journal__icontains

journal__istartswithstring

journal__istartswith

journal__iendswithstring

journal__iendswith

journal__isnullstring

journal__isnull

titlestring

title

title__icontainsstring

title__icontains

title__istartswithstring

title__istartswith

title__iendswithstring

title__iendswith

descriptionstring

description

description__icontainsstring

description__icontains

description__istartswithstring

description__istartswith

description__iendswithstring

description__iendswith

description__isnullstring

description__isnull

vendor_namestring

vendor_name

vendor_name__icontainsstring

vendor_name__icontains

vendor_name__istartswithstring

vendor_name__istartswith

vendor_name__iendswithstring

vendor_name__iendswith

vendor_name__isnullstring

vendor_name__isnull

accounting_datestring

accounting_date

accounting_date__gtestring

accounting_date__gte

accounting_date__ltestring

accounting_date__lte

is_activity_based_emissionstring

is_activity_based_emission

classification_category_idstring

classification_category_id

classification_category_namestring

classification_category_name

classification_category_name__icontainsstring

classification_category_name__icontains

classification_category_name__istartswithstring

classification_category_name__istartswith

classification_category_name__iendswithstring

classification_category_name__iendswith

sub_category_idstring

sub_category_id

category_idstring

category_id

ghg_category_idstring

ghg_category_id

is_tag_alongstring

is_tag_along

confidence_statusstring

confidence_status

Enum"confident""needs_attention"
co2_kgstring

co2_kg

co2_kg__gtstring

co2_kg__gt

co2_kg__ltstring

co2_kg__lt

co2_kg__gtestring

co2_kg__gte

co2_kg__ltestring

co2_kg__lte

scopestring

scope

Enum"1""2""3""Offset""Excluded"
company_tagsstring

company_tags

flags_key_valuestring

flags_key_value

searchstring

A search term.

orderingstring

Which field to use when ordering the results.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

curl -i -X GET \
  'https://api.coolset.com/_mock/carbon-api/emission_calculations/emissions?journal=string&journal__icontains=string&journal__istartswith=string&journal__iendswith=string&journal__isnull=string&title=string&title__icontains=string&title__istartswith=string&title__iendswith=string&description=string&description__icontains=string&description__istartswith=string&description__iendswith=string&description__isnull=string&vendor_name=string&vendor_name__icontains=string&vendor_name__istartswith=string&vendor_name__iendswith=string&vendor_name__isnull=string&accounting_date=string&accounting_date__gte=string&accounting_date__lte=string&is_activity_based_emission=string&classification_category_id=string&classification_category_name=string&classification_category_name__icontains=string&classification_category_name__istartswith=string&classification_category_name__iendswith=string&sub_category_id=string&category_id=string&ghg_category_id=string&is_tag_along=string&confidence_status=confident&co2_kg=string&co2_kg__gt=string&co2_kg__lt=string&co2_kg__gte=string&co2_kg__lte=string&scope=1&company_tags=string&flags_key_value=string&search=string&ordering=string&limit=0&offset=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
nextstring or null(uri)
previousstring or null(uri)
resultsArray of objects(Emission)required
results[].​idinteger(ID)read-only
results[].​companyinteger(Company)read-only
results[].​company_namestring(Company name)non-emptyread-only
results[].​company_tagsArray of integersuniqueread-only
results[].​emission_group_idstring(uuid)(Emission group id)read-only
results[].​transactioninteger or null(Transaction)read-only
results[].​total_volumenumber or null(Total volume)read-only
results[].​volumenumber or null(Volume)read-only
results[].​volume_unitstring or null(Volume unit)non-emptyread-only
results[].​journalstring or null(Journal)non-emptyread-only
results[].​titlestring or null(Title)non-emptyread-only
results[].​descriptionstring or null(Description)non-emptyread-only
results[].​vendor_namestring or null(Vendor name)non-emptyread-only
results[].​accounting_datestring or null(date-time)(Accounting date)read-only
results[].​accounting_end_datestring or null(date-time)(Accounting end date)read-only
results[].​transaction_is_visibleboolean or null(Transaction is visible)read-only
results[].​transaction_dataobject or null(Transaction data)read-only
results[].​transaction_idstring(Transaction id)read-only
results[].​is_activity_based_emissionboolean(Is activity based emission)read-only
results[].​activity_dataobject or null(Activity data)read-only
results[].​emission_factorinteger or null(Emission factor)read-only
results[].​emission_unitinteger or null(Emission unit)read-only
results[].​emission_unit_namestring or null(Emission unit name)non-emptyread-only
results[].​emission_factor_dataobject or null(Emission factor data)read-only
results[].​classification_categoryinteger or null(Classification category)read-only
results[].​classification_category_namestring or null(Classification category name)non-emptyread-only
results[].​sub_categoryinteger or null(Sub category)read-only
results[].​sub_category_namestring or null(Sub category name)non-emptyread-only
results[].​categoryinteger or null(Category)read-only
results[].​category_namestring or null(Category name)non-emptyread-only
results[].​ghg_categoryinteger or null(Ghg category)read-only
results[].​ghg_category_namestring or null(Ghg category name)non-emptyread-only
results[].​scopestring(Scope)read-only
Enum"1""2""3""Offset""Excluded"
results[].​is_tag_alongboolean(Is tag along)read-only
results[].​main_emissioninteger or null(Main emission)read-only
results[].​created_byinteger or null(Created by)read-only
results[].​classification_sourcestring(Classification source)read-only
Enum"auto""script""manual"
results[].​confidencenumber or null(Confidence)read-only
results[].​confidence_thresholdnumber or null(Confidence threshold)read-only
results[].​confidence_statusstring or null(Confidence status)read-only
Enum"confident""needs_attention"
results[].​co2_kgnumber or null(Co2 kg)read-only
results[].​flagsobject or null(Flags)read-only
results[].​deleted_atstring or null(date-time)(Deleted at)read-only
results[].​created_atstring(date-time)(Created at)read-only
results[].​updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

Emission Calculations Emissions Export List

Request

Override list method to return CSV export instead of JSON.

Security
Bearer
Query
journalstring

journal

journal__icontainsstring

journal__icontains

journal__istartswithstring

journal__istartswith

journal__iendswithstring

journal__iendswith

journal__isnullstring

journal__isnull

titlestring

title

title__icontainsstring

title__icontains

title__istartswithstring

title__istartswith

title__iendswithstring

title__iendswith

descriptionstring

description

description__icontainsstring

description__icontains

description__istartswithstring

description__istartswith

description__iendswithstring

description__iendswith

description__isnullstring

description__isnull

vendor_namestring

vendor_name

vendor_name__icontainsstring

vendor_name__icontains

vendor_name__istartswithstring

vendor_name__istartswith

vendor_name__iendswithstring

vendor_name__iendswith

vendor_name__isnullstring

vendor_name__isnull

accounting_datestring

accounting_date

accounting_date__gtestring

accounting_date__gte

accounting_date__ltestring

accounting_date__lte

is_activity_based_emissionstring

is_activity_based_emission

classification_category_idstring

classification_category_id

classification_category_namestring

classification_category_name

classification_category_name__icontainsstring

classification_category_name__icontains

classification_category_name__istartswithstring

classification_category_name__istartswith

classification_category_name__iendswithstring

classification_category_name__iendswith

sub_category_idstring

sub_category_id

category_idstring

category_id

ghg_category_idstring

ghg_category_id

is_tag_alongstring

is_tag_along

confidence_statusstring

confidence_status

Enum"confident""needs_attention"
co2_kgstring

co2_kg

co2_kg__gtstring

co2_kg__gt

co2_kg__ltstring

co2_kg__lt

co2_kg__gtestring

co2_kg__gte

co2_kg__ltestring

co2_kg__lte

scopestring

scope

Enum"1""2""3""Offset""Excluded"
company_tagsstring

company_tags

flags_key_valuestring

flags_key_value

searchstring

A search term.

orderingstring

Which field to use when ordering the results.

curl -i -X GET \
  'https://api.coolset.com/_mock/carbon-api/emission_calculations/emissions/export?journal=string&journal__icontains=string&journal__istartswith=string&journal__iendswith=string&journal__isnull=string&title=string&title__icontains=string&title__istartswith=string&title__iendswith=string&description=string&description__icontains=string&description__istartswith=string&description__iendswith=string&description__isnull=string&vendor_name=string&vendor_name__icontains=string&vendor_name__istartswith=string&vendor_name__iendswith=string&vendor_name__isnull=string&accounting_date=string&accounting_date__gte=string&accounting_date__lte=string&is_activity_based_emission=string&classification_category_id=string&classification_category_name=string&classification_category_name__icontains=string&classification_category_name__istartswith=string&classification_category_name__iendswith=string&sub_category_id=string&category_id=string&ghg_category_id=string&is_tag_along=string&confidence_status=confident&co2_kg=string&co2_kg__gt=string&co2_kg__lt=string&co2_kg__gte=string&co2_kg__lte=string&scope=1&company_tags=string&flags_key_value=string&search=string&ordering=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
accounting_datestring or null(date-time)(Accounting date)
journalstring or null(Journal)<= 255 characters
titlestring or null(Title)<= 255 characters
vendor_namestring or null(Vendor name)<= 255 characters
descriptionstring or null(Description)<= 1024 characters
company_tags_namesstring(Company tags names)non-empty
volumenumber or null(Volume)
volume_unitstring or null(Volume unit)<= 255 characters
co2_kgnumber or null(Co2 kg)
scopestring(Scope)
Enum"1""2""3""Offset""Excluded"
ghg_category_namestring or null(Ghg category name)<= 255 characters
category_namestring or null(Category name)<= 255 characters
ef_titlestring(Ef title)non-empty
ef_descriptionstring(Ef description)non-empty
ef_multiplierstring(Ef multiplier)non-empty
emission_unit_namestring or null(Emission unit name)<= 255 characters
ef_sourcestring(Ef source)non-empty
ef_yearstring(Ef year)non-empty
is_activity_based_emissionboolean(Is activity based emission)
is_tag_alongboolean(Is tag along)
transactioninteger or null(Transaction)
]
Response
application/json
[
  {
    "accounting_date": "2019-08-24T14:15:22Z",
    "journal": "string",
    "title": "string",
    "vendor_name": "string",
    "description": "string",
    "company_tags_names": "string",
    "volume": 0,
    "volume_unit": "string",
    "co2_kg": 0,
    "scope": "1",
    "ghg_category_name": "string",
    "category_name": "string",
    "ef_title": "string",
    "ef_description": "string",
    "ef_multiplier": "string",
    "emission_unit_name": "string",
    "ef_source": "string",
    "ef_year": "string",
    "is_activity_based_emission": true,
    "is_tag_along": true,
    "transaction": 0
  }
]