Skip to content

Quick Start Guide

Get up and running with TokenBot in under 5 minutes.


TokenBot is currently early access — there is no self-serve signup. Join the waitlist at site.tokenbot.com; you’ll be told when your account is ready.

You need an account before the CLI is useful: tokenbot init binds a key to an existing account, it does not create one.

TokenBot is CLI-first — there is no web dashboard. Requires Node.js 22+:

Terminal window
npm install -g tokenbot

Step 3: Register your CLI identity (1 minute)

Section titled “Step 3: Register your CLI identity (1 minute)”
Terminal window
tokenbot init --label "my laptop"
tokenbot whoami

init generates a secp256k1 keypair, encrypts it under a passphrase you choose, and registers the public key against your account. Every later request is signed with that key — no API key, no password sent anywhere. whoami confirms it worked.

First, at your exchange (e.g. Binance), create an API key:

  • Enable: read + trade permissions
  • Disable: withdrawal permissions — do this every time, without exception

Then pick the path that matches what you want:

Terminal window
# Server-side: TokenBot can trade for you (needed for copy trading)
tokenbot exchange add --exchange binance --account-name "main" --trading-type spot
Terminal window
# Local-only: credentials never leave your machine; used by `tokenbot balance`
tokenbot keys add --exchange binance --strategy strat_9f

These are deliberately separate. exchange add uploads credentials to the server so the platform can act on your behalf; keys add stores them encrypted in ~/.tokenbot/keys.json and never transmits them. See Exchange Accounts.

A Copier follows a Strategy:

Terminal window
# See the strategies available to follow
tokenbot strategy list
# Create a copier against one, allocating 25% of your exchange account
tokenbot copier add --strategy strat_9f --exchange-account-id exa_71 --name "btc follow" --allocation 25
# Confirm the binding
tokenbot links list

When the strategy you follow fills a trade, TokenBot detects the fill on the leader’s exchange account and fans it out to your copiers.

Terminal window
tokenbot trades

Send real-time trade notifications to any HTTPS endpoint — Discord bots, Telegram alerts, or your own systems:

Terminal window
tokenbot webhooks add --url https://example.com/hooks/tokenbot --events trade.filled
tokenbot webhooks test <id>

See Webhooks → for details.


Prefer working from the command line or building integrations? TokenBot has you covered.

Requires Node.js 22+. The user CLI is published to public npm as tokenbot (unscoped):

Terminal window
npm install -g tokenbot
tokenbot init --label "my laptop"
tokenbot whoami

init generates an encrypted identity keypair and registers it. You are not asked for an API key — the CLI signs every request with your private key, which never leaves your machine.

See CLI Installation → for full setup instructions.

The SDK is a TypeScript package on GitHub Packages. It authenticates with the same signed-request identity the CLI uses, not an API-key string:

Terminal window
npm install @tokenbot-org/sdk @tokenbot-org/cli-core
import { SignedHttpClient, unlockIdentity } from '@tokenbot-org/cli-core';
import { TokenbotSdk } from '@tokenbot-org/sdk';
const privateKey = unlockIdentity(encryptedKey, salt, passphrase);
const http = new SignedHttpClient({ apiUrl: 'https://api.tokenbot.com', publicKey, privateKey });
const sdk = new TokenbotSdk({
http,
graphqlUrl: 'https://gql-api.tokenbot.com/graphql',
wsUrl: 'wss://gql-api.tokenbot.com/graphql', // only needed for *Watch subscriptions
});
const strategies = await sdk.strategies.list();

There is no Python SDK. The standalone Python and Node SDK repositories were retired on 2026-06-28; @tokenbot-org/sdk is the only supported client library.

See SDK Overview → for full documentation.