Data Schemas

Reference documentation for API data structures

Data Schemas

Industry

PropertyTypeRequiredDescription
id❌
name❌
mean_score❌
performances❌

OrganizationIdentifier

PropertyTypeRequiredDescription
name✅
hq_region❌ISO two-letter country code of the organization's headquarters.
hq_subregion❌ISO two-letter code of the organization's headquarters subregion (for example, Ohio would be OH).
hq_fuzzyobject❌If you don't know the ISO two-letter country code of the organization's headquarters, you can provide a fuzzy input.
e.g. "United States" or an address like "1600 Amphitheatre Parkway, Mountain View, CA"
industry_id❌
industry_name❌
website❌The organization's website or email address. e.g. https://example.com or user@example.com
external_id❌

Organization

PropertyTypeRequiredDescription
id❌Unique DitchCarbon identifier for an organization
name❌Name of the organization
hq_region❌ISO 3166 two-letter country code for the country in which a business's registered headquarters are located.
hq_subregion❌ISO 3166-2 two-letter code of the organization's headquarters subregion (for example, Ohio would be OH).
industryIndustry❌
website❌The organization's website or email address. e.g. https://example.com or user@example.com
external_id❌External id provided by a customer or a 3rd party provider such as DUNS or ISIN
status❌The status of the organization's data. This is how we recommend you communicate the status to your users: All statuses except synced and errored mean the research is still in progress. synced means the research is complete. errored means there was an error during the research.
matching_organization❌
performances❌
sources❌An array of sources that DitchCarbon used to create the response.
score❌DitchCarbon assessed score from 0 to 1 that indicates how well a given organization is performing, 0 being the worst and 1 being the best. Users typically represent this as a score between 0 and 100. See calculation methodology at https://ditchcarbon.com/calculation-methodologies/
industry_score_percentile❌DitchCarbon assessed percentile of the organization's industry score in comparison to all other organizations in the same industry. A value of 80 means the organization is in the 80th percentile.
industry_confidence❌DitchCarbon confidence rating. If we've had to make assumptions about the organization's industry, this field will indicate how confident we are in our assumptions. Values can be: low, medium or high
industry_rank❌DitchCarbon assessed rank of the organization's industry in comparison to all other industries. Values can be: very_high, high, medium, low, very_low, unknown
region_rank❌DitchCarbon assessed rank of the organization's region in comparison to all other regions. Values can be: very_high, high, medium, low, very_low, unknown
related_environmental_report_status❌Status of the organization's environmental report. Values can be: processing, found, not_found
cdp❌
sbti❌
un❌
climate_pledge❌

OrganizationPerformance

An organization's performance in a given year. This includes the organization's emissions, revenue, and emission factors. We use this dataset https://simplemaps.com/data/world-cities to help with normalizing regional data.

PropertyTypeRequiredDescription
year❌The year that the organization's GHG emissions data refers to.
region❌ISO 3166 two-letter country code of the organization's headquarters
emission_factor❌Organization's total reported scope 1 + 2 + 3 GHG emissions divided by the organization's revenue. Measured in kgCo2e/USD (please note if a new base currency is entered via API this data point will be amended accordingly).
total_upstream_emission_factor❌Organization's reported total scope 1 and 2 GHG emissions + scope 3 categories 1-8 (i.e., upstream scope 3) divided by organization's revenue. This field is only calculated if the reporting company has disclosed all relevant upstream scope 3 categories for their industry, based on meta-analysis of emissions reports.
scope_1_and_2_emission_factor❌Organization's reported total scope 1 and 2 GHG emissions divided by organization's revenue
revenue_currency❌ISO three-letter currency code for the organization's revenue
revenue❌The total amount of money brought in by an organization's operations (gross income before subtracting any expenses), measured over a financial year.
emissions❌
production_emission_factors❌
documents❌

IndustryPerformance

PropertyTypeRequiredDescription
year❌
region❌
emission_factor❌
ghg_emission_factors❌All factors in kgCO2e/USD, transformed using GHG protocol data https://ghgprotocol.org/sites/default/files/ghgp/Global-Warming-Potential-Values%20%28Feb%2016%202016%29_1.pdf
source❌

Category

PropertyTypeRequiredDescription
id❌
name❌

RecommendedActions

PropertyTypeRequiredDescription
recommended_actions❌

Emission

DitchCarbon's estimate of CO2e emitted.

PropertyTypeRequiredDescription
kg_co2e❌

Server

PropertyTypeRequiredDescription
id❌
manufacturer_name❌
model❌
ram_bytes❌In bytes
cpu_name❌
os_name❌
cpu_count❌Number of physical CPUs
core_count❌Number of physical cores per chip (CPU)
thread_count❌Number of logical threads across all chips (CPUs)
is_virtual❌Whether the server is dedicated (the server is exclusively used by the entity on behalf of which the carbon emissions are being calculated) or virtual (the server is shared between the entity and others, such as with Virtual Private Servers on cloud platforms)
disk_count❌