First Python client

This first-run path is read-only plus simulation. It does not place live orders or send onchain transactions. Production URLs:

OMS: https://oms.tplus.cx
MDS: https://mds.tplus.cx
OMS WebSocket base: wss://oms.tplus.cx
MDS WebSocket base: wss://mds.tplus.cx

Install

pip install tpluspy

Use the optional EVM extra only when you need onchain deposit, withdrawal, or settlement helpers:

pip install "tpluspy[evm]"

Create a local user

“Create user” means local Ed25519 key generation. There is no registration call. The first server-side account state is created by the first onchain deposit.

from tplus.utils.user import User

user = User()  # local throwaway Ed25519 keypair
print(user.public_key)

Use EVM accounts as Tplus accounts

An EVM account can back a Tplus account: it signs one fixed message and the Tplus identity is derived from that signature, so the same wallet always maps to the same Tplus account, the one the Tplus frontend derives when that wallet logs in. Pass the account itself anywhere a user is accepted, whether that is default_user=, a per-call user=, or a signer=:

from ape import accounts

from tplus.client import OrderBookClient

account = accounts.load("me")  # needs the `evm` extra

async with OrderBookClient(BASE_URL, default_user=account) as client:
    await client.get_user_inventory()  # signs as the Tplus user behind the account

An eth_account signer works the same way, with no extra install:

from eth_account import Account

client = OrderBookClient(BASE_URL, default_user=Account.from_key("0x..."))

Use load_user_from_ape_account to hold the user itself. load_user loads stored keyfiles by name, so Ape aliases and keyfile names occupy separate namespaces and cannot collide:

from tplus.utils.user import load_user_from_ape_account

user = load_user_from_ape_account("me")
print(user.public_key, user.evm_address)

The result is a normal Tplus user and signs every request the same way.

Authenticate and read

import httpx

from tplus.client import OrderBookClient
from tplus.model.asset_identifier import AssetIdentifier
from tplus.model.orderbook import OrderBook

OMS = "https://oms.tplus.cx"
MDS = "https://mds.tplus.cx"

async with OrderBookClient(OMS, default_user=user) as oms:
    asset = AssetIdentifier(200)
    market = await oms.get_market(asset)

async with httpx.AsyncClient(base_url=MDS) as mds:
    depth_response = await mds.get(f"/marketdepth/{asset}")
    depth_response.raise_for_status()
    depth = OrderBook(**depth_response.json())

Raw auth is the same handshake:

# sign_nonce.py
import json
import sys

from tplus.utils.user import User

user = User(private_key="<ed25519-private-key-hex>")
print(json.dumps(list(user.sign(sys.argv[1]))))

NONCE=$(curl -s https://oms.tplus.cx/nonce/$USER_ID | python3 -c 'import json,sys; print(json.load(sys.stdin)["value"])')
SIGNATURE=$(python3 sign_nonce.py "$NONCE")
curl -X POST https://oms.tplus.cx/auth \
  -H "Content-Type: application/json" \
  --data '{"user_id":"'$USER_ID'","nonce":"'$NONCE'","signature":'$SIGNATURE'}'

Safe simulation

payload = {
    "sub_account": 1,
    "trade": {
        "asset": "200",
        "is_buy": True,
        "size": "1.0",
        "limit_price": "2500.0",
        "trade_type": "margin",
    },
    "pending_transfers": [],
}
result = await oms._request("POST", f"/account/simulate/{user.public_key}", json_data=payload)
print(result["is_solvent"], result["available_margin"])

Raw:

curl -X POST https://oms.tplus.cx/account/simulate/$USER_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "User-Id: $USER_ID" \
  -H "Content-Type: application/json" \
  --data '{"sub_account":1,"trade":{"asset":"200","is_buy":true,"size":"1.0","limit_price":"2500.0","trade_type":"margin"},"pending_transfers":[]}'

Getting Started

Integration guides

Install

Create a local user

Use EVM accounts as Tplus accounts

Authenticate and read

Safe simulation

​Install

​Create a local user

​Use EVM accounts as Tplus accounts

​Authenticate and read

​Safe simulation

Install

Create a local user

Use EVM accounts as Tplus accounts

Authenticate and read

Safe simulation