README
¶
kite-mcp-ticker
Websocket ticker service for the algo2go ecosystem. Provides live tick subscription via the Kite WebSocket API, callback dispatch, leak-sentinel goroutine cleanup, and race-flag-on/off lifecycle testing.
Used by Sundeepg98/kite-mcp-server
for live market data subscription, alert evaluation triggers,
trailing-stop monitoring, and dashboard SSE streaming.
Why a separate module?
Live tick subscription is a foundational primitive for any algo2go
project that consumes streaming market data independent of
kite-mcp-server. Hosting as a module:
- Centralizes the websocket lifecycle + callback dispatch contract
- Pairs with
algo2go/kite-mcp-broker(Kite SDK adapter)
Stability promise
v0.x — unstable. Pin v0.1.0 deliberately.
Install
go get github.com/algo2go/kite-mcp-ticker@v0.1.0
Public API
Service— websocket ticker lifecycle (Start/Stop/Subscribe/Unsubscribe)- Callback registration for tick + connect + disconnect events
- Leak-sentinel goroutine accounting for tests
Dependencies
github.com/algo2go/kite-mcp-brokerv0.1.0 — broker adapter + ticker port + zerodha subpackagegithub.com/algo2go/kite-mcp-moneyv0.1.0 (transitive)github.com/zerodha/gokiteconnect/v4— Kite SDKgithub.com/stretchr/testify— assertionsgo.uber.org/goleak— leak detection
All algo2go deps published; no upstream replace directives needed.
Reference consumer
Sundeepg98/kite-mcp-server
— consumed across kc/manager_init.go, kc/broker_services.go,
kc/usecases/ticker_usecases.go, kc/ops/data.go, kc/telegram/bot.go,
mcp/alerts/alert_tools.go, mcp/misc/ticker_tools.go,
mcp/trade/trailing_tools.go.
License
MIT — see LICENSE.
Authors
Original design: Sundeepg98 (Zerodha Tech). Multi-module promotion (2026-05-10): algo2go contributors.
Documentation
¶
Index ¶
- Constants
- type Config
- type Mode
- type Service
- func (s *Service) GetStatus(email string) (*Status, error)
- func (s *Service) IsRunning(email string) bool
- func (s *Service) ListAll() []UserTickerInfo
- func (s *Service) Shutdown()
- func (s *Service) Start(email, apiKey, accessToken string) error
- func (s *Service) Stop(email string) error
- func (s *Service) Subscribe(email string, tokens []uint32, mode brokerticker.Mode) error
- func (s *Service) Unsubscribe(email string, tokens []uint32) error
- func (s *Service) UpdateToken(email, apiKey, accessToken string) error
- type Status
- type SubscriptionInfo
- type TickCallback
- type UserTicker
- type UserTickerInfo
Constants ¶
const ( ModeLTP = brokerticker.ModeLTP ModeQuote = brokerticker.ModeQuote ModeFull = brokerticker.ModeFull )
Mode aliases for the broker-agnostic mode constants. Same byte values as kiteticker.ModeLTP/ModeQuote/ModeFull (typed string "ltp"/"quote"/"full"); existing kc/ticker.ModeLTP callsites continue to work unchanged.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Logger *slog.Logger
OnTick TickCallback // optional: global tick handler (e.g. alert evaluator)
}
Config holds configuration for creating a new ticker Service.
type Mode ¶
type Mode = brokerticker.Mode
Mode aliases the broker-agnostic broker/ticker.Mode so external consumers (mcp/ticker_tools.go, mcp/alert_tools.go, mcp/trailing_ tools.go) keep using kc/ticker.Mode unchanged. Migration target for post-launch cleanup: callsites import broker/ticker directly.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service manages per-user WebSocket ticker connections.
func (*Service) ListAll ¶
func (s *Service) ListAll() []UserTickerInfo
ListAll returns a summary of all active ticker connections.
func (*Service) Start ¶
Start creates and starts a WebSocket ticker for the given user. If a ticker is already running for this email, it returns an error.
func (*Service) Subscribe ¶
Subscribe subscribes the user's ticker to the given instrument tokens with the specified mode.
func (*Service) Unsubscribe ¶
Unsubscribe removes instrument tokens from the user's ticker.
func (*Service) UpdateToken ¶
UpdateToken stops the existing ticker and starts a new one with the fresh token. Preserves subscriptions across the restart. The entire operation is serialized under s.mu to prevent concurrent callers from seeing inconsistent state between stop and start.
type Status ¶
type Status struct {
Running bool `json:"running"`
Connected bool `json:"connected"`
StartedAt time.Time `json:"started_at,omitempty"`
Uptime string `json:"uptime,omitempty"`
Subscriptions []SubscriptionInfo `json:"subscriptions,omitempty"`
}
Status represents the current state of a user's ticker connection.
type SubscriptionInfo ¶
type SubscriptionInfo struct {
InstrumentToken uint32 `json:"instrument_token"`
Mode string `json:"mode"`
}
SubscriptionInfo represents a subscribed instrument.
type TickCallback ¶
TickCallback is invoked on each incoming tick for a user. Carries gokiteconnect models.Tick because kc/alerts.Evaluator.Evaluate takes that signature today; the broker/ticker.Tick translation happens INSIDE wireCallbacks so the kiteticker dependency stays hidden from anything outside this package + kc/alerts.
Future cleanup (out of scope for the multi-broker port-adapter commit): kc/alerts.Evaluator.Evaluate accepts broker/ticker.Tick; this signature swaps too; the round-trip translation in wireCallbacks is dropped.
type UserTicker ¶
type UserTicker struct {
Email string
APIKey string
AccessToken string
Ticker brokerticker.Ticker
Cancel context.CancelFunc
Connected bool
StartedAt time.Time
Subscribed map[uint32]brokerticker.Mode // token -> mode
// contains filtered or unexported fields
}
UserTicker holds a single user's WebSocket ticker connection.
Ticker holds a broker/ticker.Ticker port — production wires *zerodha.TickerAdapter (which wraps *kiteticker.Ticker); future non-Zerodha adapters slot in here without touching this struct.
Source Files