Skip to main content
This page covers everything you need to get tpluspy running on your machine: Python version requirements, the two install tiers, how to verify the installation, the environment variables that control client and CLI behaviour, and where the SDK stores local files.

​
Requirements

tpluspy requires Python 3.10 or newer. No other system-level dependencies are needed for the core install.

​
Install tiers

tpluspy ships two distinct install profiles. Choose based on what you need to do.

​
Core install

The core install includes:
  • Async REST and WebSocket clients (OrderBookClient, MarketDataClient, ClearingEngineClient)
  • Pydantic v2 wire-protocol models
  • Ed25519 user-key signing and local keyfile management
  • The tplus CLI tool
Use the core install whenever your work only involves talking to a running T+ service—placing orders, reading market data, streaming trades, or signing requests with your T+ key. ape, eth-ape, ape-tokens, and hexbytes are not installed; any import from tplus.evm will raise ModuleNotFoundError until you upgrade to the EVM install.

​
EVM install

The EVM install adds the Ape framework (eth-ape), hexbytes, and structured-message signing helpers on top of the core install. You need this tier when your code:
  • Imports anything from tplus.evm
  • Reads or writes vault or registry contracts
  • Initiates or executes on-chain deposits, withdrawals, or settlements
  • Needs an Ethereum account for signing settlement messages
pip install tpluspy
Never import ape, eth-ape, or hexbytes from code that is also used in a core-install environment. These symbols are absent from the core tier and cause ImportError at runtime.

​
Verify the installation

After installing, confirm the CLI is on your PATH and the version is visible: 
tplus --help
To check which environment variables are currently set, run: 
tplus env
tplus env prints every CLI-relevant variable alongside its current value, making it easy to confirm your configuration before placing orders or connecting to streams.

​
Environment variables

All environment variables can also be passed as flags on any tplus command; the table below shows both forms.
VariableCLI flagDescription
TPLUS_ACCOUNT--accountDefault local account alias used by signing, OMS, and settlement commands.
TPLUS_ORDERBOOK_BASE_URL--orderbook-base-urlBase URL of the orderbook / OMS service. Also used by settle and withdraw commands.
TPLUS_CLEARING_BASE_URL--clearing-base-urlBase URL of the clearing engine. Used by admin, registry, and vault commands.
TPLUS_MARKET_DATA_BASE_URL--market-data-base-urlBase URL of the market-data service. Used by markets depth, markets klines, and the stream subcommands.
TPLUS_IGNORE_SSL--ignore-sslSet to any non-empty value to skip TLS certificate verification. Use only for local development with self-signed certificates.
TPLUS_OUTPUT_FORMAT--output-formatOutput format for list and address commands: table (default), json, or raw. raw prints one chain-address string per line, useful for piping into scripts.
TPLUS_PASSWORD—Password used to encrypt and decrypt local keyfiles, bypassing the interactive getpass prompt. Intended for automation; avoid in shared shells.
A minimal shell profile for local development might look like: 
export TPLUS_ACCOUNT=alice
export TPLUS_ORDERBOOK_BASE_URL=http://127.0.0.1:8000
export TPLUS_CLEARING_BASE_URL=http://127.0.0.1:3032
export TPLUS_MARKET_DATA_BASE_URL=http://127.0.0.1:8011
export TPLUS_IGNORE_SSL=1

​
Local file locations

PathContents
~/.tplus/users/Password-encrypted Ed25519 keyfiles, one per account alias.
~/.tplus/cli/logs/tplus.logRotating CLI log (1 MB × 3 files).
To inspect or back up a specific account, look for its keyfile at ~/.tplus/users/<alias>. Never share these files—each one contains your encrypted private key.

​
Using the CLI after install

Once installed, the tplus command gives you access to the full command tree from your shell. Common first steps: 
# See all available commands
tplus --help

# Confirm environment variable configuration
tplus env

# Generate a new local account
tplus accounts generate alice

# List your accounts
tplus accounts list
See the CLI overview for a complete reference of every subcommand and its options.