Skip to main content
GET
Get buyer analytics

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