Retirements by vintage year for a project
curl --request GET \
--url https://vcm-fyi-api.fly.dev/v1/charts/credits_retirements_by_vintage/{project_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://vcm-fyi-api.fly.dev/v1/charts/credits_retirements_by_vintage/{project_id}"
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/charts/credits_retirements_by_vintage/{project_id}', 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/charts/credits_retirements_by_vintage/{project_id}",
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/charts/credits_retirements_by_vintage/{project_id}"
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/charts/credits_retirements_by_vintage/{project_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vcm-fyi-api.fly.dev/v1/charts/credits_retirements_by_vintage/{project_id}")
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": [
{
"start": "2023-12-25",
"end": "2023-12-25",
"value": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Charts
Retirements by vintage year for a project
Get credit retirement quantities aggregated by vintage year for a specific project.
Returns one data point per vintage year showing the total credits retired for that vintage. Useful for comparing retirement patterns against issuance vintages.
Only includes retirement-type transactions. Null vintages are excluded.
GET
/
v1
/
charts
/
credits_retirements_by_vintage
/
{project_id}
Retirements by vintage year for a project
curl --request GET \
--url https://vcm-fyi-api.fly.dev/v1/charts/credits_retirements_by_vintage/{project_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://vcm-fyi-api.fly.dev/v1/charts/credits_retirements_by_vintage/{project_id}"
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/charts/credits_retirements_by_vintage/{project_id}', 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/charts/credits_retirements_by_vintage/{project_id}",
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/charts/credits_retirements_by_vintage/{project_id}"
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/charts/credits_retirements_by_vintage/{project_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vcm-fyi-api.fly.dev/v1/charts/credits_retirements_by_vintage/{project_id}")
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": [
{
"start": "2023-12-25",
"end": "2023-12-25",
"value": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Path Parameters
Query Parameters
Page number
Required range:
x >= 1Items per page
Required range:
1 <= x <= 200Transaction 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