For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

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

Version

/v1/version

CLI identity

/v1/auth/cli-challenge, /v1/auth/cli-identity

Me

/v1/me

Exchanges

/v1/exchanges

Supported Exchanges

/v1/supported-exchanges

Strategies

/v1/strategies

Copiers

/v1/copiers

Trades

/v1/trades

Trade Pairs

/v1/trade-pairs

Notifications

/v1/notifications

Settings

/v1/settings

Rewards

/v1/rewards

Withdrawals

/v1/withdrawals

API Keys

/v1/api-keys

Webhooks

/v1/webhooks

Removed: Bot Service Proxies

The /v1/trading-bot/* and /v1/market-maker/* proxy namespaces have been removed (rest-api #121). They forwarded to dashboard-era bot HTTP surfaces that were never wired up in any deployed environment — every call returned 503 — and those bot-side APIs are gone too (trading-bot #121, market-maker-bot #132). The embedded operator CLIs (tokenbot-trading, tokenbot-mm) now talk to the platform APIs directly: this REST API plus GraphQL at gql-api.tokenbot.com, with real-time data over the tradeSignal and orderbookUpdate subscriptions. Remote bot control (pause / emergency-stop) returns in a future signed control-plane wave.

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.

Last updated

Was this helpful?