realtime

type AccountEvent struct {
	// Action is the envelope's action code when the payload was wrapped as
	// {"action": n, "data": {...}}. Its meaning is undocumented.
	Action *int32
	// Account is the decoded payload.
	Account GatewayUserAccount
	// Raw is the payload JSON, including undocumented members.
	Raw json.RawMessage
}

type ConnectionState int

type DepthEvent struct {
	// ContractID is the contract the entries belong to.
	ContractID string
	// Entries are the depth entries, normalized to a list whether the server
	// sent one object or an array.
	Entries []GatewayDepth
	// Raw is the payload JSON.
	Raw json.RawMessage
}

type DialError struct {
	// StatusCode is the HTTP status of a rejected upgrade request, or 0.
	StatusCode int
	// contains filtered or unexported fields
}

type DomType int32

type Event interface {
	// contains filtered or unexported methods
}

type GatewayDepth struct {
	// Timestamp is the entry timestamp.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Type is the depth entry type.
	Type *DomType `json:"type,omitempty"`
	// Price is the price level.
	Price *decimal.Decimal `json:"price,omitempty"`
	// Volume is the volume at the level, decoded leniently.
	Volume *int64 `json:"volume,omitempty" jsonx:"lenient"`
	// CurrentVolume is the current volume at the level, decoded leniently.
	CurrentVolume *int64 `json:"currentVolume,omitempty" jsonx:"lenient"`
}

type GatewayQuote struct {
	// Symbol is the symbol identifier.
	Symbol string `json:"symbol"`
	// SymbolName is the symbol's display name.
	SymbolName *string `json:"symbolName,omitempty"`
	// LastPrice is the last traded price.
	LastPrice *decimal.Decimal `json:"lastPrice,omitempty"`
	// BestBid is the best bid price.
	BestBid *decimal.Decimal `json:"bestBid,omitempty"`
	// BestAsk is the best ask price.
	BestAsk *decimal.Decimal `json:"bestAsk,omitempty"`
	// Change is the price change of the session.
	Change *decimal.Decimal `json:"change,omitempty"`
	// ChangePercent is the percentage price change of the session.
	ChangePercent *decimal.Decimal `json:"changePercent,omitempty"`
	// Open is the session's opening price.
	Open *decimal.Decimal `json:"open,omitempty"`
	// High is the session's highest price.
	High *decimal.Decimal `json:"high,omitempty"`
	// Low is the session's lowest price.
	Low *decimal.Decimal `json:"low,omitempty"`
	// Volume is the session volume, decoded leniently.
	Volume *int64 `json:"volume,omitempty" jsonx:"lenient"`
	// LastUpdated is when the quote last changed.
	LastUpdated *time.Time `json:"lastUpdated,omitempty"`
	// Timestamp is the quote timestamp.
	Timestamp *time.Time `json:"timestamp,omitempty"`
}

type GatewayTrade struct {
	// SymbolID is the symbol identifier.
	SymbolID string `json:"symbolId"`
	// Price is the trade price.
	Price *decimal.Decimal `json:"price,omitempty"`
	// Timestamp is the trade timestamp.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Type is the aggressor side.
	Type *TradeLogType `json:"type,omitempty"`
	// Volume is the traded volume, decoded leniently.
	Volume *int64 `json:"volume,omitempty" jsonx:"lenient"`
}

type GatewayUserAccount struct {
	// ID is the account identifier.
	ID int32 `json:"id"`
	// Name is the account name.
	Name *string `json:"name,omitempty"`
	// Balance is the account balance.
	Balance *decimal.Decimal `json:"balance,omitempty"`
	// CanTrade reports whether the account may trade.
	CanTrade *bool `json:"canTrade,omitempty"`
	// IsVisible reports whether the account is visible.
	IsVisible *bool `json:"isVisible,omitempty"`
	// Simulated reports whether the account is simulated.
	Simulated *bool `json:"simulated,omitempty"`
}

type GatewayUserOrder struct {
	// ID is the order identifier.
	ID int64 `json:"id"`
	// AccountID is the owning account.
	AccountID int32 `json:"accountId"`
	// ContractID is the contract identifier.
	ContractID string `json:"contractId"`
	// SymbolID is the symbol identifier.
	SymbolID string `json:"symbolId"`
	// CreationTimestamp is when the order was created.
	CreationTimestamp *time.Time `json:"creationTimestamp,omitempty"`
	// UpdateTimestamp is when the order last changed.
	UpdateTimestamp *time.Time `json:"updateTimestamp,omitempty"`
	// Status is the order status.
	Status *topstepx.OrderStatus `json:"status,omitempty"`
	// Type is the order type.
	Type *topstepx.OrderType `json:"type,omitempty"`
	// Side is the order side.
	Side *topstepx.OrderSide `json:"side,omitempty"`
	// Size is the order quantity.
	Size *int32 `json:"size,omitempty"`
	// LimitPrice is the limit price.
	LimitPrice *decimal.Decimal `json:"limitPrice,omitempty"`
	// StopPrice is the stop price.
	StopPrice *decimal.Decimal `json:"stopPrice,omitempty"`
	// FillVolume is the filled quantity, decoded leniently.
	FillVolume *int32 `json:"fillVolume,omitempty" jsonx:"lenient"`
	// FilledPrice is the fill price.
	FilledPrice *decimal.Decimal `json:"filledPrice,omitempty"`
	// CustomTag is the caller-supplied tag.
	CustomTag *string `json:"customTag,omitempty"`
}

type GatewayUserPosition struct {
	// ID is the position identifier.
	ID int32 `json:"id"`
	// AccountID is the owning account.
	AccountID int32 `json:"accountId"`
	// ContractID is the contract identifier.
	ContractID string `json:"contractId"`
	// CreationTimestamp is when the position was opened.
	CreationTimestamp *time.Time `json:"creationTimestamp,omitempty"`
	// Type is the position direction.
	Type *topstepx.PositionType `json:"type,omitempty"`
	// Size is the position quantity.
	Size *int32 `json:"size,omitempty"`
	// AveragePrice is the average entry price.
	AveragePrice *decimal.Decimal `json:"averagePrice,omitempty"`
}

type GatewayUserTrade struct {
	// ID is the trade identifier.
	ID int64 `json:"id"`
	// AccountID is the owning account.
	AccountID int32 `json:"accountId"`
	// ContractID is the contract identifier.
	ContractID string `json:"contractId"`
	// CreationTimestamp is when the trade happened.
	CreationTimestamp *time.Time `json:"creationTimestamp,omitempty"`
	// Price is the execution price.
	Price *decimal.Decimal `json:"price,omitempty"`
	// ProfitAndLoss is the realized profit and loss; nil for a half-turn.
	ProfitAndLoss *decimal.Decimal `json:"profitAndLoss,omitempty"`
	// Fees are the trade fees.
	Fees *decimal.Decimal `json:"fees,omitempty"`
	// Side is the trade side.
	Side *topstepx.OrderSide `json:"side,omitempty"`
	// Size is the traded quantity.
	Size *int32 `json:"size,omitempty"`
	// Voided reports whether the trade was voided.
	Voided *bool `json:"voided,omitempty"`
	// OrderID is the order that produced the trade.
	OrderID int64 `json:"orderId"`
}

type HandshakeError struct {
	// Message is the server's error text or the reason the handshake failed.
	Message string
}

type HubError struct {
	// Method is the invoked hub method.
	Method string
	// Message is the server's error text.
	Message string
}

type MarketHub struct {
	// contains filtered or unexported fields
}

type MarketTradesEvent struct {
	// ContractID is the contract the trades belong to.
	ContractID string
	// Trades are the trades, normalized to a list whether the server sent
	// one object or an array.
	Trades []GatewayTrade
	// Raw is the payload JSON.
	Raw json.RawMessage
}

type Option func(*config)

type OrderEvent struct {
	// Action is the envelope's action code, if the payload was wrapped.
	Action *int32
	// Order is the decoded payload.
	Order GatewayUserOrder
	// Raw is the payload JSON, including undocumented members.
	Raw json.RawMessage
}

type OverflowPolicy int

type PositionEvent struct {
	// Action is the envelope's action code, if the payload was wrapped.
	Action *int32
	// Position is the decoded payload.
	Position GatewayUserPosition
	// Raw is the payload JSON, including undocumented members.
	Raw json.RawMessage
}

type QuoteEvent struct {
	// ContractID is the contract the quote belongs to.
	ContractID string
	// Quote is the decoded payload. Updates may carry only changed fields.
	Quote GatewayQuote
	// Raw is the payload JSON, including undocumented members.
	Raw json.RawMessage
}

type ReconnectPolicy struct {
	// Delays are the waits before successive attempts; the last one repeats
	// for later attempts. Empty means the default delays.
	Delays []time.Duration
	// MaxAttempts caps the attempts per outage. UnlimitedAttempts (any
	// negative value) removes the cap; zero disables reconnection.
	MaxAttempts int
}

type ServerCloseError struct {
	// Message is the server's error text, empty when none was sent.
	Message string
	// AllowReconnect is the server's allowReconnect flag.
	AllowReconnect bool
}

type StateEvent struct {
	// State is the new state.
	State ConnectionState
	// Attempt is the 1-based reconnect attempt for StateReconnecting and
	// StateReconnected.
	Attempt int
	// Err is the cause: for StateReconnecting, why the connection was lost
	// or why the previous attempt failed; for StateClosed, why the
	// connection ended, or nil after Close.
	Err error
}

type SubscriptionErrorEvent struct {
	// Method is the subscribe method, such as "SubscribeOrders".
	Method string
	// Arguments are the method arguments.
	Arguments []any
	// Err is the failure.
	Err error
}

type TokenProvider func(ctx context.Context) (string, error)

type TradeLogType int32

type UnknownEvent struct {
	// Target is the server event name.
	Target string
	// Arguments are the raw invocation arguments.
	Arguments []json.RawMessage
	// Err is the decode error, or nil for an unknown target.
	Err error
}

type UserHub struct {
	// contains filtered or unexported fields
}

type UserTradeEvent struct {
	// Action is the envelope's action code, if the payload was wrapped.
	Action *int32
	// Trade is the decoded payload.
	Trade GatewayUserTrade
	// Raw is the payload JSON, including undocumented members.
	Raw json.RawMessage
}