Quickstart
This short tutorial will teach you the basics of making requests to the CNaught APIs.
Assumptions
This tutorial assumes that you have a CNaught account. If not, sign up for a free account.
Steps
Get your API Key
The first step is to generate an API key, which will allow you access to the CNaught APIs. Follow these steps:
- Log in to CNaught.
- Navigate to the Developers page.
- Click the Create sandbox API key button to create a sandbox key, or click Set up API to create a production key (which will require you to set up a payment method).
Place an order
Submit a credits order. Replace the <CNAUGHT_API_KEY>
placeholder with the API key obtained in Step 1, and specify the amount of carbon credits (in kg of CO2e) you wish to purchase.
curl -X POST "https://api.cnaught.com/v1/orders" \
-H "Authorization: Bearer <CNAUGHT_API_KEY>" \
-H "Content-Type: application/json" \
-d '{"amount_kg": 10, \"metadata\": \"This is a test\"}'
You’ll receive a response like this:
{
"id": "Umx5c6F7pH7r",
"created_on": "2021-09-15T05:14:38.13",
"metadata": "This is a test",
"amount": 10
}
The id
(in this case Umx5c6F7pH7r
) will allow you to retrieve your order.
Next
You should now have a basic idea of how to use the CNaught APIs. To learn more, read the API documentation for complete details on the API and its features.