> For the complete documentation index, see [llms.txt](https://docs.tokenbot.com/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tokenbot.com/home/api-docs/rest-api/overview.md).

# Overview

## Base URL

| Environment | URL                               |
| ----------- | --------------------------------- |
| Production  | `https://api.tokenbot.com/v1`     |
| Development | `https://api-dev.tokenbot.com/v1` |

Endpoints are also reachable without the `/v1` prefix as legacy aliases, but new integrations should use `/v1`.

## Authentication

Most endpoints require authentication. The primary method is an **API key** via the `X-API-Key` header (or `Authorization: Bearer <key>`). The `tokenbot` CLI uses **signed requests** as a fast-path. See [Authentication](/home/api-docs/authentication.md).

A handful of endpoints are public (no auth): `GET /v1/health`, `GET /v1/health/detailed`, `GET /v1/version`, and `GET /v1/auth/cli-challenge`.

## Pagination

List endpoints support pagination:

| Parameter | Type    | Default | Description              |
| --------- | ------- | ------- | ------------------------ |
| `limit`   | integer | 20      | Items per page (max 100) |
| `offset`  | integer | 0       | Number of items to skip  |

## Sorting

| Parameter | Type   | Description      |
| --------- | ------ | ---------------- |
| `sort`    | string | Field to sort by |
| `order`   | string | `asc` or `desc`  |

## Endpoints

| Resource            | Path                                              | Documentation                                                            |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------ |
| Health              | `/v1/health`, `/v1/health/detailed`               | [health](#health)                                                        |
| Version             | `/v1/version`                                     | —                                                                        |
| CLI identity        | `/v1/auth/cli-challenge`, `/v1/auth/cli-identity` | —                                                                        |
| Me                  | `/v1/me`                                          | [me](#me)                                                                |
| Exchanges           | `/v1/exchanges`                                   | [exchanges.md](/home/api-docs/rest-api/exchanges.md)                     |
| Supported Exchanges | `/v1/supported-exchanges`                         | [supported-exchanges.md](/home/api-docs/rest-api/supported-exchanges.md) |
| Strategies          | `/v1/strategies`                                  | [strategies.md](/home/api-docs/rest-api/strategies.md)                   |
| Copiers             | `/v1/copiers`                                     | [copiers.md](/home/api-docs/rest-api/copiers.md)                         |
| Trades              | `/v1/trades`                                      | [trades.md](/home/api-docs/rest-api/trades.md)                           |
| Trade Pairs         | `/v1/trade-pairs`                                 | [trade-pairs.md](/home/api-docs/rest-api/trade-pairs.md)                 |
| Notifications       | `/v1/notifications`                               | [notifications.md](/home/api-docs/rest-api/notifications.md)             |
| Settings            | `/v1/settings`                                    | [settings.md](/home/api-docs/rest-api/settings.md)                       |
| Rewards             | `/v1/rewards`                                     | [rewards.md](/home/api-docs/rest-api/rewards.md)                         |
| Withdrawals         | `/v1/withdrawals`                                 | [withdrawals.md](/home/api-docs/rest-api/withdrawals.md)                 |
| API Keys            | `/v1/api-keys`                                    | [api-keys.md](/home/api-docs/rest-api/api-keys.md)                       |
| Webhooks            | `/v1/webhooks`                                    | [webhooks](/home/api-docs/webhooks/management.md)                        |

### Service Proxies

These paths proxy to the bot services and require an API key scoped to the matching product:

| Path                     | Product scope  |
| ------------------------ | -------------- |
| `ALL /v1/trading-bot/*`  | `TRADING_BOT`  |
| `ALL /v1/market-maker/*` | `MARKET_MAKER` |

## Health

### `GET /v1/health`

Basic health check (public).

### `GET /v1/health/detailed`

Detailed health check with service status (public).

## Me

### `GET /v1/me`

Returns the authenticated user's profile.

```bash
curl https://api.tokenbot.com/v1/me \
  -H "X-API-Key: tb_live_your_key"
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.tokenbot.com/home/api-docs/rest-api/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.