# DitchCarbon Documentation

> Documentation for DitchCarbon

## Guides
- [Loom video walkthroughs](https://docs.ditchcarbon.com/docs/loom-walkthroughs.md): Sometimes it helps to "see one, do one, teach one"
- [Dynamic Link Generation](https://docs.ditchcarbon.com/docs/dynamic-links-generation.md): Organisations include a dynamic link giving you more emission details
- [Data Dictionary](https://docs.ditchcarbon.com/docs/data-dictionary.md)

## API Reference
- [Register a new organization.](https://docs.ditchcarbon.com/reference/post-organizations.md): Register a new organization with DitchCarbon. If you've already registered this organization, DitchCarbon will not register it again. Once registered, you can request updated information on the organization using `GET /organizations/{id}` This endpoint also returns the latest carbon data on the organization.
- [List organizations](https://docs.ditchcarbon.com/reference/get-organizations.md): List all organizations. This is useful for finding the `organization_id` parameter for the `/organizations/{id}` endpoint. Increment the `page` parameter to load more results. There are 5 results per page.
- [Retrieve data on an organization](https://docs.ditchcarbon.com/reference/get-organizations-id.md): Retrieve the latest data on an organization already registered using `POST /organizations`.
- [Retrieve data on an organization (with private performances)](https://docs.ditchcarbon.com/reference/get-organizations-id-private.md): This endpoint is identical to `GET /organizations/{id}` but pulls from the private client organization performances table instead of the public one. It returns the same data structure, but includes performance data from private documents that have been shared with your project.
- [Retrieve recommended actions for an organization](https://docs.ditchcarbon.com/reference/get-organizations-id-recommended_actions.md): Retrieve recommended actions for an organization already registered using `POST /organizations`.
- [List industries](https://docs.ditchcarbon.com/reference/get-industries.md): List all industries. This is useful for finding the `industry_id` parameter for the `/organizations` endpoint. Pagination follows RFC 5988, with the `Link` header containing the `next` and `last` links. Follow the `next` link to get the next page of results.
- [Search industries](https://docs.ditchcarbon.com/reference/get-industries-search.md): Search industries by name. This is useful for finding the `industry_id` parameter for the `/organizations` endpoint. Pagination follows RFC 5988, with the `Link` header containing the `next` and `last` links. Follow the `next` link to get the next page of results.
- [List and search through companies registered to SBTi](https://docs.ditchcarbon.com/reference/get-sbti-companies.md): This endpoint returns every company's response to SBTi, snapshotted once a week. Use the parameters to filter down the list.  Note the SBTi database has some inconsistencies. DitchCarbon has normalised the SBTi database to an extent, but there are still some problematic fields. As such, the parameters filters fields using a "contains" query. For example, providing `isin=GB` searches for all SBTi companies that have `GB` in their ISIN. Setting `near_term_target_classification=Well-below 2` returns all SBTi companies that have set their near term target to "Well-below 2°C" but also those that set their near term targets to "Well-below 2°C/2°C".  The response is paginated. Increment the `page` parameter to load more results.
- [List changes to the SBTi database](https://docs.ditchcarbon.com/reference/get-sbti-companies-changes.md): List changes made to companies in the SBTi database. This allows you to track how companies have changed their responses over time.  Note the SBTi database has some inconsistencies. DitchCarbon has normalised the SBTi database to an extent, but there are still some problematic fields. Please contact us if there's anything unexpected.
- [Batch request](https://docs.ditchcarbon.com/reference/post-batch.md): Send multiple requests to the Ditchcarbon API with one HTTP request.  Notes:   * All requests share the same headers.   * URLs are relative. Set `url` to `/organizations` rather than `https://api.ditcharbon.com/organizations`   * This /batch endpoint is for any endpoint not on /v1.0 - see deprecated /v1.0/batch for those endpoints.
- [Create a new project.](https://docs.ditchcarbon.com/reference/post-projects.md): Creates a new project scoped to the authenticated team. Use a **team API key** as the Bearer token (not a project API key). The response includes the new project's `api_key`, which you use to authenticate all subsequent project-scoped API calls (e.g. `POST /organizations`).

## Pages
- [Data Dictionary](https://docs.ditchcarbon.com/data-dictionary.md)