Skip to main content

Python SDK for the True Markets public API.

Project description

truemarkets

Python SDK for the True Markets public API.

Install

pip install truemarkets

Requires Python 3.10+.

Quickstart

Set TM_KEY_FILE (and optionally TM_ENV=prod) in a .env file or your shell environment:

# .env
TM_ENV=prod
TM_KEY_FILE=/path/to/truemarkets-api-key-XXXXXXXX.json

Then call any operation on c.gateway or c.defi. Methods are generated from the OpenAPI spec and named after the spec's operationIds, so the full surface is discoverable via dir(c.gateway):

from truemarkets import Client
from truemarkets._generated.gateway.models import (
    OrderSide,
    QuoteRequest,
    QuoteRequestQtyUnit,
)

with Client() as c:
    q = c.gateway.compute_quote(body=QuoteRequest(
        base_asset="BTC", quote_asset="USDC",
        qty="25", qty_unit=QuoteRequestQtyUnit.QUOTE, side=OrderSide.BUY,
    ))

print(f"{q.qty} BTC @ {q.price} USDC/BTC")

Client() auto-loads .env from the current working directory (walking up).

API surface

  • c.gateway.<operation_id>compute_quote, create_order, execute_order, cancel_order, get_order_status, list_orders, create_transfer, execute_transfer, list_transfers, get_transfer, list_assets, list_balances, get_balances.
  • c.defi.<operation_id>get_assets, get_asset_by_chain_and_address, get_balances, get_history, get_profile, create_quote, execute_trade, prepare_transfer, execute_transfer, create_wallet, prepare_wallet_export, execute_wallet_export, get_watchlists, get_watchlist_by_id.
  • c.sign_turnkey(payload) — stamp a Turnkey activity payload with the cached API key.
  • truemarkets.auth.{load_key_file, mint_token, refresh_token, sign_challenge, turnkey_stamp} — low-level helpers.

Models live under truemarkets._generated.{gateway,defi,authapi}.models. Operations return the parsed response model directly.

DeFi trades

DeFi orders return Turnkey activity payloads that the SDK signs locally with your API key:

from truemarkets import Client
from truemarkets._generated.gateway.models import (
    Chain,
    CreateOrderRequest,
    CreateOrderRequestQtyUnit,
    ExecuteOrderRequest,
    OrderSide,
    OrderType,
    SigningMethod,
)

with Client() as c:
    order = c.gateway.create_order(body=CreateOrderRequest(
        base_asset="0xbaa5...",      # MORPHO
        quote_asset="0x8335...",     # USDC
        qty="0.5", qty_unit=CreateOrderRequestQtyUnit.BASE,
        side=OrderSide.SELL, type_=OrderType.MARKET, chain=Chain.BASE,
    ))
    stamps = [c.sign_turnkey(p.payload) for p in (order.payloads or [])]
    c.gateway.execute_order(
        id=order.order_id,
        body=ExecuteOrderRequest(signatures=stamps, auth_type=SigningMethod.API_KEY),
    )

See examples/gateway/ for runnable scripts.

Development

python3.12 -m venv .venv
.venv/bin/pip install -e ".[dev]"
.venv/bin/pytest

Regenerating the client from upstream specs is a top-level make target:

make codegen   # filter specs → regenerate gateway, defi, authapi

License

MIT — see LICENSE. Changelog at the repo root.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

truemarkets-0.1.0.tar.gz (56.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

truemarkets-0.1.0-py3-none-any.whl (144.8 kB view details)

Uploaded Python 3

File details

Details for the file truemarkets-0.1.0.tar.gz.

File metadata

  • Download URL: truemarkets-0.1.0.tar.gz
  • Upload date:
  • Size: 56.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for truemarkets-0.1.0.tar.gz
Algorithm Hash digest
SHA256 68c2cd1a1d6dbf12f967ea0644910c72ff8c562b64334dec54db1c002bcaddc3
MD5 7a8a3d490cc2da56124fb13b7833083f
BLAKE2b-256 a1018b9a0840f4fa7b7904a3e9953287305c5e5c165d057e23a76e2cd40b73f0

See more details on using hashes here.

File details

Details for the file truemarkets-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: truemarkets-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 144.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for truemarkets-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2eaafbd3ee4aaff8df7168a84eff801e0c6f51e5bd1b4ab75e1c712ec0718162
MD5 21056378f28928d0d70c73916d478e02
BLAKE2b-256 b5993506514860ef987625350452b8aa5a9df0a4a48f953266ffd14ec1125880

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page