Carbonmark Quotes API
The Quotes API from Carbonmark — 1 operation(s) for quotes.
The Quotes API from Carbonmark — 1 operation(s) for quotes.
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-quotes-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 Quotes 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: Quotes
paths:
/quotes:
post:
summary: Request a retirement quote
tags:
- Quotes
description: Request a retirement quote from a seller listing.
requestBody:
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
asset_price_source_id:
description: ID of the asset price returned by the `/prices` resource
type: string
pattern: carbon_pool-(137|8453)-0x\w{40}-\d+-(ubo|nbo|bct|nct|mco2|cco2)$|listing-(137|8453)-0x\w{64}$|product-(137|8453)-(mco2|cco2)|klimaprotocol-(137|8453)-0x\w{40}-0x\w{40}-\d+
example: listing-137-0x12dbdff6fa065abc002324b5f2c1546b06e0440b1906438669a492e1987690f4
quantity_tonnes:
description: Number of tonnes to retire
type: number
example: 15
required:
- asset_price_source_id
- quantity_tonnes
example:
asset_price_source_id: listing-137-0x886289a280cd265093215ff2893c29ff24c1381e830f63b0c71a335a7f15b362
quantity_tonnes: 1
required: true
parameters:
- schema:
type: string
example: Bearer cm_api_d286bc5a-9980-43b7-9507-7fc013fecca8
in: header
name: Authorization
required: true
description: Bearer token
responses:
'200':
description: Default Response
content:
application/json:
schema:
$ref: '#/components/schemas/Quote'
examples:
Retire from Seller Listing Order:
value:
asset_price_source_id: listing-137-0x12dbdff6fa065abc002324b5f2c1546b06e0440b1906438669a492e1987690f4
uuid: 07495f6c-8b02-465d-8fdd-4bcc2d2047e9
created_at: '2024-03-25T22:01:23.236141+00:00'
updated_at: '2024-03-25T22:01:23.236141+00:00'
credential_id: 93
quantity_tonnes: 1
cost_usdc: 0.5
consumed: 0
'400':
description: Default Response
content:
application/json:
schema:
anyOf:
- type: object
properties:
error:
type: string
code:
type: string
recovery:
type: object
properties:
action:
anyOf:
- type: string
enum:
- top_up
- type: string
enum:
- contact_sales
- type: string
enum:
- contact_support
- type: string
enum:
- retry
limit:
type: number
remaining:
type: number
used:
type: number
window_hours:
type: number
requested_amount:
type: number
available_balance:
type: number
next_available_at:
anyOf:
- type: string
- type: 'null'
required:
- action
required:
- error
- type: object
properties:
message:
type: string
name:
type: string
required:
- message
- name
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'402':
description: Default Response
content:
application/json:
schema:
anyOf:
- type: object
properties:
error:
type: string
code:
type: string
recovery:
type: object
properties:
action:
anyOf:
- type: string
enum:
- top_up
- type: string
enum:
- contact_sales
- type: string
enum:
- contact_support
- type: string
enum:
- retry
limit:
type: number
remaining:
type: number
used:
type: number
window_hours:
type: number
requested_amount:
type: number
available_balance:
type: number
next_available_at:
anyOf:
- type: string
- type: 'null'
required:
- action
required:
- error
- type: object
properties:
message:
type: string
name:
type: string
required:
- message
- name
'403':
description: Default Response
content:
application/json:
schema:
anyOf:
- type: object
properties:
error:
type: string
code:
type: string
recovery:
type: object
properties:
action:
anyOf:
- type: string
enum:
- top_up
- type: string
enum:
- contact_sales
- type: string
enum:
- contact_support
- type: string
enum:
- retry
limit:
type: number
remaining:
type: number
used:
type: number
window_hours:
type: number
requested_amount:
type: number
available_balance:
type: number
next_available_at:
anyOf:
- type: string
- type: 'null'
required:
- action
required:
- error
- type: object
properties:
message:
type: string
name:
type: string
required:
- message
- name
'409':
description: Default Response
content:
application/json:
schema:
anyOf:
- type: object
properties:
error:
type: string
code:
type: string
recovery:
type: object
properties:
action:
anyOf:
- type: string
enum:
- top_up
- type: string
enum:
- contact_sales
- type: string
enum:
- contact_support
- type: string
enum:
- retry
limit:
type: number
remaining:
type: number
used:
type: number
window_hours:
type: number
requested_amount:
type: number
available_balance:
type: number
next_available_at:
anyOf:
- type: string
- type: 'null'
required:
- action
required:
- error
- type: object
properties:
message:
type: string
name:
type: string
required:
- message
- name
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
error:
type: string
'503':
description: Default Response
content:
application/json:
schema:
anyOf:
- type: object
properties:
error:
type: string
code:
type: string
recovery:
type: object
properties:
action:
anyOf:
- type: string
enum:
- top_up
- type: string
enum:
- contact_sales
- type: string
enum:
- contact_support
- type: string
enum:
- retry
limit:
type: number
remaining:
type: number
used:
type: number
window_hours:
type: number
requested_amount:
type: number
available_balance:
type: number
next_available_at:
anyOf:
- type: string
- type: 'null'
required:
- action
required:
- error
- type: object
properties:
message:
type: string
name:
type: string
required:
- message
- name
operationId: postQuotes
x-operation-id-source: derived
components:
schemas:
Quote:
type: object
properties:
uuid:
description: Reference of the quote. use this in the `POST /orders` endpoint if you want to create an order from this quote.
type: string
created_at:
type: string
updated_at:
type: string
credential_id:
description: ID of the credentials used to create this quote.
type: number
asset_price_source_id:
description: ID of the asset price source.
type: string
example: listing-137-0x886289a280cd265093215ff2893c29ff24c1381e830f63b0c71a335a7f15b362
quantity_tonnes:
description: Number of tonnes quoted.
type: number
cost_usdc:
description: Amount in USD which will be invoiced if this quote is converted to an order.
type: number
consumed:
description: Equals 1 if this quote was used to create an order, 0 otherwise. A consumed quote can no longer be used to create an order.
type: number
required:
- uuid
- created_at
- updated_at
- credential_id
- asset_price_source_id
- quantity_tonnes
- cost_usdc
- consumed
externalDocs:
url: https://docs.carbonmark.com/
description: Additional documentation. The complete product and platform knowledge base for Carbonmark can be found here.