Documentation
Everything you need to integrate Atmosverde into your platform. Guides, references, and examples.
Documentation by topic
Find guides and references for every aspect of the platform.
Getting Started
Get your API key, make your first purchase call, and receive a blockchain-verified proof -- in under five minutes.
API Reference
Interactive API explorer for all endpoints: purchases, certificates, emissions estimates, proofs, and more.
ExploreWidget SDK
Three integration options: Custom Element, script tag, or @atmosverde/widget npm package. Emission-based, works in any framework.
ExploreWebhooks
Securely authenticated event notifications for proof generation, certificate retirement, and purchase completion events.
ExploreAuthentication
API key management, enterprise SSO, duplicate-safe requests, and rate limiting configuration.
ExploreError Codes
Standardized error handling. Clear error codes with troubleshooting steps for every response.
ExploreStart with an API call
Retire carbon credits with a single API request. Our SDKs handle authentication, retries, and error handling.
import { Atmosverde } from '@atmosverde/sdk';
const client = new Atmosverde({
apiKey: process.env.ATMOSVERDE_API_KEY
});
const retirement = await client.retirements.create({
tonnes: 2.5,
projectType: 'reforestation',
metadata: {
orderId: 'ORD-12345',
customer: 'customer@example.com'
}
});
console.log(retirement.certificateUrl);Need help?
Our team is available to help you integrate and troubleshoot.
Need help with your integration?
Our team is here to help you get started.