---
title: "Project vintages"
method: GET
path: "/carbonCredits/projects/{id}"
tags: ["CarbonCredits"]
---

# Project vintages

`GET /carbonCredits/projects/{id}`

## Request

- Base URL: `https://api.carbonregistry.com`
- URL: `https://api.carbonregistry.com/carbonCredits/projects/{id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/docs/carbonCredits/projects/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a summary of the current state of credits for the given project

## Path parameters

- `id` string, required

## Response `200`

- ProjectCreditDataResponseDto
  - `summary` ProjectCreditDataSummary, required
    - `exPost` number, required: The current total number of exPost / verified and issued credits - total number of historically issued credits is exPost + retired + exPostCancelled
    - `exPostCancelled` number, required: The total number of exPost credits that have been cancelled
    - `exAnte` number, required: The total number of exAnte / future credits
    - `exAnteCancelled` number, required: The total number exAnte credits that have been cancelled
    - `retired` number, required: The total number of exPost / verified credits that have been retired
    - `validated` number, required: The total number of credits validated (not issued) - this is the number from the validation report
  - `vintages` ProjectCreditVintageData[], required: The credit data per vintage
    - `events` CreditVintageEventData[], required: The events, only issuances for now, associated with this vintage of credits.
      - `id` string, required: The event id
      - `vintage` string, required: The vintage
      - `createdAt` string, date-time, required: Creation date of the event
      - `amount` number, required: Amount associated with the event
      - `type` 'issuance', required: Type of the credit event
      - `creditType` 'carbon' | 'water' | 'energy', required: Type of credit (e.g., carbon, water, energy)
      - `monitoringPeriodStart` string, date-time: Monitoring period start date
      - `monitoringPeriodEnd` string, date-time: Monitoring period end date
      - `files` CreditVintageEventFile[], required: List of files associated with the event
        - `fileName` string, required: Name of the file
        - `id` string, required: Unique identifier for the file
        - `size` number: Size of the file in bytes
        - `url` string, required: URL to access the file
        - `type` 'proofOfConcept' | 'proofOfOwnership' | 'projectDescription' | 'validationReport' | 'monitoringReport' | 'verificationReport' | 'otherNote' | 'noIssuanceStatement' | 'hostCountryApprovalDocument' | 'kmlFile' | 'representationDeed' | 'projectDesignDescriptionAndMonitoringReport' | 'vvbAgreement' | 'validationAndVerificationReport' | 'methodologyConcept' | 'nonPerformanceReport' | 'reversalEventReport': Type of the file
      - `verificationBody` VerificationBodyData
        - `id` string, required: Unique identifier for the verification body
        - `directoryUrl` string, required: URL of the directory for verification documents
        - `fullName` string, required: Name of the verification body
    - `vintage` string, required: The year of this vintage
    - `summary` ProjectCreditDataSummary, required
      - `exPost` number, required: The current total number of exPost / verified and issued credits - total number of historically issued credits is exPost + retired + exPostCancelled
      - `exPostCancelled` number, required: The total number of exPost credits that have been cancelled
      - `exAnte` number, required: The total number of exAnte / future credits
      - `exAnteCancelled` number, required: The total number exAnte credits that have been cancelled
      - `retired` number, required: The total number of exPost / verified credits that have been retired
      - `validated` number, required: The total number of credits validated (not issued) - this is the number from the validation report
  - `project` ApiProject, required
    - `id` string, required: The ID of the project
    - `fullName` string, required: The full name of the project
    - `url` string, required: The URL of the project
    - `publicUrl` string, required: The public URL of the project
    - `num` number, required: Project number. This is a unique identifier for the project

---

[API](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api.md) - [All operations](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/revisions/a9f1b102faca?raw)