> ## 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 buyer details > Retrieve detailed aggregated statistics for a specific buyer identified by name. The `buyer_name` is matched case-insensitively against the harmonized buyer name derived from retirement transaction records. Returns volume metrics, transaction counts, activity flags, and top category/country/registry breakdowns. Returns 404 if no retirement transactions are found for the given buyer name. ## OpenAPI ````yaml https://api.vcm.fyi/v1/openapi.json get /v1/buyers/{buyer_name} 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/buyers/{buyer_name}: get: tags: - Buyers summary: Get buyer details description: >- Retrieve detailed aggregated statistics for a specific buyer identified by name. The `buyer_name` is matched case-insensitively against the harmonized buyer name derived from retirement transaction records. Returns volume metrics, transaction counts, activity flags, and top category/country/registry breakdowns. Returns 404 if no retirement transactions are found for the given buyer name. operationId: get_buyer_detail_v1_buyers__buyer_name__get parameters: - name: buyer_name in: path required: true schema: type: string title: Buyer Name responses: '200': description: >- Aggregated buyer statistics including volume, transactions, and activity data content: application/json: schema: $ref: '#/components/schemas/BuyerStats' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: BuyerStats: properties: buyer_name: type: string title: Buyer Name total_volume: type: integer title: Total Volume volume_12m: type: integer title: Volume 12M volume_60d: type: integer title: Volume 60D avg_transaction_size: type: integer title: Avg Transaction Size total_transactions: type: integer title: Total Transactions transactions_12m: type: integer title: Transactions 12M transactions_60d: type: integer title: Transactions 60D transactions_per_year: type: number title: Transactions Per Year first_purchase: type: string format: date title: First Purchase last_purchase: type: string format: date title: Last Purchase days_since_last: type: integer title: Days Since Last top_category: anyOf: - type: string - type: 'null' title: Top Category top_country: anyOf: - type: string - type: 'null' title: Top Country top_registry: anyOf: - type: string - type: 'null' title: Top Registry is_active_12m: type: boolean title: Is Active 12M is_active_60d: type: boolean title: Is Active 60D type: object required: - buyer_name - total_volume - volume_12m - volume_60d - avg_transaction_size - total_transactions - transactions_12m - transactions_60d - transactions_per_year - first_purchase - last_purchase - days_since_last - top_category - top_country - top_registry - is_active_12m - is_active_60d title: BuyerStats HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError 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 ````