API overview

​

Programmatic access

• Trading API: https://oms.tplus.cx/api-doc.json
• Market Data API: https://mds.tplus.cx/api-doc.json

​

Quickstart

pip install tpluspy

import asyncio
from tplus.client import OrderBookClient, MarketDataClient
from tplus.model.asset_identifier import AssetIdentifier
from tplus.model.limit_order import GTC
from tplus.utils.user import User

OMS = "https://oms.tplus.cx"
MDS = "https://mds.tplus.cx"
ASSET = AssetIdentifier(200)  # registry index, or "address@chain"

async def main():
    user = User(private_key="<ed25519-private-key-hex>")  # account master key
    async with (
        OrderBookClient(OMS, default_user=user) as client,  # signs + authenticates
        MarketDataClient(MDS) as md,                         # public, no auth
    ):
        book = await md.get_orderbook_snapshot(ASSET)
        market = await client.get_market(ASSET)             # decimals, tick, fees
        order = await client.create_limit_order(
            asset_id=ASSET, side="Sell", quantity=5, price=1_000,
            time_in_force=GTC(),
        )
        print(book.sequence_number, market.book_price_decimals, order.model_dump())

asyncio.run(main())

​

Authentication

1. GET /nonce/{user_id} - returns a random nonce bound to the user, valid 5 minutes.
2. Sign the nonce’s value as raw UTF-8 bytes with the Ed25519 private key.
3. POST /auth - exchange the signed nonce for a bearer token, valid 24 hours.

​

Request signatures

​

Accounts

​

Identifying assets and markets

• GET /markets - tradeable markets keyed by asset_id (price/quantity decimals, leverage, tick and min size, fees).
• GET /registry/assets - returns the cached CE asset config map for index assets. It returns 503 until the first CE snapshot; the JSON is nested by asset index and chain-address key, and each row includes the token address and deposit caps.

​

Identifiers by API surface

​

Amounts

• Settlement and withdrawal request amounts (amount, amount_in, amount_out) are hexadecimal integer strings with no 0x. 1000000 is "f4240"; the decimal-looking "1000000" is read as 0x1000000 = 16,777,216. (The OpenAPI examples render decimal-looking strings, but they are parsed as hex.)
• Transfer and simulate amounts are decimal strings (e.g. "1000000000000000000").

​

Conventions

• Pagination: zero-based page plus limit. Defaults and caps vary per endpoint; see the endpoint reference. User orders are sorted newest first by timestamp_ns, then order_id descending; user trades are sorted newest first by timestamp_ns, then trade_id descending; positions are sorted by sub_account_index, then asset_id; funding history is sorted by timestamp_ns descending with no secondary tie-breaker defined today.
• Rate limits return HTTP 429 with code RATE_LIMITED and retryable: true. OMS currently does not attach Retry-After or rate-limit reset headers.
• Client deadlines: use more than 5 seconds for orderbook/clearing-engine proxy writes such as orders, withdrawals, and settlements; use more than 15 seconds for GET /withdrawal/queue/{user_id}. For pure OMS reads, pick a shorter deadline that fits your latency budget and retry policy.
• Per-asset risk parameters: GET /registry/risk-parameters; vault addresses: GET /registry/vaults.
• Three independent nonce families, never interchangeable: session-auth - the value from GET /nonce/{user_id}, signed and exchanged at POST /auth; chain actions (deposits, withdrawals, settlements) - independent per user, per chain, and per action type, read from the onchain vault counters; multisig config - config_nonce, returned as ce_nonce by GET /nonce/{user_id} and bumped on each successful /multisig/* change.
• Order-level rules (ID format, batch limits, cancel semantics) are in Orders.
• Deprecation/versioning: GET /margin/user/{user_id} currently returns Deprecation: true. Tplus does not currently publish a formal API versioning or deprecation policy.

​

Errors

{
  "error": {
    "code": "INSUFFICIENT_MARGIN",
    "message": "...",
    "retryable": false,
    "details": { "...": "..." },
    "trace_id": "...",
    "span_id": "..."
  }
}

​

Finality

​

SDKs