Carbonmark Carbon Projects API
The CarbonProjects API from Carbonmark — 2 operation(s) for carbonprojects.
The CarbonProjects API from Carbonmark — 2 operation(s) for carbonprojects.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/carbonmark-com:carbonmark-com-carbonprojects-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Carbonmark REST Carbon Projects API
license:
name: Proprietary
description: 'Welcome to the API Reference docs for **version v20** of the Carbonmark REST API.
Use this API to view assets, prices, supply, activity and more.
To find the latest stable version, visit docs.carbonmark.com.
## Quick start
Be sure to prefix a version number, otherwise your application will be exposed to breaking changes.
~~~ts
const res = await fetch("https://v20.api.carbonmark.com/projects");
const projects = await res.json();
~~~
For a developer guides and example implementations, or to learn more about Carbonmark and the Carbon Market, view our product knowledge base at docs.carbonmark.com.
##'
termsOfService: https://www.carbonmark.com/terms-of-use
contact:
name: Support
url: https://www.carbonmark.com/contact-us
version: v20
servers:
- url: https://v20.api.carbonmark.com
tags:
- name: CarbonProjects
paths:
/carbonProjects:
get:
summary: List projects
tags:
- CarbonProjects
description: Retrieve an array of carbon projects filtered by desired query parameters
parameters:
- schema:
type: array
items:
type: string
in: query
name: ids
required: false
description: A list of allowable ProjectIDs
- schema:
type: array
items:
type: string
in: query
name: country
required: false
description: Desired countries of origin for carbon projects
- schema:
type: array
items:
type: string
in: query
name: category
required: false
description: Desired categories of carbon projects
- schema:
type: string
in: query
name: search
required: false
description: Search carbon project names and descriptions for a string of text
- schema:
type: array
items:
type: string
in: query
name: vintage
required: false
description: Desired vintages of carbon projects
- schema:
type: array
items:
type: string
in: query
name: sdg
required: false
description: Desired SDGs of carbon projects
- schema:
type: array
items:
type: string
in: query
name: registry
required: false
description: Desired Registries of carbon projects
- schema:
type: string
example: '1620000000'
in: query
name: expiresAfter
required: false
description: Only return projects listings that expire after this timestamp (Unix seconds)
- schema:
minimum: 0
type: number
example: '100'
in: query
name: minSupply
required: false
description: Only return projects with a purchaseable supply greater than this amount (Tonnes)
- schema:
minimum: 0
type: number
examples:
'2':
value: '2'
'0.5':
value: '0.5'
'1.5':
value: '1.5'
in: query
name: minPriceUSD
required: false
description: Exclude projects with a per-tonne price lower than this amount (USD)
- schema:
type: array
items:
type: string
in: query
name: assetPriceSourceIds
required: false
description: Filter projects associated with listings matching specific asset_price_source_ids
- schema:
type: array
items:
description: Filter projects associated with listings matching specific asset price types
anyOf:
- title: listing
type: string
enum:
- listing
- title: klimaprotocol
type: string
enum:
- klimaprotocol
example:
- listing
- klimaprotocol
in: query
name: assetPriceType
required: false
- schema:
default: 0
minimum: 0
type: number
in: query
name: offset
required: false
description: Index of the first item to return
- schema:
default: 20
minimum: 1
type: number
in: query
name: limit
required: false
description: Maximum number of items to return
responses:
'200':
description: List of carbon projects
content:
application/json:
schema:
type: object
properties:
items:
description: Items
type: array
items:
$ref: '#/components/schemas/CarbonProject'
itemsCount:
description: Total number of available items
type: number
offset:
description: Index of the first item of the returned result page
type: number
required:
- items
- itemsCount
- offset
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
error:
type: string
operationId: getCarbonProjects
x-operation-id-source: derived
/carbonProjects/{id}:
get:
summary: Project details
tags:
- CarbonProjects
description: Retrieve a carbon project by its project ID
parameters:
- schema:
type: string
example: '1620000000'
in: query
name: expiresAfter
required: false
description: Only return projects listings that expire after this timestamp (Unix seconds)
- schema:
minimum: 0
type: number
example: '0'
in: query
name: minSupply
required: false
description: Only consider project listings that contain at least this amount of credits (Tonnes)
- schema:
type: array
items:
description: Filter projects associated with listings matching specific asset price types
anyOf:
- title: listing
type: string
enum:
- listing
- title: klimaprotocol
type: string
enum:
- klimaprotocol
example:
- listing
- klimaprotocol
in: query
name: assetPriceType
required: false
- schema:
type: string
pattern: ^VCS-\d+$|^GS-\d+$|^ICR-\d+$|^PUR-\d+$|^JCS-\d{5}$|^ECO-\d+$|^CMARK-\d+$|matchnothing^|^TVER-\d+$|^REGEN-[A-Z0-9]{6}$|^UCR-\d+$
examples:
VCS-191:
value: VCS-191
ICR-112:
value: ICR-112
JCS-19011:
value: JCS-19011
ECO-1234:
value: ECO-1234
in: path
name: id
required: true
description: Project identifier
responses:
'200':
description: Project with id
content:
application/json:
schema:
$ref: '#/components/schemas/CarbonProject'
operationId: getCarbonProjectsById
x-operation-id-source: derived
components:
schemas:
ImageModel:
type: object
properties:
caption:
anyOf:
- type: string
- type: 'null'
url:
anyOf:
- type: string
- type: 'null'
CarbonProject:
type: object
properties:
description:
anyOf:
- type: string
- type: 'null'
block_long_description:
anyOf:
- type: array
items:
type: object
properties:
_type:
type: string
_key:
type: string
children:
type: array
items:
type: object
properties:
_type:
type: string
_key:
type: string
marks:
type: array
items:
type: string
text:
type: string
required:
- _type
- text
markDefs:
type: array
items:
type: object
properties:
_key:
type: string
_type:
type: string
required:
- _key
- _type
style:
type: string
listItem:
type: string
level:
type: number
required:
- _type
- children
- type: 'null'
long_description:
anyOf:
- type: string
- type: 'null'
short_description:
anyOf:
- type: string
- type: 'null'
key:
type: string
projectID:
type: string
name:
type: string
methodologies:
type: array
items:
$ref: '#/components/schemas/Methodology'
location:
description: A GeoJSON Point feature.
anyOf:
- $ref: '#/components/schemas/GeoJSONPoint'
- type: 'null'
url:
anyOf:
- type: string
- type: 'null'
vintages:
description: All available vintages for this project
type: array
items:
type: string
registry:
type: string
updatedAt:
type: number
country:
type: string
region:
type: string
price:
type: string
stats:
type: object
properties:
totalBridged:
type: number
totalRetired:
type: number
totalSupply:
type: number
totalListingsSupply:
type: number
totalPoolsSupply:
type: number
required:
- totalBridged
- totalRetired
- totalSupply
- totalListingsSupply
- totalPoolsSupply
images:
description: Various images representing a carbon project
type: array
items:
$ref: '#/components/schemas/ImageModel'
coverImage:
description: Primary cover image to be shown for a carbon project
$ref: '#/components/schemas/ImageModel'
satelliteImage:
description: Satellite image to be shown for a carbon project
$ref: '#/components/schemas/ImageModel'
hasSupply:
type: boolean
sustainableDevelopmentGoals:
description: A list of numbers representing the United Nations Sustainable Development Goals addressed by the project
type: array
items:
type: string
example:
- '2'
- '7'
- '1'
estAnnualMitigations:
type: number
developer:
type: string
assessor:
type: string
documents:
type: array
items:
type: object
properties:
url:
type: string
filename:
type: string
category:
type: string
description:
type: string
size:
type: number
mimetype:
type: string
required:
- url
- filename
- category
- description
- size
- mimetype
status:
type: string
type:
type: string
standards:
type: array
items:
description: The standards of the project
type: object
properties:
name:
type: string
link:
type: string
required:
- name
- link
required:
- key
- projectID
- name
- methodologies
- vintages
- registry
- updatedAt
- country
- region
- price
- stats
- hasSupply
- sustainableDevelopmentGoals
GeoJSONPoint:
type: object
properties:
type:
type: string
enum:
- Feature
geometry:
type: object
properties:
type:
type: string
enum:
- Point
coordinates:
minItems: 2
maxItems: 2
type: array
items:
type: number
required:
- type
- coordinates
required:
- type
- geometry
Methodology:
type: object
properties:
id:
anyOf:
- type: string
- type: 'null'
category:
anyOf:
- type: string
- type: 'null'
name:
anyOf:
- type: string
- type: 'null'
sector:
anyOf:
- type: string
- type: 'null'
externalDocs:
url: https://docs.carbonmark.com/
description: Additional documentation. The complete product and platform knowledge base for Carbonmark can be found here.