Carbonmark Developers
  • CARBONMARK API
    • Introduction to Carbonmark API
    • Versioning & Release Process
      • v17 (latest stable)
      • v16 (deprecated & supported)
      • v15 (retired)
    • Quickstart
    • Explore Carbon Projects
      • Find carbon projects by country
      • Find carbon projects by vintage
      • Find carbon projects by methodology category
      • Find carbon projects by project name or description
    • Explore Index Products
      • Find index products
    • Retire Carbon
      • Postman Quickstart Guide
    • API Checkout Service (beta)
    • API Reference
  • Transfer Credits
    • Transfer Credits to/from Carbonmark
      • ICR: Import Credits to Carbonmark
      • ICR: Export Credits to ICR
      • Puro Bridge Integration Guide
  • Carbonmark Direct
    • Direct Credit Issuance
  • Resources
    • Contact us
    • Book a demo
    • Terms of Use
    • Privacy Policy
Powered by GitBook
On this page
  • Status
  • Summary
  • Release notes
  • Migration Path
  1. CARBONMARK API
  2. Versioning & Release Process

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 is Polygon.

    • 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.

PreviousVersioning & Release ProcessNextv16 (deprecated & supported)

Last updated 3 days ago

Get retirement details for a completed retirement order. This replaces the endpoint that was present in previous versions (see below)

Get the credit provenance history leading up to a completed retirement. This replaces the /provenance endpoint that was present in previous versions (see below)

[⚠️BREAKING CHANGE] This endpoint was removed because a transaction hash may now include more than one retirement. It has been replaced by /retirements/:beneficiaryAddress/:retirementIndex. See for more info. See for alternatives.

[⚠️BREAKING CHANGE] This endpoint was removed because a transaction hash may now include more than one retirement. It has been replaced by /retirements/:beneficiaryAddress/:retirementIndex. See for more info. See for alternatives.

The endpoint is now paginated. Your UI or system may need to be refactored to consume pages, rather than a complete list of projects. The project data is now provided in the items attribute of the response.

Example using hash to filter:

/carbonProjects
https://v17.api.carbonmark.com/retirements?hash=0x7b63b79d25c76b6f179360ebd5f9f3c2435d3fdf2dda7e1d3ab43cf4f90e4a04
Endpoints removed
Endpoints removed
Endpoints added
migration path
Endpoints added
migration path