DitchCarbon

Retrieve the latest data on an organization already registered using POST /organizations.

Code Examples

API Key:

Language:

curl -X GET "https://api.ditchcarbon.com/organizations/{id}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  # Query parameters:
  # currency: ISO three-letter currency code to provide revenue and emission factor in.

API Explorer

Loading API Explorer...

Parameters

Name	In	Type	Required	Description
id	path	integer	✅	The ID of the organization.
currency	query	string	❌	ISO three-letter currency code to provide revenue and emission factor in.

Responses

200 Organization data

Content type: application/json

Schema: Organization

Response Fields

Field	Type	Description
id	number	Unique DitchCarbon identifier for an organization
name	string	Name of the organization
hq_region	string	ISO 3166 two-letter country code for the country in which a business's registered headquarters are located.
hq_subregion	string	ISO 3166-2 two-letter code of the organization's headquarters subregion (for example, Ohio would be OH).
industry	Industry
website	string	The organization's website or email address. e.g. https://example.com or user@example.com
external_id	string	External id provided by a customer or a 3rd party provider such as DUNS or ISIN
status	string	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	object
performances	array
sources	array	An array of sources that DitchCarbon used to create the response.
score	number	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	number	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	string	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	string	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	string	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	string	Status of the organization's environmental report. Values can be: processing, found, not_found
cdp	object
sbti	object
un	object
climate_pledge	object

Example Response

{
  "id": 123,
  "name": "string",
  "hq_region": "string",
  "hq_subregion": "string",
  "industry": {
    "id": "string",
    "name": "string",
    "mean_score": 123,
    "performances": [
      "..."
    ]
  },
  "website": "string",
  "external_id": "string",
  "status": "created",
  "matching_organization": {
    "id": 123,
    "link": "string",
    "name": "string",
    "names": [
      {
        "value": "..."
      }
    ],
    "websites": [
      {
        "value": "..."
      }
    ],
    "hq_region": "string",
    "hq_subregion": "string",
    "industry": {
      "id": 123,
      "name": "string"
    },
    "tickers": [
      {
        "exchange": "...",
        "symbol": "..."
      }
    ]
  },
  "performances": [
    {
      "year": "...",
      "region": "...",
      "emission_factor": "...",
      "total_upstream_emission_factor": "...",
      "scope_1_and_2_emission_factor": "...",
      "revenue_currency": "...",
      "revenue": "...",
      "emissions": "...",
      "production_emission_factors": "...",
      "documents": "..."
    }
  ],
  "sources": [
    {
      "url": "string",
      "mirror_url": "string"
    }
  ],
  "score": 123,
  "industry_score_percentile": 123,
  "industry_confidence": "low",
  "industry_rank": "very_high",
  "region_rank": "very_high",
  "related_environmental_report_status": "processing",
  "cdp": {
    "last_retrieved_at": "2025-04-10",
    "is_listed": true,
    "url": "string"
  },
  "sbti": {
    "last_retrieved_at": "2025-04-10",
    "data": [
      {
        "created_at": "...",
        "retrieved_at": "...",
        "near_term": "...",
        "long_term": "...",
        "net_zero": "...",
        "business_ambition_1_5": "...",
        "target_detail": "..."
      }
    ]
  },
  "un": {
    "last_retrieved_at": "2025-04-10",
    "url": "string",
    "initiatives": [
      {
        "name": "...",
        "slug": "..."
      }
    ]
  },
  "climate_pledge": {
    "signed": true,
    "signed_at": "2025-04-10",
    "link": "string"
  }
}

404 Organizations Not Found

Content type: application/json

Response Fields

Field	Type	Description
status	integer
title	string
detail	string
id	string

Example Response

{
  "status": 123,
  "title": "string",
  "detail": "string",
  "id": "string"
}

GET /organizations/{id}

Code Examples

API Explorer

Parameters

Responses

200 Organization data

Response Fields

Example Response

404 Organizations Not Found

Response Fields

Example Response