curl --request GET \
--url https://vcm-fyi-api.fly.dev/v1/credits/ \
--header 'X-API-KEY: <api-key>'import requests
url = "https://vcm-fyi-api.fly.dev/v1/credits/"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://vcm-fyi-api.fly.dev/v1/credits/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vcm-fyi-api.fly.dev/v1/credits/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://vcm-fyi-api.fly.dev/v1/credits/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://vcm-fyi-api.fly.dev/v1/credits/")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vcm-fyi-api.fly.dev/v1/credits/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"pagination": {
"total_entries": 123,
"current_page": 123,
"total_pages": 123,
"next_page": "<string>"
},
"data": [
{
"quantity": 123,
"vintage": 123,
"transaction_date": "2023-12-25",
"transaction_type": "<string>",
"retirement_account": "<string>",
"retirement_beneficiary": "<string>",
"retirement_reason": "<string>",
"retirement_note": "<string>",
"retirement_beneficiary_harmonized": "<string>",
"id": 123,
"projects": [
{
"project_id": "<string>",
"category": "<string>",
"project_type": "<string>"
}
],
"sdg_goals": [
123
],
"certifications": [
"<string>"
]
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}List credit transactions
Search and filter individual credit transactions across all registries.
Each record represents a single credit transaction event — issuance, retirement, or cancellation — with quantity, vintage, transaction date, and beneficiary details.
Filtering: Apply project-level filters (registry, country, category) alongside credit-level filters (transaction_type, vintage range, quantity range, date range).
Beneficiary search: Use beneficiary_search to find retirement transactions
for a specific buyer/beneficiary name.
Sorting: Use sort with field names prefixed by +/-. Default: project_id.
Pagination: Default page size is 100, maximum 200.
Each credit includes its parent project’s category and project_type in a
nested projects array.
curl --request GET \
--url https://vcm-fyi-api.fly.dev/v1/credits/ \
--header 'X-API-KEY: <api-key>'import requests
url = "https://vcm-fyi-api.fly.dev/v1/credits/"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://vcm-fyi-api.fly.dev/v1/credits/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vcm-fyi-api.fly.dev/v1/credits/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://vcm-fyi-api.fly.dev/v1/credits/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://vcm-fyi-api.fly.dev/v1/credits/")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vcm-fyi-api.fly.dev/v1/credits/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"pagination": {
"total_entries": 123,
"current_page": 123,
"total_pages": 123,
"next_page": "<string>"
},
"data": [
{
"quantity": 123,
"vintage": 123,
"transaction_date": "2023-12-25",
"transaction_type": "<string>",
"retirement_account": "<string>",
"retirement_beneficiary": "<string>",
"retirement_reason": "<string>",
"retirement_note": "<string>",
"retirement_beneficiary_harmonized": "<string>",
"id": 123,
"projects": [
{
"project_id": "<string>",
"category": "<string>",
"project_type": "<string>"
}
],
"sdg_goals": [
123
],
"certifications": [
"<string>"
]
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Query Parameters
Project ID
List of sorting parameters in the format field_name or +field_name for ascending order or -field_name for descending order.
Page number
x >= 1Items per page
1 <= x <= 200Registry name
verra, gold-standard, american-carbon-registry, climate-action-reserve, art-trees, isometric, puro-earth, plan-vivo, none Country name
Protocol name
Category name
Whether project is an ARB project
Format: YYYY-MM-DD
Format: YYYY-MM-DD
Minimum number of issued credits
Maximum number of issued credits
Minimum number of retired credits
Maximum number of retired credits
Project type
Project proponent/developer name
UN SDG goals (1-17). Multiple values = AND filter (must have ALL selected goals)
Specific certification labels (e.g., ccb-gold, ccb-biodiversity-gold, corsia). Multiple values = OR filter
Puro.earth CORC durability (100+ or 1000+). Multiple values = OR filter
Has CCB (Climate, Community & Biodiversity) certification
Has ICVCM Core Carbon Principles certification
CORSIA eligible
Has SD VISta certification
Has Social Carbon certification
Authorized under Paris Agreement Article 6
Article 6 authorization types: NDC Use, Intl mitigation purposes, Other purposes
Transaction type
Vintage
Format: YYYY-MM-DD
Format: YYYY-MM-DD
Minimum transaction quantity
Maximum transaction quantity
Case insensitive search string. Currently searches on specified beneficiary_search_fields only.
Beneficiary fields to search in. Valid fields are: retirement_beneficiary_harmonized, retirement_beneficiary, retirement_beneficiary_account, retirement_beneficiary_note, retirement_beneficiary_reason