Skip to main content

​
Quickstart

Get up and running with the VCM.fyi API in three steps.

​
1. Get Your API Key

1

Create an account

Sign up at app.vcm.fyi if you don’t have one.
2

Upgrade to Pro

API access requires a Pro or Enterprise plan. Upgrade from your account settings.
3

Generate a key

Go to Settings > API, click Generate New Key, and copy it. The key is shown only once.

​
2. Make Your First Request

curl -H "X-API-KEY: vcm_live_your_key_here" \
  "https://api.vcm.fyi/v1/projects/?per_page=5&registry=verra"

​
3. Explore the Data

Here are some common queries to get you started:

​
Search projects by country and category

curl -H "X-API-KEY: $API_KEY" \
  "https://api.vcm.fyi/v1/projects/?country=Brazil&category=Forestry"

​
Get credit transactions for a specific project

curl -H "X-API-KEY: $API_KEY" \
  "https://api.vcm.fyi/v1/credits/?project_id=VCS-1396"

​
Check AI-generated risk analysis

curl -H "X-API-KEY: $API_KEY" \
  "https://api.vcm.fyi/v1/forensics/v2/VCS-1396"

​
Look up buyer activity

curl -H "X-API-KEY: $API_KEY" \
  "https://api.vcm.fyi/v1/buyers/?per_page=10&sort=-total_retired"

​
Get country-level carbon policy data

curl -H "X-API-KEY: $API_KEY" \
  "https://api.vcm.fyi/v1/countries/BR"

​
What’s Next?

Authentication

Learn about API key management and security best practices.

API Reference

Full endpoint documentation with parameters, responses, and examples.

Rate Limits

Understand rate limiting and how to optimize your usage.

Pagination

Navigate through large datasets efficiently.