> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Consolidated Emissions

> Get a project's consolidated emissions: totals and breakdowns over the organizations the project covers

[← Projects API](https://code.dcycle.io/api-reference/projects/overview.md)

Get the consolidated emissions of a project, in kg CO2e (market-based, fossil). The project covers its owner and the owner's accepted subsidiaries that are selected in the project, over the project period. Every organization that can open the project (its owner, a group organization above it, a subsidiary, a linked organization) gets the same total.

The breakdown by organization lists only the organizations whose data your organization can read (itself and its subsidiaries); the rest of the project has no entry, and `organization_breakdown_complete` is false.

`GET /v1/projects/{project_id}/consolidated/export` returns the same figures as CSV.

## Request

### Headers

**x-api-key** `string` *required*

Your API key for authentication

**x-organization-id** `string` *required*

Your organization UUID

### Path Parameters

**project\_id** `string` *required*

UUID of the project

### Query Parameters

**scope** `integer[]`

GHG scopes to include (1, 2, 3). Repeat the parameter for several.

**category** `string[]`

Emission categories to include (for example `electricity`, `purchases`). An unknown category returns 400.

**organization\_id** `string[]`

Narrow to organizations of the project your organization can read. Any other organization returns 404.

**facility\_id** `string[]`

Narrow to facilities of those organizations. Any other facility returns 404.

**start\_date** `date`

Narrows the start of the project period (never widens it).

**end\_date** `date`

Narrows the end of the project period (never widens it).

**granularity** `string` (default: month)

Periods of `by_period`: `month` or `year`.

## Response

**total\_co2e\_kg** `number`

Total kg CO2e of the project

**by\_scope** `array`

`{scope, co2e_kg}` per scope

**by\_category** `array`

`{scope, category, co2e_kg}` per category

**by\_period** `array`

`{period, co2e_kg}`, with `period` as `YYYY-MM` or `YYYY`

**by\_organization** `array`

`{organization_id, organization_name, co2e_kg}` for each organization of the project you can read

**organization\_breakdown\_complete** `boolean`

False when part of the total comes from organizations you cannot read

**start\_date** `date`

First day of the consolidated period

**end\_date** `date`

Last day of the consolidated period

## Example

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl "https://api.dcycle.io/v1/projects/${PROJECT_ID}/consolidated?scope=1&scope=2&granularity=year" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.