Monthly retirements time series, sorted chronologically
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VCM.fyi API","colors":{"primary":"#10a37f","light":"#34d399","dark":"#059669"},"logo":{"light":"https://mintcdn.com/vcmfyi/o4-C0m0__z3_mjAB/logo/light.svg?fit=max\u0026auto=format\u0026n=o4-C0m0__z3_mjAB\u0026q=85\u0026s=53a4802e4d04a191ec7deab4c5e8dedf","dark":"https://mintcdn.com/vcmfyi/o4-C0m0__z3_mjAB/logo/dark.svg?fit=max\u0026auto=format\u0026n=o4-C0m0__z3_mjAB\u0026q=85\u0026s=93747c6de80c3903cfc3f2adad217484"},"favicon":"/favicon.svg","seo":{},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vcmfyi","hasAudioNarration":false,"actualSubdomain":"vcmfyi","customDomains":["docs.api.vcm.fyi"],"gitSource":{"type":"github","owner":"mmobir","repo":"vcm-fyi-api","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21ec11c210dbcccbc1986c","collectionId":"5da6e037-a4b9-411d-bec0-ee8e9f542b73","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21ec11c210dbcccbc1986c:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":37},{"language":"default","tag":"Charts","count":9},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Getting Started","count":6},{"language":"default","tag":"Forensics","count":6},{"language":"default","tag":"API Keys","count":4},{"language":"default","tag":"Countries","count":4},{"language":"default","tag":"Buyers","count":3},{"language":"default","tag":"Projects","count":3},{"language":"default","tag":"Proponent Forensics","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/buyers/get-buyer-analytics","slug":"/api-reference/buyers/get-buyer-analytics","pageMetadata":{"title":"Get buyer analytics","description":"Retrieve comprehensive analytics for a specific buyer, designed for portfolio\n visualization and trend analysis.\n\n **Returns:**\n - **Summary:** Total retirements, average vintage year, total transactions\n - **Retirements by vintage:** Breakdown of retired credit quantities by vintage year\n - **Portfolio by category:** Category breakdown comparing current year vs. previous year\n - **Retirements time series:** Monthly retirement volumes over time\n\n The `buyer_name` is matched case-insensitively. Returns 404 if no data found.\n\n Note: Pricing data is not available — all metrics are quantity-based.","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/buyers/{buyer_name}/analytics","href":"/api-reference/buyers/get-buyer-analytics","autogeneratedByOpenApi":true,"hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve comprehensive analytics for a specific buyer, designed for portfolio\\nvisualization and trend analysis.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Returns:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Summary:\"\n }), \" Total retirements, average vintage year, total transactions\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Retirements by vintage:\"\n }), \" Breakdown of retired credit quantities by vintage year\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Portfolio by category:\"\n }), \" Category breakdown comparing current year vs. previous year\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Retirements time series:\"\n }), \" Monthly retirement volumes over time\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.code, {\n children: \"buyer_name\"\n }), \" is matched case-insensitively. Returns 404 if no data found.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Note: Pricing data is not available — all metrics are quantity-based.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get buyer analytics","description":"Retrieve comprehensive analytics for a specific buyer, designed for portfolio\n visualization and trend analysis.\n\n **Returns:**\n - **Summary:** Total retirements, average vintage year, total transactions\n - **Retirements by vintage:** Breakdown of retired credit quantities by vintage year\n - **Portfolio by category:** Category breakdown comparing current year vs. previous year\n - **Retirements time series:** Monthly retirement volumes over time\n\n The `buyer_name` is matched case-insensitively. Returns 404 if no data found.\n\n Note: Pricing data is not available — all metrics are quantity-based.","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/buyers/{buyer_name}/analytics","href":"/api-reference/buyers/get-buyer-analytics","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Buyers"],"summary":"Get buyer analytics","description":"Retrieve comprehensive analytics for a specific buyer, designed for portfolio\n visualization and trend analysis.\n\n **Returns:**\n - **Summary:** Total retirements, average vintage year, total transactions\n - **Retirements by vintage:** Breakdown of retired credit quantities by vintage year\n - **Portfolio by category:** Category breakdown comparing current year vs. previous year\n - **Retirements time series:** Monthly retirement volumes over time\n\n The `buyer_name` is matched case-insensitively. Returns 404 if no data found.\n\n Note: Pricing data is not available — all metrics are quantity-based.","operationId":"get_buyer_analytics_v1_buyers__buyer_name__analytics_get","security":["37e3de2f-3976-4159-98d2-03179dc87327"],"parameters":["ce27d7e0-8b02-4321-b3ce-3aa677e63644"],"responses":{"200":"dc9147a7-e6fc-476b-b549-26bdb4d53054","422":"2c678c1a-93b0-46e1-9b99-a3541716f270"},"method":"get","type":"path","servers":["bc74cd13-431c-4ad0-bbdb-11eecb289135"],"path":"/v1/buyers/{buyer_name}/analytics","baseUrlOptions":["https://vcm-fyi-api.fly.dev"],"title":"Get buyer analytics","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ce27d7e0-8b02-4321-b3ce-3aa677e63644":{"name":"buyer_name","in":"path","required":true,"schema":{"type":"string","title":"Buyer Name","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"dc9147a7-e6fc-476b-b549-26bdb4d53054":{"description":"Buyer analytics with summary, vintage breakdown, category portfolio, and time series","content":{"application/json":{"schema":{"properties":{"buyer_name":{"type":"string","title":"Buyer Name","isRequired":true,"uniqueKey":"buyer_name","typeLabel":"string"},"summary":{"additionalProperties":true,"type":"object","title":"Summary","description":"Summary metrics: total_retirements, avg_vintage, total_transactions","isRequired":true,"uniqueKey":"summary","typeLabel":"Summary · object"},"retirements_by_vintage":{"items":{"properties":{"vintage":{"type":"integer","title":"Vintage","isRequired":true,"uniqueKey":"retirements_by_vintage.items.[INDEX].vintage","typeLabel":"integer"},"quantity":{"type":"integer","title":"Quantity","isRequired":true,"uniqueKey":"retirements_by_vintage.items.[INDEX].quantity","typeLabel":"integer"}},"type":"object","required":["vintage","quantity"],"title":"VintageBreakdown","description":"Retirements breakdown by vintage year","uniqueKey":"retirements_by_vintage.items.[INDEX]","typeLabel":"VintageBreakdown · object"},"type":"array","title":"Retirements By Vintage","description":"Retirements grouped by vintage year, sorted by vintage","isRequired":true,"uniqueKey":"retirements_by_vintage","typeLabel":"VintageBreakdown · object[]"},"portfolio_by_category":{"additionalProperties":{"items":{"properties":{"category":{"type":"string","title":"Category","isRequired":true,"uniqueKey":"portfolio_by_category.additionalProperties.items.[INDEX].category","typeLabel":"string"},"quantity":{"type":"integer","title":"Quantity","isRequired":true,"uniqueKey":"portfolio_by_category.additionalProperties.items.[INDEX].quantity","typeLabel":"integer"}},"type":"object","required":["category","quantity"],"title":"CategoryBreakdown","description":"Portfolio breakdown by project category","uniqueKey":"portfolio_by_category.additionalProperties.items.[INDEX]","typeLabel":"CategoryBreakdown · object"},"type":"array","uniqueKey":"portfolio_by_category.additionalProperties","typeLabel":"CategoryBreakdown · object[]"},"type":"object","title":"Portfolio By Category","description":"Portfolio breakdown with keys: current_year, previous_year","isRequired":true,"uniqueKey":"portfolio_by_category","typeLabel":"Portfolio By Category · object"},"retirements_time_series":{"items":{"properties":{"date":{"type":"string","title":"Date","isRequired":true,"uniqueKey":"retirements_time_series.items.[INDEX].date","typeLabel":"string"},"quantity":{"type":"integer","title":"Quantity","isRequired":true,"uniqueKey":"retirements_time_series.items.[INDEX].quantity","typeLabel":"integer"}},"type":"object","required":["date","quantity"],"title":"TimeSeriesPoint","description":"Time series data point for retirements","uniqueKey":"retirements_time_series.items.[INDEX]","typeLabel":"TimeSeriesPoint · object"},"type":"array","title":"Retirements Time Series","description":"Monthly retirements time series, sorted chronologically","isRequired":true,"uniqueKey":"retirements_time_series","typeLabel":"TimeSeriesPoint · object[]"}},"type":"object","required":["buyer_name","summary","retirements_by_vintage","portfolio_by_category","retirements_time_series"],"title":"BuyerAnalytics","description":"Comprehensive analytics for a carbon credit buyer","uniqueKey":"","typeLabel":"BuyerAnalytics · object"},"examples":{"Example":{"title":"Example","value":{"buyer_name":"\u003cstring>","summary":{},"retirements_by_vintage":[{"vintage":123,"quantity":123}],"portfolio_by_category":{},"retirements_time_series":[{"date":"\u003cstring>","quantity":123}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2c678c1a-93b0-46e1-9b99-a3541716f270":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"37e3de2f-3976-4159-98d2-03179dc87327":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"bc74cd13-431c-4ad0-bbdb-11eecb289135":{"url":"https://vcm-fyi-api.fly.dev","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-KEY"}],"title":"APIKeyHeader"}]},"originalFileLocation":"https://api.vcm.fyi/v1/openapi.json"},"subdomain":"vcmfyi","siteName":"VCM.fyi API","title":"Get buyer analytics - VCM.fyi API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-10T20:27:32.305Z","originalFileLocation":"api-reference/buyers/get-buyer-analytics.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve comprehensive analytics for a specific buyer, designed for portfolio visualization and trend analysis. Returns: - Summary: Total retirements, average vintage year, total transactions - Retirements by vintage: Breakdown of retired credit quantities by vintage year - Portfolio by category: Category breakdown comparing current year vs. previous year - Retirements time series: Monthly retirement volumes over time The buyer_name is matched case-insensitively. Returns 404 if no data found. Note: Pricing data is not available — all metrics are quantity-based.\">\u003cmeta data-mint-head name=\"application-name\" content=\"VCM.fyi API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get buyer analytics - VCM.fyi API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve comprehensive analytics for a specific buyer, designed for portfolio visualization and trend analysis. Returns: - Summary: Total retirements, average vintage year, total transactions - Retirements by vintage: Breakdown of retired credit quantities by vintage year - Portfolio by category: Category breakdown comparing current year vs. previous year - Retirements time series: Monthly retirement volumes over time The buyer_name is matched case-insensitively. Returns 404 if no data found. Note: Pricing data is not available — all metrics are quantity-based.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VCM.fyi API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vcmfyi.mintlify.app/_mintlify/api/og/v2?division=Buyers\u0026amp;title=Get+buyer+analytics\u0026amp;description=Retrieve+comprehensive+analytics+for+a+specific+buyer%2C+designed+for+portfolio%0A++++visualization+and+trend+analysis.%0A%0A++++**Returns%3A**%0A++++-+**Summary%3A**+Total+r\u0026amp;theme=1962e5140f9943bc44faa79b\u0026amp;signature=511a9019b01d7b84b09a8c0adb5d3a53fe1ec5df4eb1af3f32d664699af14b0f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get buyer analytics - VCM.fyi API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve comprehensive analytics for a specific buyer, designed for portfolio visualization and trend analysis. Returns: - Summary: Total retirements, average vintage year, total transactions - Retirements by vintage: Breakdown of retired credit quantities by vintage year - Portfolio by category: Category breakdown comparing current year vs. previous year - Retirements time series: Monthly retirement volumes over time The buyer_name is matched case-insensitively. Returns 404 if no data found. Note: Pricing data is not available — all metrics are quantity-based.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vcmfyi.mintlify.app/_mintlify/api/og/v2?division=Buyers\u0026amp;title=Get+buyer+analytics\u0026amp;description=Retrieve+comprehensive+analytics+for+a+specific+buyer%2C+designed+for+portfolio%0A++++visualization+and+trend+analysis.%0A%0A++++**Returns%3A**%0A++++-+**Summary%3A**+Total+r\u0026amp;theme=1962e5140f9943bc44faa79b\u0026amp;signature=511a9019b01d7b84b09a8c0adb5d3a53fe1ec5df4eb1af3f32d664699af14b0f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vcmfyi/03Bul2fYuD9fgQO2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VCM.fyi API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#10a37f\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/buyers/get-buyer-analytics.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.api.vcm.fyi/#organization\",\"name\":\"VCM.fyi API\",\"url\":\"https://docs.api.vcm.fyi\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vcmfyi/o4-C0m0__z3_mjAB/logo/light.svg?fit=max\u0026auto=format\u0026n=o4-C0m0__z3_mjAB\u0026q=85\u0026s=53a4802e4d04a191ec7deab4c5e8dedf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.api.vcm.fyi#website\",\"name\":\"VCM.fyi API\",\"url\":\"https://docs.api.vcm.fyi\",\"publisher\":{\"@id\":\"https://docs.api.vcm.fyi/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics#webpage\",\"url\":\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics\",\"name\":\"Get buyer analytics\",\"description\":\"Retrieve comprehensive analytics for a specific buyer, designed for portfolio visualization and trend analysis. Returns: - Summary: Total retirements, average vintage year, total transactions - Retirements by vintage: Breakdown of retired credit quantities by vintage year - Portfolio by category: Category breakdown comparing current year vs. previous year - Retirements time series: Monthly retirement volumes over time The buyer_name is matched case-insensitively. Returns 404 if no data found. Note: Pricing data is not available — all metrics are quantity-based.\",\"dateModified\":\"2026-03-10T20:27:32.305Z\",\"isPartOf\":{\"@id\":\"https://docs.api.vcm.fyi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Buyers\",\"item\":\"https://docs.api.vcm.fyi/api-reference/buyers/list-carbon-credit-buyers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get buyer analytics\",\"item\":\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics#apireference\",\"headline\":\"Get buyer analytics\",\"name\":\"Get buyer analytics\",\"description\":\"Retrieve comprehensive analytics for a specific buyer, designed for portfolio visualization and trend analysis. Returns: - Summary: Total retirements, average vintage year, total transactions - Retirements by vintage: Breakdown of retired credit quantities by vintage year - Portfolio by category: Category breakdown comparing current year vs. previous year - Retirements time series: Monthly retirement volumes over time The buyer_name is matched case-insensitively. Returns 404 if no data found. Note: Pricing data is not available — all metrics are quantity-based.\",\"url\":\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics\",\"mainEntityOfPage\":{\"@id\":\"https://docs.api.vcm.fyi/api-reference/buyers/get-buyer-analytics#webpage\"},\"dateModified\":\"2026-03-10T20:27:32.305Z\",\"publisher\":{\"@id\":\"https://docs.api.vcm.fyi/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.api.vcm.fyi#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VCM.fyi API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"VCM.fyi API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Projects","pages":[{"title":"Get all project type categories","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/projects/types","href":"/api-reference/projects/get-all-project-type-categories"},{"title":"List carbon credit projects","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/projects/","href":"/api-reference/projects/list-carbon-credit-projects"},{"title":"Get project details","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/projects/{project_id}","href":"/api-reference/projects/get-project-details"}]},{"group":"Credits","pages":[{"title":"List credit transactions","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/credits/","href":"/api-reference/credits/list-credit-transactions"}]},{"group":"Buyers","pages":[{"title":"List carbon credit buyers","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/buyers/","href":"/api-reference/buyers/list-carbon-credit-buyers"},{"title":"Get buyer details","description":"Retrieve detailed aggregated statistics for a specific buyer identified by name.\n\n The `buyer_name` is matched case-insensitively against the harmonized buyer name\n derived from retirement transaction records. Returns volume metrics, transaction\n counts, activity flags, and top category/country/registry breakdowns.\n\n Returns 404 if no retirement transactions are found for the given buyer name.","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/buyers/{buyer_name}","href":"/api-reference/buyers/get-buyer-details"},{"title":"Get buyer analytics","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/buyers/{buyer_name}/analytics","href":"/api-reference/buyers/get-buyer-analytics"}]},{"group":"Charts","pages":[{"title":"Projects by listing date","description":"Get project counts binned by listing (registration) date, broken down by category.\n\n Returns time-binned data suitable for stacked area or bar charts showing how many\n projects were registered over time, grouped by category (e.g., Forestry, Renewable Energy).\n\n **Frequency:** `D` (daily), `W` (weekly), `M` (monthly), `Y` (yearly). Default: `Y`.\n\n **Filters:** All standard project filters apply (registry, country, category, etc.).","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/projects_by_listing_date","href":"/api-reference/charts/projects-by-listing-date"},{"title":"Credit volumes by transaction date","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/credits_by_transaction_date","href":"/api-reference/charts/credit-volumes-by-transaction-date"},{"title":"Credit volumes by transaction date for a project","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/credits_by_transaction_date/{project_id}","href":"/api-reference/charts/credit-volumes-by-transaction-date-for-a-project"},{"title":"Issuances by vintage year for a project","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/credits_issuances_by_vintage/{project_id}","href":"/api-reference/charts/issuances-by-vintage-year-for-a-project"},{"title":"Retirements by vintage year for a project","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/credits_retirements_by_vintage/{project_id}","href":"/api-reference/charts/retirements-by-vintage-year-for-a-project"},{"title":"Project distribution by credit totals","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/projects_by_credit_totals","href":"/api-reference/charts/project-distribution-by-credit-totals"},{"title":"Project counts by category","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/projects_by_category","href":"/api-reference/charts/project-counts-by-category"},{"title":"Credit totals by category","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/credits_by_category","href":"/api-reference/charts/credit-totals-by-category"},{"title":"Top credit buyers by retirement volume","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/charts/top_buyers","href":"/api-reference/charts/top-credit-buyers-by-retirement-volume"}]},{"group":"Countries","pages":[{"title":"List countries with policy intelligence","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/countries/","href":"/api-reference/countries/list-countries-with-policy-intelligence"},{"title":"Get country policy detail","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/countries/{country_code}","href":"/api-reference/countries/get-country-policy-detail"},{"title":"Get country policy updates","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/countries/{country_code}/updates","href":"/api-reference/countries/get-country-policy-updates"},{"title":"Get global country policy statistics","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/countries/stats/summary","href":"/api-reference/countries/get-global-country-policy-statistics"}]},{"group":"Forensics","pages":[{"title":"Get latest forensic news feed","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/forensics/v2/latest","href":"/api-reference/forensics/get-latest-forensic-news-feed"},{"title":"Get project forensic analysis (v2)","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/forensics/v2/{project_id}","href":"/api-reference/forensics/get-project-forensic-analysis-v2"},{"title":"List forensic news entries for a project","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/forensics/v2/{project_id}/entries","href":"/api-reference/forensics/list-forensic-news-entries-for-a-project"},{"title":"Get weekly forensic diff for a project","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/forensics/v2/{project_id}/diff","href":"/api-reference/forensics/get-weekly-forensic-diff-for-a-project"},{"title":"Get project forensic analysis (v1, legacy)","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/forensics/{project_id}","href":"/api-reference/forensics/get-project-forensic-analysis-v1-legacy"},{"title":"List forensic analyses (v1, legacy)","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/forensics/","href":"/api-reference/forensics/list-forensic-analyses-v1-legacy"}]},{"group":"Proponent Forensics","pages":[{"title":"Get proponent risk analysis by name","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/proponent-forensics/by-proponent/{proponent_key}","href":"/api-reference/proponent-forensics/get-proponent-risk-analysis-by-name"},{"title":"Get proponent risk analyses for a project","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/proponent-forensics/by-project/{project_id}","href":"/api-reference/proponent-forensics/get-proponent-risk-analyses-for-a-project"},{"title":"List proponent risk analyses","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/proponent-forensics/","href":"/api-reference/proponent-forensics/list-proponent-risk-analyses"}]},{"group":"Satellite","pages":[{"title":"Get satellite verification data for a project","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/satellite/{project_id}","href":"/api-reference/satellite/get-satellite-verification-data-for-a-project"},{"title":"Get project boundary GeoJSON","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/satellite/{project_id}/boundary","href":"/api-reference/satellite/get-project-boundary-geojson"},{"title":"List projects with satellite data","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/satellite/","href":"/api-reference/satellite/list-projects-with-satellite-data"}]},{"group":"Supply \u0026 Demand","pages":[{"title":"Get supply and demand time series","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/supply-demand/","href":"/api-reference/supply-\u0026-demand/get-supply-and-demand-time-series"}]},{"group":"API Keys","pages":[{"title":"List your API keys","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/api-keys/","href":"/api-reference/api-keys/list-your-api-keys"},{"title":"Create a new API key","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json post /v1/api-keys/","href":"/api-reference/api-keys/create-a-new-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json delete /v1/api-keys/{key_id}","href":"/api-reference/api-keys/revoke-an-api-key"},{"title":"Get your API usage statistics","deprecated":null,"version":null,"openapi":"https://api.vcm.fyi/v1/openapi.json get /v1/api-keys/usage","href":"/api-reference/api-keys/get-your-api-usage-statistics"}]}]}]},"basePath":"","title":"Get buyer analytics - VCM.fyi API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}