v17 (latest stable)
Status
Live
June 4, 2025
Summary
v17 is primarily focused on improving the stability and performance of order processing. It includes a few breaking changes from v16 (highlighted below).
Release notes
General
Removed
network
query parameter from the following endpoints. Default network isPolygon
.GET
/activities
GET
/carbonProjects
GET
/carbonProjects/:id
GET
/categories
GET
/countries
GET
/listings/:id
GET
/listings
GET
/purchases/:id
GET
/purchases
GET
/prices
GET
/retirements
GET
/retirements/:id
GET
/retirements/:id/provenance
GET
/vintages
Endpoints updated
GET /carbonProjects
[⚠️BREAKING CHANGE] Response entries are now paginated
Added a block_long_description field that contains a project description in PortableText format
GET /carbonProjects/:id
Added a block_long_description field that contains a project description in PortableText format
Endpoints added
GET /assessors
Returns the list of known project assessors (related to project verification and validation)
GET /developers
Returns the list of known project developers
GET /retirements/:beneficiaryAddress/:retirementIndex
GET /retirements/:beneficiaryAddress/:retirementIndex/provenance
Endpoints removed
GET /retirements/:hash
GET /retirements/:hash/provenance
Migration Path
Carbon Projects endpoint
Retirement endpoints
If you were using the GET
/retirements/:hash
and GET/retirements/:hash/provenance
you should now use the new endpoints:GET
/retirements/:beneficiaryAddress/:retirementIndex
GET
/retirements/:beneficiaryAddress/:retirementIndex/provenance
If you only have the transaction hash you can still use the hash to filter on the GET
/retirements
endpoint, which returns a list.
Last updated