Carbonmark Retirements API
The Retirements API from Carbonmark — 5 operation(s) for retirements.
The Retirements API from Carbonmark — 5 operation(s) for retirements.
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-retirements-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 Retirements 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: Retirements
paths:
/retirements:
get:
summary: List retirements
tags:
- Retirements
description: Retrieve an array of retirements filtered by the desired query parameters.
parameters:
- schema:
pattern: ^0x(?!0{40}$)[a-fA-F0-9]{40}$
type: string
example: '0x087a7afb6975a2837453be685eb6272576c0bc'
in: query
name: beneficiaryAddress
required: false
description: Address of the retirement beneficiary
- schema:
type: number
example: '5'
in: query
name: retirementIndex
required: false
description: Retirement index
- schema:
type: string
example: '0x087a7afb6975a2837453be685eb6272576c0bc'
in: query
name: hash
required: false
description: Hash of the retirement
- schema:
type: number
in: query
name: limit
required: false
description: The maximum number of results to return. If omitted, all retirements matching the query are returned (paginated internally).
responses:
'200':
description: List of retirement
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Retirement'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
error:
type: string
operationId: getRetirements
x-operation-id-source: derived
/retirements/{id}:
get:
summary: Retirement details
tags:
- Retirements
description: Retrieve a retirement details by id
parameters:
- schema:
type: string
example: 84532-0x1ee2facc42147cc6f6cd1fcdca4e3748d2b41b089fafac46515318bbce4f633c-0
in: path
name: id
required: true
description: Id of the retirement
responses:
'200':
description: Retirement details
content:
application/json:
schema:
$ref: '#/components/schemas/Retirement'
'404':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
error:
type: string
operationId: getRetirementsById
x-operation-id-source: derived
/retirements/{beneficiaryAddress}/{retirementIndex}:
get:
summary: Retirement details
tags:
- Retirements
description: Retrieve a retirement details by beneficiary address and index
parameters:
- schema:
type: string
example: '0x087a7afb6975a2837453be685eb6272576c0bc'
in: path
name: beneficiaryAddress
required: true
description: Address of the retirement beneficiary
- schema:
type: number
example: '5'
in: path
name: retirementIndex
required: true
description: Retirement index
deprecated: true
responses:
'200':
description: Retirement details
content:
application/json:
schema:
$ref: '#/components/schemas/Retirement'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
error:
type: string
operationId: getRetirementsByBeneficiaryAddressByRetirementIndex
x-operation-id-source: derived
/retirements/{id}/certificate:
get:
summary: Certificate generation
tags:
- Retirements
description: Generates a certificate for a retirement given its id
parameters:
- schema:
type: string
example: 84532-0x1ee2facc42147cc6f6cd1fcdca4e3748d2b41b089fafac46515318bbce4f633c-0
in: path
name: id
required: true
description: Id of the retirement
deprecated: true
responses:
'200':
description: Certificate in PDF format
content:
application/pdf:
schema:
type: object
properties: {}
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
error:
type: string
operationId: getRetirementsByIdCertificate
x-operation-id-source: derived
/retirements/{beneficiaryAddress}/{retirementIndex}/status:
get:
summary: Retirement indexing status
tags:
- Retirements
description: Get a retirement indexing status given its beneficiary address and retirement index
parameters:
- schema:
type: string
example: '0x087a7afb6975a2837453be685eb6272576c0bc'
in: path
name: beneficiaryAddress
required: true
description: Address of the retirement beneficiary
- schema:
type: number
example: '5'
in: path
name: retirementIndex
required: true
description: Retirement index
responses:
'200':
description: Retirement indexing status
content:
application/json:
schema:
$ref: '#/components/schemas/RetirementIndexingStatus'
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
error:
type: string
operationId: getRetirementsByBeneficiaryAddressByRetirementIndexStatus
x-operation-id-source: derived
components:
schemas:
CarbonCreditId:
type: object
properties:
vintage:
description: Vintage of the carbon credit
type: number
projectId:
description: ID of the project associated with this credit
type: string
creditId:
description: ID of the credit
type: string
required:
- vintage
- projectId
Retirement:
type: object
properties:
id:
type: string
bridgeId:
description: ID of the bridge used to tokenize the tokens involved in the retirement
type: string
chainId:
description: ID of the chain the retirement occurred on
type: number
asyncRetireStatus:
deprecated: true
anyOf:
- type: string
enum:
- AWAITING
- type: string
enum:
- FINALIZED
- type: string
enum:
- REQUESTED
- type: string
enum:
- REVERTED
amount:
description: Amount of token retired
type: number
hash:
description: Retirement transaction hash
type: string
beneficiaryAddress:
description: Retirement beneficiary address
type: string
beneficiaryName:
description: Retirement beneficiary name
type: string
retirementMessage:
description: Retirement message
type: string
retiringAddress:
description: Address of the wallet from which the retirement transaction originated
type: string
retiringName:
description: Name of the retiring entity
type: string
timestamp:
description: Date of the retirement
type: number
token:
$ref: '#/components/schemas/Token'
creditId:
$ref: '#/components/schemas/CarbonCreditId'
index:
description: Retirement index (Unique per beneficiary)
type: number
onChainExplorerUrl:
anyOf:
- description: URL of the retirement transaction on the appropriate on-chain explorer
type: string
- type: 'null'
viewRetirementUrl:
anyOf:
- description: URL of the retirement transaction on Carbonmark
type: string
- type: 'null'
registryCertificateUrl:
anyOf:
- description: URL of the retirement certificate on the native registry, when the registry exposes one. Currently only populated for ICR retirements.
type: string
- type: 'null'
asyncRetirement:
anyOf:
- type: object
properties:
status:
description: Status of the asynchronous retirement
anyOf:
- title: AWAITING
type: string
enum:
- AWAITING
- title: FINALIZED
type: string
enum:
- FINALIZED
- title: REQUESTED
type: string
enum:
- REQUESTED
- title: REVERTED
type: string
enum:
- REVERTED
certificateUrl:
description: URL of the asynchronous retirement certificate request
type: string
required:
- status
- certificateUrl
- type: 'null'
required:
- id
- chainId
- amount
- hash
- beneficiaryAddress
- retiringAddress
- timestamp
RetirementIndexingStatus:
type: object
properties:
minted:
description: True if this retirement was minted on the blockchain
type: boolean
indexed:
description: True if this retirement was indexed by Carbonmark API indexers
type: boolean
hash:
anyOf:
- description: Transaction hash of this retirement
type: string
- type: 'null'
url:
anyOf:
- description: URL of this retirement instance. (Available only if indexed)
type: string
- type: 'null'
required:
- minted
- indexed
Token:
type: object
properties:
id:
description: Identifier of the token
type: string
address:
description: Address of the credit being sold
type: string
decimals:
description: 'The smallest divisible unit for the token '
type: number
tokenId:
anyOf:
- description: ID of the credit being sold (0 for ERC20 tokens)
type: number
- type: 'null'
tokenStandard:
description: Standard of the Token
anyOf:
- title: erc20
type: string
enum:
- erc20
- title: erc1155
type: string
enum:
- erc1155
name:
description: Name of the token.
type: string
isExAnte:
description: Ex-ante credits refer to those that are issued on the basis of predicted or expected future carbon emissions reductions or removals.
type: boolean
symbol:
description: Symbol of the token
type: string
creditTokenId:
description: Unique identifier for this token
type: string
required:
- id
- address
- decimals
- tokenStandard
- name
- isExAnte
- symbol
- creditTokenId
externalDocs:
url: https://docs.carbonmark.com/
description: Additional documentation. The complete product and platform knowledge base for Carbonmark can be found here.