> ## Documentation Index > Fetch the complete documentation index at: https://docs.api.vcm.fyi/llms.txt > Use this file to discover all available pages before exploring further. # Get project details > Retrieve full details for a single carbon credit project by its ID. The `project_id` uses the registry prefix format (e.g., `VCS-1764`, `GLD-2345`, `ACR-123`, `CAR-456`, `ISO-789`, `PUR-012`). Returns all project metadata including registry, country, proponent, methodology, credit totals, status, and associated news clips. Also includes a computed `unretired` field (issued minus retired). ## OpenAPI ````yaml https://api.vcm.fyi/v1/openapi.json get /v1/projects/{project_id} openapi: 3.1.0 info: title: VCM.fyi API version: 1.0.0 description: > # VCM.fyi API Programmatic access to carbon market intelligence — covering 11,000+ carbon credit projects across 6 major registries (Verra, Gold Standard, CAR, ACR, Isometric, Puro Earth). ## Resources | Resource | Description | |---|---| | **Projects** | Search, filter, and retrieve carbon credit project metadata | | **Credits** | Individual credit transactions (issuances, retirements, cancellations) | | **Buyers** | Aggregated buyer intelligence from retirement transaction data | | **Charts** | Pre-aggregated chart data for visualizations | | **Countries** | Country-level carbon market policy intelligence (Article 6, CORSIA, carbon pricing) | | **Forensics** | AI-generated project risk analysis from weekly news scanning | | **Proponent Forensics** | Developer/proponent-level risk ratings and due diligence | | **Satellite** | Forest integrity and deforestation metrics | | **Supply & Demand** | Aggregated issuance vs. retirement volumes over time | | **API Keys** | Manage your API keys and view usage statistics | ## Authentication All endpoints require an API key passed in the `X-API-KEY` header: ```bash curl -H "X-API-KEY: vcm_live_your_key_here" https://api.vcm.fyi/v1/projects/ ``` Get your API key at [app.vcm.fyi/settings/api](https://app.vcm.fyi/settings/api). ## Rate Limits | Plan | Requests/min | Monthly Calls | |------|-------------|---------------| | Pro | 300 | 100,000 | | Enterprise | 1,000 | Unlimited | Rate limit headers are included in every response: - `X-RateLimit-Limit` — Your limit per minute - `X-RateLimit-Remaining` — Remaining requests in current window - `X-RateLimit-Reset` — Unix timestamp when the window resets ## Pagination List endpoints return paginated results: ```json { "pagination": { "total_entries": 11234, "current_page": 1, "total_pages": 113, "next_page": "/v1/projects/?current_page=2&per_page=100" }, "data": [...] } ``` contact: name: VCM.fyi Support email: support@vcm.fyi url: https://vcm.fyi termsOfService: https://vcm.fyi/terms x-logo: url: https://app.vcm.fyi/logo.svg altText: VCM.fyi servers: - url: https://vcm-fyi-api.fly.dev description: Production security: [] tags: - name: API Keys description: Create, list, revoke your API keys and view usage statistics. - name: Buyers description: >- Aggregated buyer intelligence derived from retirement transactions. Includes volume metrics, activity flags, category/country breakdowns, and analytics. - name: Charts description: >- Pre-aggregated chart data for visualizations: projects by listing date, credits by transaction date, category breakdowns, credit histograms, and top buyers. - name: Countries description: >- Country-level carbon market policy intelligence covering Article 6 status, CORSIA eligibility, carbon pricing, VCM regulation, and AI-generated policy summaries. - name: Credits description: >- Query individual credit transactions — issuances, retirements, and cancellations — with quantity, vintage, date, and beneficiary details. - name: Forensics description: >- AI-generated project risk analysis from weekly scanning of 100+ news sources. Includes entries, memos, weekly diffs, and legacy v1 endpoints. - name: Projects description: >- Search, filter, and retrieve metadata for 11,000+ carbon credit projects across Verra, Gold Standard, CAR, ACR, Isometric, and Puro Earth. - name: Proponent Forensics description: >- Developer/proponent-level risk ratings and due diligence analysis with governance, financial, legal, social, and institutional risk pillar scores. - name: Satellite description: >- Forest integrity and deforestation metrics from Global Forest Watch, including tree cover loss, GLAD alerts, fire alerts, and project boundary GeoJSON. - name: Supply & Demand description: >- Aggregated issuance (supply) vs. retirement (demand) volumes over time, with monthly, quarterly, or yearly aggregation. paths: /v1/projects/{project_id}: get: tags: - Projects summary: Get project details description: |- Retrieve full details for a single carbon credit project by its ID. The `project_id` uses the registry prefix format (e.g., `VCS-1764`, `GLD-2345`, `ACR-123`, `CAR-456`, `ISO-789`, `PUR-012`). Returns all project metadata including registry, country, proponent, methodology, credit totals, status, and associated news clips. Also includes a computed `unretired` field (issued minus retired). operationId: get_project_v1_projects__project_id__get parameters: - name: project_id in: path required: true schema: type: string title: Project Id responses: '200': description: Full project details with news clips and computed fields content: application/json: schema: $ref: '#/components/schemas/ProjectWithClips' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: ProjectWithClips: properties: project_id: type: string title: Project Id description: Project id used by registry system name: anyOf: - type: string - type: 'null' title: Name description: Name of the project registry: type: string title: Registry description: Name of the registry proponent: anyOf: - type: string - type: 'null' title: Proponent protocol: anyOf: - items: type: string type: array - type: 'null' title: Protocol description: List of protocols protocol_version: anyOf: - items: type: string type: array - type: 'null' title: Protocol Version description: List of protocol versions (parallel to protocol) category: anyOf: - type: string - type: 'null' title: Category description: Category of the project status: anyOf: - type: string - type: 'null' title: Status country: anyOf: - type: string - type: 'null' title: Country listed_at: anyOf: - type: string format: date - type: 'null' title: Listed At description: Date project was listed is_compliance: anyOf: - type: boolean - type: 'null' title: Is Compliance description: Whether project is compliance project retired: anyOf: - type: integer - type: 'null' title: Retired description: Total of retired credits default: 0 issued: anyOf: - type: integer - type: 'null' title: Issued description: Total of issued credits default: 0 first_issuance_at: anyOf: - type: string format: date - type: 'null' title: First Issuance At description: Date of first issuance of credits first_retirement_at: anyOf: - type: string format: date - type: 'null' title: First Retirement At description: Date of first retirement of credits project_url: anyOf: - type: string - type: 'null' title: Project Url description: URL to project details project_type: anyOf: - type: string - type: 'null' title: Project Type description: Type of project (e.g. ARB, VCS, etc.) project_type_source: anyOf: - type: string - type: 'null' title: Project Type Source description: Source of project type information sdg_goals: anyOf: - items: type: integer type: array - type: 'null' title: Sdg Goals description: UN Sustainable Development Goals (1-17) certifications: anyOf: - items: type: string type: array - type: 'null' title: Certifications description: List of certification labels has_ccb: anyOf: - type: boolean - type: 'null' title: Has Ccb description: Has CCB (Climate, Community & Biodiversity) certification has_icvcm_ccp: anyOf: - type: boolean - type: 'null' title: Has Icvcm Ccp description: Has ICVCM Core Carbon Principles certification has_corsia: anyOf: - type: boolean - type: 'null' title: Has Corsia description: CORSIA eligible has_sdvista: anyOf: - type: boolean - type: 'null' title: Has Sdvista description: Has SD VISta certification has_social_carbon: anyOf: - type: boolean - type: 'null' title: Has Social Carbon description: Has Social Carbon certification article6_authorized: anyOf: - type: boolean - type: 'null' title: Article6 Authorized description: Authorized under Paris Agreement Article 6 article6_countries: anyOf: - items: type: string type: array - type: 'null' title: Article6 Countries description: Countries with Article 6 authorization article6_authorization_types: anyOf: - items: type: string type: array - type: 'null' title: Article6 Authorization Types description: Types of Article 6 authorization corc_durability: anyOf: - type: string - type: 'null' title: Corc Durability description: CORC durability label (100+ or 1000+) clips: anyOf: - items: $ref: '#/components/schemas/Clip' type: array - type: 'null' title: Clips description: List of clips associated with project unretired: anyOf: - type: integer - type: 'null' title: Unretired description: Total of unretired credits (issued - retired) type: object required: - project_id - name - registry - proponent - category - status - country - listed_at - is_compliance - first_issuance_at - first_retirement_at - project_url - project_type - project_type_source title: ProjectWithClips HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError Clip: properties: date: type: string format: date title: Date description: Date the clip was published title: anyOf: - type: string - type: 'null' title: Title description: Title of the clip url: anyOf: - type: string - type: 'null' title: Url description: URL to the clip source: anyOf: - type: string - type: 'null' title: Source description: Source of the clip tags: anyOf: - items: type: string type: array - type: 'null' title: Tags description: Tags associated with the clip notes: anyOf: - type: string - type: 'null' title: Notes description: Notes associated with the clip is_waybacked: anyOf: - type: boolean - type: 'null' title: Is Waybacked description: Whether the clip is a waybacked clip default: false type: anyOf: - type: string - type: 'null' title: Type description: Type of clip default: unknown id: type: integer title: Id type: object required: - date - title - url - source - tags - notes title: Clip ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-KEY ````