Get Started

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.

Step 1: 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:

  1. Log in to CNaught.
  2. Navigate to the Developers page.
  3. If you are a new user, you will only have access to the API sandbox. Click the Create API key button to create a sandbox key, or complete the quickstart guide (which will prompt you to enter payment information) to create a production key.

Creating an api key

warning

Save your API key somewhere safe; you will only be able to see it once. You can rotate your API key to a new one; the old one will remain valid for 24 hours.

info

Learn more about Sandbox mode

Step 2: 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.

Copy
Copied
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:

Copy
Copied
{
  "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 steps

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.