Reference documentation for API data structures
Data Schemas
Industry
| Property |
Type |
Required |
Description |
| id |
|
No |
|
| name |
|
No |
|
| mean_score |
|
No |
The mean score for this industry globally. Values from 0 to 1, 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/ |
| performances |
|
No |
|
OrganizationIdentifier
| Property |
Type |
Required |
Description |
| name | | Yes | |
| hq_region | | No | ISO two-letter country code of the organization's headquarters. |
| hq_subregion | | No | ISO two-letter code of the organization's headquarters subregion (for example, Ohio would be OH). |
| hq_fuzzy | object | No | 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 | | No | |
| industry_name | | No | |
| website | | No | The organization's website or email address. e.g. https://example.com or user@example.com |
| external_id | | No | |
| is_legal_entity_name | | No | Indicates whether the provided name is the supplier's legal entity name (vs. trading name/brand). |
| duns_number | | No | Data Universal Numbering System (DUNS) number for direct organization matching. |
| lei_number | | No | Legal Entity Identifier (LEI) for direct organization matching. |
| isin_number | | No | International Securities Identification Number (ISIN) for direct organization matching. |
| sp_global_number | | No | S&P Global identifier for direct organization matching. |
Organization
The fields returned depend on your project plan. The schema below describes the full (detailed) response. Summary plan responses return a subset: matching_organization omits names, websites, and tickers; industry_confidence is not included; and sbti and ecovadis objects are included.
| Property |
Type |
Required |
Description |
| id | | No | Unique DitchCarbon identifier for an organization |
| name | | No | Name of the organization |
| hq_region | | No | ISO 3166 two-letter country code for the country in which a business's registered headquarters are located. |
| hq_subregion | | No | ISO 3166-2 two-letter code of the organization's headquarters subregion (for example, Ohio would be OH). |
| industry | Industry | No | |
| website | | No | The organization's website or email address. e.g. https://example.com or user@example.com |
| external_id | | No | External id provided by a customer or a 3rd party provider such as DUNS or ISIN |
| status | | No | The status of the organization's data. 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. |
| organization_relationship_type | | No | The type of relationship this organization has (e.g., "ultimate parent", "subsidiary") |
| has_relevant_upstream | | No | Whether the organization has disclosed relevant upstream categories in any year |
| matching_organization | | No | |
| performances | | No | |
| sources | | No | An array of sources that DitchCarbon used to create the response. |
| score | | No | DitchCarbon assessed score from 0 to 1, 0 being the worst and 1 being the best. See calculation methodology at https://ditchcarbon.com/calculation-methodologies/ |
| industry_score_percentile | | No | DitchCarbon assessed percentile of the organization's industry score. A value of 80 means the organization is in the 80th percentile. |
| industry_confidence | | No | DitchCarbon confidence rating. Values can be: low, medium or high |
| industry_rank | | No | DitchCarbon assessed rank of the organization's industry's intensity. Values can be: very_high, high, medium, low, very_low, unknown |
| region_rank | | No | DitchCarbon assessed rank of the organization's region. Values can be: very_high, high, medium, low, very_low, unknown |
| related_environmental_report_status | | No | Whether or not the organization currently has any associated environmental reports. Values can be: processing, found, not_found |
| cdp | | No | |
| sbti | | No | |
| un | | No | |
| ecovadis | | No | |
| climate_pledge | | No | |
| document_reduction_targets | | No | Reduction targets automatically extracted from the organization's public documents. |
| sbti_reduction_targets | | No | Reduction targets declared to and validated by the Science Based Targets initiative (SBTi). |
Industry Performance
| Property |
Type |
Required |
Description |
| year |
|
No |
|
| region |
|
No |
|
| emission_factor |
|
No |
|
| ghg_emission_factors |
|
No |
All factors in kgCO2e/USD, transformed using GHG protocol data. https://ghgprotocol.org/... |
| source |
|
No |
|
Category
| Property |
Type |
Required |
Description |
| id |
|
No |
|
| name |
|
No |
|
Recommended Actions
| Property |
Type |
Required |
Description |
| recommended_actions |
|
No |
|
Reduction Target
| Property |
Type |
Required |
Description |
| id | | No | |
| classification | | No | |
| timeframe | | No | |
| scope | | No | |
| start_year | | No | |
| end_year | | No | |
| overall_reduction_percentage | | No | |
| text | | No | |
| source_url | | No | |
| permanent_mirror_url | | No | |
| page | | No | |
| on_track_two_year | | No | |
| on_track_five_year | | No | |
Emission
DitchCarbon's estimate of CO2e emitted.
| Property |
Type |
Required |
Description |
| kg_co2e |
|
No |
|
Server
| Property |
Type |
Required |
Description |
| id | | No | |
| manufacturer_name | | No | |
| model | | No | |
| ram_bytes | | No | In bytes |
| cpu_name | | No | |
| os_name | | No | |
| cpu_count | | No | Number of physical CPUs |
| core_count | | No | Number of physical cores per chip (CPU) |
| thread_count | | No | Number of logical threads across all chips (CPUs) |
| is_virtual | | No | Whether the server is dedicated (exclusively used by the entity) or virtual (shared between the entity and others, such as with Virtual Private Servers on cloud platforms) |
| disk_count | | No | |
.svg)
