Skip to main content
GET
/
v1
/
buyers
/
{buyer_name}
/
analytics
Get buyer analytics
curl --request GET \
  --url https://vcm-fyi-api.fly.dev/v1/buyers/{buyer_name}/analytics \
  --header 'X-API-KEY: <api-key>'
{
  "buyer_name": "<string>",
  "summary": {},
  "retirements_by_vintage": [
    {
      "vintage": 123,
      "quantity": 123
    }
  ],
  "portfolio_by_category": {},
  "retirements_time_series": [
    {
      "date": "<string>",
      "quantity": 123
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
buyer_name
string
required

Response

Buyer analytics with summary, vintage breakdown, category portfolio, and time series

Comprehensive analytics for a carbon credit buyer

​
buyer_name
string
required
​
summary
Summary · object
required

Summary metrics: total_retirements, avg_vintage, total_transactions

​
retirements_by_vintage
VintageBreakdown · object[]
required

Retirements grouped by vintage year, sorted by vintage

​
portfolio_by_category
Portfolio By Category · object
required

Portfolio breakdown with keys: current_year, previous_year

​
retirements_time_series
TimeSeriesPoint · object[]
required

Monthly retirements time series, sorted chronologically