> ## Documentation Index
> Fetch the complete documentation index at: https://docs.carboncopy.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Interactive documentation for all Carboncopy API endpoints. Try requests directly in your browser.

## Overview

The Carboncopy API follows REST conventions. All endpoints:

* Accept and return **JSON**
* Use **Bearer token** authentication (API key or Privy JWT)
* Return consistent [error envelopes](/errors)
* Include [rate limit headers](/rate-limits) on every response

**Base URL:** `https://carboncopy.inc`\
**Version:** `v1` (prefix: `/api/v1`)

***

## Endpoint groups

| Group                                                 | Description                                      |
| ----------------------------------------------------- | ------------------------------------------------ |
| [Health](/api-reference/openapi/getHealth)            | Unauthenticated health check                     |
| [Portfolio](/api-reference/openapi/getPortfolio)      | Portfolio summary, trade history, open positions |
| [Traders](/api-reference/openapi/listTraders)         | Follow, configure, and manage copied traders     |
| [Orders](/api-reference/openapi/listOrders)           | Inspect orders placed by your copy-trading bot   |
| [Account](/api-reference/openapi/getAccount)          | Your Carboncopy account info                     |
| [Key Management](/api-reference/openapi/createApiKey) | Create and revoke API keys (Privy JWT required)  |

***

## Authentication in the explorer

To try authenticated endpoints in the interactive explorer:

1. Click **Authorize** at the top of any endpoint
2. Enter your API key as: `cc_your_key_here` (no `Bearer ` prefix — the explorer adds it)
3. For Key Management endpoints, enter your Privy JWT instead

Don't have a key? See the [Quickstart](/quickstart) to create one.

***

## OpenAPI spec

The full OpenAPI 3.1 spec is available at:

```
https://carboncopy.inc/api-reference/openapi.json
```

You can import this into [Postman](https://postman.com), [Insomnia](https://insomnia.rest), or any OpenAPI-compatible tool.