Architect Documentation
  • User Guide
  • SDK Documentation
  • Algos Book
  • Introduction
  • Creating an API key
  • Getting started with Python
  • Getting started with Rust
  • Concepts
    • Symbology
    • Orderflow
    • Accounts and portfolio management
    • Systems and connectivity diagram
    • Authentication
  • SDK Reference
    • Symbology and instrument info
    • Marketdata
    • Order entry
    • Order management
    • Portfolio management
Powered by GitBook
On this page
  • List symbols
  • Search symbols
  • Get product info
  • Get execution info
  • Get futures series
  1. SDK Reference

Symbology and instrument info

PreviousAuthenticationNextMarketdata

Last updated 5 days ago

List symbols

List all symbols available on Architect, including both products and tradable product pairs (e.g. "AAPL US Equity" and "AAPL US Equity/USD" may both appear).

symbols = await client.list_symbols()

for symbol in symbols:
    assert_type(symbol, str)
    print(symbol)

Search symbols

Search for tradable products on Architect using full text symbol search.

from architect_py import TradableProduct

symbols = await client.search_symbols(
    search_string="BTC",
    execution_venue="BINANCE",
    offset=0,
    limit=20,
)

for symbol in symbols:
    assert_type(symbol, TradableProduct)
    print(symbol)  # e.g. "BTC Crypto/USDT Crypto"

Get product info

Get information about a product, such as its type, underlying, multiplier, expiration, and other relevant fields.

info = await client.get_product_info("ES 20250620 CME Future")

# get many product infos at once
infos = await client.get_product_infos([
    "ES 20250620 CME Future",
    "BTC Crypto",
])
{
  "symbol": "ES 20250620 CME Future",
  "product_type": "Future",
  "multiplier": "50",
  "derivative_kind": "Linear",
  "primary_venue": "CME",
}

Get execution info

Get execution information for a tradable product, such as tick size, step size, margin requirements, and other relevant fields.

info = await client.get_execution_info(
    "ES 20250620 CME Future/USD",  # tradable product
    "CME"                          # execution venue
)

# get many execution infos at once
infos = await client.get_execution_infos(
    [
        "ES 20250620 CME Future/USD",
        "BTC Crypto/USDT Crypto",
    ],
    "CME" 
)
{
  "symbol": "ES 20250620 CME Future/USD",
  "execution_venue": "CME",
  "tick_size": "0.25",
  "step_size": "1",
  "min_order_quantity": "1",
  "is_delisted": false,
  "initial_margin": "24550",
  "maintenance_margin": "22318",
}

Get futures series

Get all futures in a given series.

futures = await client.get_futures_series("ES CME Futures")
assert_type(futures, list[str])

assert futures == [
    'ES 20250321 CME Future',
    'ES 20250620 CME Future',
    'ES 20250919 CME Future',
    # ...
]
Symbology
List symbols
Search symbols
Get product info
Get execution info
Get futures series