Object List

Client Objects

Object NameDescription
PushClientSubscription client for persistent WebSocket notifications, including real-time quotes and asset, order, and position updates
QuoteClientClient for market data APIs, including candlestick bars (K-line data) and real-time prices
TradeClientClient for trading APIs, including order placement and modification

Account Classes

Prime/Paper Trading Account

Object NameReference PathDescription
PortfolioAccounttigeropen.trade.domain.prime_account.PortfolioAccountAccount asset information
Segmenttigeropen.trade.domain.prime_account.SegmentAssets grouped by instrument category
CurrencyAssettigeropen.trade.domain.prime_account.CurrencyAssetCash asset information

Global Account

Object NameReference PathDescription
PortfolioAccounttigeropen.trade.domain.account.PortfolioAccountAccount asset information
Accounttigeropen.trade.domain.account.AccountSummarized account information
CommoditySegmenttigeropen.trade.domain.account.CommoditySegmentFutures asset information
SecuritySegmenttigeropen.trade.domain.account.SecuritySegmentStock asset information
MarketValuetigeropen.trade.domain.account.MarketValueMarket value object

Trading Classes

Object NameReference PathDescription
Positiontigeropen.trade.domain.position.PositionPosition object
Ordertigeropen.trade.domain.order.OrderOrder object
OrderLegtigeropen.trade.domain.order.OrderLegAttached order object
AlgoParamstigeropen.trade.domain.order.AlgoParamsAlgorithmic order (VWAP/TWAP) parameters
Contracttigeropen.trade.domain.contract.ContractContract object

Market Data Classes

Object NameReference PathDescription
MarketStatustigeropen.quote.domain.market_status.MarketStatusMarket status object
OptionFiltertigeropen.quote.domain.filter.OptionFilterOption filter

Did this page help you?