Carbonmark REST API
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
##
Endpoints 47
Activities
- GETList marketplace activities
/activitiesRetrieve listing and sale activities from the Polygon and Base marketplaces, newest first. Each activity carries the chainId it occurred on.
Developers
- GETList developers
/developersRetrieve the list of developers
Holdings
- GETUser Holdings
/holdings?addresses=0x71C7656EC7ab88b098defB751B7401B5f6d8976FGet holdings for one or more wallet addresses - GETUser Holdings
/holdings/:addressGet holdings for a specific wallet address
Info
- GETGet API Information
/infoGet API Information
Listings
- GETList listings
/listingsRetrieve an array of listings filtered by desired query parameters
Orders
- GETOrder list
/ordersGet a list of retirement orders optionally filtered by id - POSTCreate order
/ordersConsume a Quote and convert it into an Order. Creates a retirement at the quoted price and quantity. - GETOrder details
/orders/:idGet a retirement order details by ID
Prices
- GETList asset prices
/pricesRetrieve a list of listing prices created by sellers.
Quotes
- POSTRequest a retirement quote
/quotesRequest a retirement quote from a seller listing.
Retirements
- GETList retirements
/retirementsRetrieve an array of retirements filtered by the desired query parameters. - GETRetirement details
/retirements/:idRetrieve a retirement details by id - GETRetirement details
/retirements/:beneficiaryAddress/:retirementIndexDeprecated. Retrieve a retirement details by beneficiary address and index - GETCertificate generation
/retirements/:id/certificateDeprecated. Generates a certificate for a retirement given its id - GETRetirement indexing status
/retirements/:beneficiaryAddress/:retirementIndex/statusGet a retirement indexing status given its beneficiary address and retirement index
Teams
- GETList teams
/teamsList teams - GETTeam details
/teams/:idGet the team details by ID - PUTUpdate a user's team
/teams/:idThis endpoint allows a user to update their team information. The user must be logged in to access this endpoint. The user must also be a member of the team… - GETTeam billing configuration
/teams/:id/billingRead the billing configuration for a team owned by the authenticated user. Requires a user session; API keys are not supported. - GETSearch owner order history
/teams/:id/orders - PUTRequest a challenge related to the teams PIN
/teams/:id/pinThis endpoint allows a user to change or restore their team's PIN information. The user must be logged in to access this endpoint. The user must also be a… - GETProduction key creation access
/teams/:id/apiCredentials/access - GETRead team key usage
/teams/:id/apiCredentials/usage - PUTUpdate prepaid business details
/teams/:id/billing/business-details - POSTChoose team billing
/teams/:id/billing/enrollRecord the billing choice for a new API client. New accounts remain pending; this does not accept terms, credit payments or enable production keys. Repeating… - PUTComplete prepaid business setup
/teams/:id/billing/setupSave an immutable business snapshot with temporary server-defaulted confirmations and compliance clearance. These defaults do not prove customer consent or… - GETRead the latest prepaid limit request or recover its creation key
/teams/:id/prepaid/limit-requests - POSTRequest higher prepaid limits
/teams/:id/prepaid/limit-requests - GETList API credit top-ups
/teams/:id/prepaid/top-ups - GETRead an API credit top-up
/teams/:id/prepaid/top-ups/:topUpId
Wallets
- POSTCreate a team wallet
/wallets?team=79875d4d-4b7c-4b72-99e5-19955172d7d1 - GETGet a wallet information
/wallets/:uuid - GETGet wallet allowances for the given holdings
/wallets/:uuid/allowances?tokenIdentifier=137-ERC20-0x314c0a010e148f1e1286f96f78ed366255267d54&spenderAddress=0x8cE54d9625371fb2a068986d32C85De8E6e995f8 - GETGet a wallet transaction by id
/wallets/:uuid/transactions?refId=d6ef5152-75ab-5a1d-9c2d-54b66251395c - POSTCreate a transaction challenge
/wallets/:uuid/transactions
Assessors
- GETList assessors
/assessorsRetrieve the list of assessors
CarbonProjects
- GETList projects
/carbonProjectsRetrieve an array of carbon projects filtered by desired query parameters - GETProject details
/carbonProjects/:idRetrieve a carbon project by its project ID
Listing
- GETListings
/listings/:idGet a listing by its identifier
Users
- GETConnected user
/users/meGet connected user
Records
- GETRetirement provenance records
/retirements/:id/provenanceRetrieve a retirement provenance records
- GETCategories
/categoriesA list of all methodology categories used to delineate every project in the marketplace. A project may belong to one or more of these categories. - GETCountries
/countriesRetrieve an array containing the countries that carbon projects originate from - GETRecent purchases
/purchasesRetrieve a list of recent purchases - GETVintages
/vintagesRetrieve an array of the vintages of available carbon projects - GETPurchase details
/purchases/:idRetrieve the details of a purchase by its ID (transaction hash)
API details
- Base URL
https://v20.api.carbonmark.com- Authentication
- None declared in the description
- Operations
- 47 operations on 43 pathsGET 37POST 6PUT 4
2 marked deprecated - Main resources
- Teams 15Retirements 5Wallets 5Orders 3CarbonProjects 2Holdings 2Activities 1Assessors 1Developers 1Info 1
- Response formats
application/jsonapplication/pdf- Description format
- OpenAPI 3.1.0, API version
v20 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- Carbonmark's published OpenAPI description
How to test the Carbonmark REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Carbonmark REST API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List marketplace activities” (GET /activities), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Carbonmark REST API?
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… It is listed under Maps & location and has 47 endpoints.
Who publishes the Carbonmark REST API?
It is listed from Carbonmark's public API description (an OpenAPI document), not published by Carbonmark on Swastik Codes. Anyone who controls carbonmark.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Carbonmark REST API?
Requests go to https://v20.api.carbonmark.com. Endpoint paths are added to this base URL.
How do I authenticate with the Carbonmark REST API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Carbonmark REST API have?
47 operations on 43 paths (37 GET, 6 POST, 4 PUT). The largest groups are Teams, Retirements, Wallets, Orders.
Is forking the Carbonmark REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.