broker

package module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2026 License: MIT Imports: 3 Imported by: 0

README

kite-mcp-broker

Go Reference

Multi-broker port for Indian retail trading platforms. Defines broker.Client plus ancillary capability interfaces (NativeAlertCapable, GTTManager, MutualFundClient) and ships the Zerodha adapter (zerodha) wrapping gokiteconnect/v4.

Status

v0.x — unstable. Adapter signatures may break between minor versions. Pin v0.1.0 deliberately. v1.0 ships only after at least one external adapter (non-Zerodha) passes the conformance harness.

Install

go get github.com/algo2go/kite-mcp-broker@v0.1.0

Conformance harness

conformance/ is the public test API for adapter authors. Four buckets:

  • PortContract — required broker.Client methods
  • OptionalCapabilities — feature-detect via type assertion (NativeAlerts, GTT, MutualFunds)
  • ErrorClassification — transient/auth/rate-limit/validation taxonomy
  • TickerLifecycle — websocket connect/subscribe/disconnect semantics

See conformance/conformance.go for entry points.

Reference consumer

Sundeepg98/kite-mcp-server — MCP server with 100+ tools. The broker port lived in-tree there until 2026-05-05 when it was extracted to this repo to enable multi-broker adoption + independent semver.

License

MIT — see LICENSE.

Authors

Original broker.Client design + Zerodha adapter: Sundeepg98 (Zerodha Tech).

Extraction + multi-broker port + conformance harness: algo2go contributors.

Roadmap

  • v0.1.0 — Zerodha adapter
  • v0.2.0 — Upstox adapter (community contribution welcome)
  • v0.3.0 — Dhan adapter (community contribution welcome)
  • v1.0.0 — frozen public API (after >=1 external adapter ships)

Contributing

PRs welcome for: new broker adapters that pass conformance.PortContract, documentation improvements, bug fixes. Feature requests via Issues. Commercial support for adapter integration: contact via Issues.

Documentation

Index

Constants

View Source 
const MarketProtectionAuto float64 = -1

MarketProtectionAuto is the default value for MarketProtection in OrderParams, meaning the broker applies its own default protection percentage.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthResult 

type AuthResult struct {
	AccessToken string `json:"access_token"`
	UserID      string `json:"user_id"`
	UserName    string `json:"user_name"`
	UserType    string `json:"user_type"`
	Email       string `json:"email,omitempty"`
}

AuthResult returned from ExchangeToken.

type Authenticator 

type Authenticator interface {
	// GetLoginURL returns the broker's login URL for OAuth/redirect flow.
	GetLoginURL(apiKey string) string

	// ExchangeToken completes auth flow, returns access token + user info.
	ExchangeToken(apiKey, apiSecret, requestToken string) (AuthResult, error)

	// InvalidateToken invalidates a token (best-effort).
	InvalidateToken(apiKey, accessToken string) error
}

Authenticator handles broker-specific auth lifecycle.

type BasketMarginResult 

type BasketMarginResult struct {
	// Raw holds the full basket margin response from the broker for pass-through.
	Raw any `json:"raw"`
}

BasketMarginResult represents the combined margin for a basket of orders.

type BrokerIdentity 

type BrokerIdentity interface {
	// BrokerName returns the identifier for this broker implementation.
	BrokerName() Name
}

BrokerIdentity exposes the broker's identity — implemented by every client.

type Client 

type Client interface {
	BrokerIdentity
	ProfileReader
	PortfolioReader
	OrderManager
	MarketDataReader
	GTTManager
	PositionConverter
	MutualFundClient
	MarginCalculator
}

Client is the composite broker interface. Each broker implementation (Zerodha, Angel One, Dhan, Upstox) must satisfy this contract by implementing every sub-interface below. Callers are encouraged to depend on a narrower sub-interface when they only need part of the surface.

type ConvertPositionParams 

type ConvertPositionParams struct {
	Exchange        string `json:"exchange"`
	Tradingsymbol   string `json:"tradingsymbol"`
	TransactionType string `json:"transaction_type"`
	Quantity        int    `json:"quantity"`
	OldProduct      string `json:"old_product"`
	NewProduct      string `json:"new_product"`
	PositionType    string `json:"position_type"` // "day" or "overnight"
}

ConvertPositionParams contains parameters for converting a position from one product to another.

type Depth 

type Depth struct {
	Buy  [5]DepthItem `json:"buy"`
	Sell [5]DepthItem `json:"sell"`
}

Depth represents market depth with buy and sell sides.

type DepthItem 

type DepthItem struct {
	Price    float64 `json:"price"`
	Quantity int     `json:"quantity"`
	Orders   int     `json:"orders"`
}

DepthItem represents a single entry in the market depth (bid/ask).

type Factory 

type Factory interface {
	// Create returns a new unauthenticated broker client for the given API key.
	Create(apiKey string) (Client, error)

	// CreateWithToken returns an authenticated broker client.
	CreateWithToken(apiKey, accessToken string) (Client, error)

	// BrokerName returns which broker this factory creates.
	BrokerName() Name
}

Factory creates broker Client instances from credentials.

type GTTCondition 

type GTTCondition struct {
	Exchange      string    `json:"exchange"`
	Tradingsymbol string    `json:"tradingsymbol"`
	TriggerValues []float64 `json:"trigger_values"`
	LastPrice     float64   `json:"last_price"`
}

GTTCondition represents the trigger condition for a GTT order.

type GTTManager 

type GTTManager interface {
	// GetGTTs returns all GTT (Good Till Triggered) orders.
	GetGTTs() ([]GTTOrder, error)

	// PlaceGTT places a new GTT order and returns the trigger ID.
	PlaceGTT(params GTTParams) (GTTResponse, error)

	// ModifyGTT modifies an existing GTT order.
	ModifyGTT(triggerID int, params GTTParams) (GTTResponse, error)

	// DeleteGTT deletes an existing GTT order.
	DeleteGTT(triggerID int) (GTTResponse, error)
}

GTTManager manages Good-Till-Triggered orders.

type GTTOrder 

type GTTOrder struct {
	ID        int           `json:"id"`
	Type      string        `json:"type"` // "single" or "two-leg"
	Condition GTTCondition  `json:"condition"`
	Orders    []GTTOrderLeg `json:"orders"`
	Status    string        `json:"status"`
	CreatedAt string        `json:"created_at"`
	UpdatedAt string        `json:"updated_at"`
	ExpiresAt string        `json:"expires_at"`
}

GTTOrder represents a GTT (Good Till Triggered) order.

type GTTOrderLeg 

type GTTOrderLeg struct {
	Exchange        string  `json:"exchange"`
	Tradingsymbol   string  `json:"tradingsymbol"`
	TransactionType string  `json:"transaction_type"`
	Quantity        int     `json:"quantity"`
	OrderType       string  `json:"order_type"`
	Price           float64 `json:"price"`
	Product         string  `json:"product"`
}

GTTOrderLeg represents a single order leg within a GTT.

type GTTParams 

type GTTParams struct {
	Exchange        string  `json:"exchange"`
	Tradingsymbol   string  `json:"tradingsymbol"`
	LastPrice       float64 `json:"last_price"`
	TransactionType string  `json:"transaction_type"`
	Product         string  `json:"product"`
	Type            string  `json:"type"` // "single" or "two-leg"
	// For single-leg triggers:
	TriggerValue float64 `json:"trigger_value,omitempty"`
	Quantity     float64 `json:"quantity,omitempty"`
	LimitPrice   float64 `json:"limit_price,omitempty"`
	// For two-leg (OCO) triggers:
	UpperTriggerValue float64 `json:"upper_trigger_value,omitempty"`
	UpperQuantity     float64 `json:"upper_quantity,omitempty"`
	UpperLimitPrice   float64 `json:"upper_limit_price,omitempty"`
	LowerTriggerValue float64 `json:"lower_trigger_value,omitempty"`
	LowerQuantity     float64 `json:"lower_quantity,omitempty"`
	LowerLimitPrice   float64 `json:"lower_limit_price,omitempty"`
}

GTTParams contains parameters for placing or modifying a GTT order.

type GTTResponse 

type GTTResponse struct {
	TriggerID int `json:"trigger_id"`
}

GTTResponse is returned after placing or modifying a GTT order.

type HistoricalCandle 

type HistoricalCandle struct {
	Date   time.Time `json:"date"`
	Open   float64   `json:"open"`
	High   float64   `json:"high"`
	Low    float64   `json:"low"`
	Close  float64   `json:"close"`
	Volume int       `json:"volume"`
}

HistoricalCandle represents a single OHLCV candle.

type Holding 

type Holding struct {
	Tradingsymbol string      `json:"tradingsymbol"`
	Exchange      string      `json:"exchange"`
	ISIN          string      `json:"isin,omitempty"`
	Quantity      int         `json:"quantity"`
	AveragePrice  float64     `json:"average_price"`
	LastPrice     float64     `json:"last_price"`
	PnL           money.Money `json:"pnl"`
	DayChangePct  float64     `json:"day_change_percentage"`
	Product       string      `json:"product,omitempty"`
}

Holding represents a single holding in the portfolio.

PnL is typed money.Money (Slice 6e c2): the currency-aware Money VO covering the broker DTO so cross-currency mismatch surfaces at the type system rather than as a silent float coercion. Wire-format stays bare-float for INR (the production case) via Money's custom MarshalJSON; non-INR cases serialize as {"amount", "currency"}.

type LTP 

type LTP struct {
	LastPrice float64 `json:"last_price"`
}

LTP contains the last traded price for an instrument.

type MFHolding 

type MFHolding struct {
	Tradingsymbol string  `json:"tradingsymbol"`
	Folio         string  `json:"folio,omitempty"`
	Fund          string  `json:"fund,omitempty"`
	Quantity      float64 `json:"quantity"`
	AveragePrice  float64 `json:"average_price"`
	LastPrice     float64 `json:"last_price"`
	PnL           float64 `json:"pnl"`
}

MFHolding represents a mutual fund holding.

type MFOrder 

type MFOrder struct {
	OrderID           string  `json:"order_id"`
	Tradingsymbol     string  `json:"tradingsymbol"`
	TransactionType   string  `json:"transaction_type"`
	Status            string  `json:"status"`
	Amount            float64 `json:"amount"`
	Quantity          float64 `json:"quantity"`
	Folio             string  `json:"folio,omitempty"`
	Fund              string  `json:"fund,omitempty"`
	Tag               string  `json:"tag,omitempty"`
	StatusMessage     string  `json:"status_message,omitempty"`
	PurchaseType      string  `json:"purchase_type,omitempty"`
	OrderTimestamp    string  `json:"order_timestamp,omitempty"`
	ExchangeTimestamp string  `json:"exchange_timestamp,omitempty"`
}

MFOrder represents a mutual fund order.

type MFOrderParams 

type MFOrderParams struct {
	Tradingsymbol   string  `json:"tradingsymbol"`
	TransactionType string  `json:"transaction_type"`
	Amount          float64 `json:"amount,omitempty"`
	Quantity        float64 `json:"quantity,omitempty"`
	Tag             string  `json:"tag,omitempty"`
}

MFOrderParams contains parameters for placing a mutual fund order.

type MFOrderResponse 

type MFOrderResponse struct {
	OrderID string `json:"order_id"`
}

MFOrderResponse is returned after placing or cancelling a mutual fund order.

type MFSIP 

type MFSIP struct {
	SIPID         string  `json:"sip_id"`
	Tradingsymbol string  `json:"tradingsymbol"`
	Fund          string  `json:"fund,omitempty"`
	Frequency     string  `json:"frequency"`
	Amount        float64 `json:"amount"`
	Instalments   int     `json:"instalments"`
	Status        string  `json:"status"`
	InstalmentDay int     `json:"instalment_day,omitempty"`
	Tag           string  `json:"tag,omitempty"`
	Created       string  `json:"created,omitempty"`
}

MFSIP represents a mutual fund SIP (Systematic Investment Plan).

type MFSIPParams 

type MFSIPParams struct {
	Tradingsymbol string  `json:"tradingsymbol"`
	Amount        float64 `json:"amount"`
	Frequency     string  `json:"frequency"`
	Instalments   int     `json:"instalments"`
	InitialAmount float64 `json:"initial_amount,omitempty"`
	InstalmentDay int     `json:"instalment_day,omitempty"`
	Tag           string  `json:"tag,omitempty"`
}

MFSIPParams contains parameters for placing a mutual fund SIP.

type MFSIPResponse 

type MFSIPResponse struct {
	SIPID string `json:"sip_id"`
}

MFSIPResponse is returned after placing or cancelling a mutual fund SIP.

type MarginCalculator 

type MarginCalculator interface {
	// GetOrderMargins calculates margin required for orders.
	GetOrderMargins(orders []OrderMarginParam) (any, error)

	// GetBasketMargins calculates combined margin for a basket of orders.
	GetBasketMargins(orders []OrderMarginParam, considerPositions bool) (any, error)

	// GetOrderCharges calculates brokerage, taxes, and charges for orders.
	GetOrderCharges(orders []OrderChargesParam) (any, error)
}

MarginCalculator calculates order margins, basket margins, and charges.

type Margins 

type Margins struct {
	Equity    SegmentMargin `json:"equity"`
	Commodity SegmentMargin `json:"commodity,omitempty"`
}

Margins contains margin information across segments.

type MarketDataReader 

type MarketDataReader interface {
	// GetLTP returns the last traded price for the given instruments.
	// Instrument format is "EXCHANGE:TRADINGSYMBOL" (e.g., "NSE:RELIANCE").
	GetLTP(instruments ...string) (map[string]LTP, error)

	// GetOHLC returns OHLC data for the given instruments.
	GetOHLC(instruments ...string) (map[string]OHLC, error)

	// GetQuotes returns full market quotes for the given instruments.
	// Instrument format is "EXCHANGE:TRADINGSYMBOL" (e.g., "NSE:RELIANCE").
	GetQuotes(instruments ...string) (map[string]Quote, error)

	// GetHistoricalData returns historical candle data for an instrument.
	GetHistoricalData(instrumentToken int, interval string, from, to time.Time) ([]HistoricalCandle, error)
}

MarketDataReader reads live and historical market data.

type MutualFundClient 

type MutualFundClient interface {
	// GetMFOrders returns all mutual fund orders.
	GetMFOrders() ([]MFOrder, error)

	// GetMFSIPs returns all mutual fund SIPs.
	GetMFSIPs() ([]MFSIP, error)

	// GetMFHoldings returns all mutual fund holdings.
	GetMFHoldings() ([]MFHolding, error)

	// PlaceMFOrder places a mutual fund order.
	PlaceMFOrder(params MFOrderParams) (MFOrderResponse, error)

	// CancelMFOrder cancels a pending mutual fund order.
	CancelMFOrder(orderID string) (MFOrderResponse, error)

	// PlaceMFSIP starts a new mutual fund SIP.
	PlaceMFSIP(params MFSIPParams) (MFSIPResponse, error)

	// CancelMFSIP cancels an existing mutual fund SIP.
	CancelMFSIP(sipID string) (MFSIPResponse, error)
}

MutualFundClient groups all mutual fund operations.

type Name 

type Name string

Name identifies a broker implementation. 

const (
	Zerodha  Name = "zerodha"
	AngelOne Name = "angelone"
	Dhan     Name = "dhan"
	Upstox   Name = "upstox"
)

type NativeAlert 

type NativeAlert struct {
	UUID             string  `json:"uuid"`
	Name             string  `json:"name"`
	Type             string  `json:"type"`
	Status           string  `json:"status"`
	LHSExchange      string  `json:"lhs_exchange"`
	LHSTradingSymbol string  `json:"lhs_tradingsymbol"`
	LHSAttribute     string  `json:"lhs_attribute"`
	Operator         string  `json:"operator"`
	RHSType          string  `json:"rhs_type"`
	RHSConstant      float64 `json:"rhs_constant,omitempty"`
	RHSExchange      string  `json:"rhs_exchange,omitempty"`
	RHSTradingSymbol string  `json:"rhs_tradingsymbol,omitempty"`
	RHSAttribute     string  `json:"rhs_attribute,omitempty"`
	AlertCount       int     `json:"alert_count"`
	CreatedAt        string  `json:"created_at,omitempty"`
	UpdatedAt        string  `json:"updated_at,omitempty"`
}

NativeAlert represents a server-side alert returned by the broker.

type NativeAlertCapable 

type NativeAlertCapable interface {
	// CreateNativeAlert creates a server-side alert.
	CreateNativeAlert(params NativeAlertParams) (NativeAlert, error)

	// GetNativeAlerts retrieves all native alerts, optionally filtered.
	GetNativeAlerts(filters map[string]string) ([]NativeAlert, error)

	// ModifyNativeAlert modifies an existing native alert by UUID.
	ModifyNativeAlert(uuid string, params NativeAlertParams) (NativeAlert, error)

	// DeleteNativeAlerts deletes one or more native alerts by UUID.
	DeleteNativeAlerts(uuids ...string) error

	// GetNativeAlertHistory retrieves the trigger history for an alert.
	GetNativeAlertHistory(uuid string) ([]NativeAlertHistoryEntry, error)
}

NativeAlertCapable is an optional sub-interface implemented by brokers that support server-side alerts (e.g., Zerodha). Use a type assertion to check: if nac, ok := client.(broker.NativeAlertCapable); ok { ... }

type NativeAlertHistoryEntry 

type NativeAlertHistoryEntry struct {
	UUID      string `json:"uuid"`
	Type      string `json:"type"`
	Condition string `json:"condition"`
	CreatedAt string `json:"created_at,omitempty"`
	Meta      any    `json:"meta,omitempty"`
	OrderMeta any    `json:"order_meta,omitempty"`
}

NativeAlertHistoryEntry represents a single trigger event in an alert's history.

type NativeAlertParams 

type NativeAlertParams struct {
	Name             string  `json:"name"`
	Type             string  `json:"type"` // "simple" or "ato"
	LHSExchange      string  `json:"lhs_exchange"`
	LHSTradingSymbol string  `json:"lhs_tradingsymbol"`
	LHSAttribute     string  `json:"lhs_attribute"`
	Operator         string  `json:"operator"` // "<=", ">=", "<", ">", "=="
	RHSType          string  `json:"rhs_type"` // "constant" or "instrument"
	RHSConstant      float64 `json:"rhs_constant,omitempty"`
	RHSExchange      string  `json:"rhs_exchange,omitempty"`
	RHSTradingSymbol string  `json:"rhs_tradingsymbol,omitempty"`
	RHSAttribute     string  `json:"rhs_attribute,omitempty"`
	BasketJSON       string  `json:"basket_json,omitempty"` // raw JSON for ATO basket
}

NativeAlertParams contains parameters for creating or modifying a server-side alert.

type OHLC 

type OHLC struct {
	Open      float64 `json:"open"`
	High      float64 `json:"high"`
	Low       float64 `json:"low"`
	Close     float64 `json:"close"`
	LastPrice float64 `json:"last_price"`
}

OHLC contains open-high-low-close and last price for an instrument.

type Order 

type Order struct {
	OrderID         string    `json:"order_id"`
	Exchange        string    `json:"exchange"`
	Tradingsymbol   string    `json:"tradingsymbol"`
	TransactionType string    `json:"transaction_type"`
	OrderType       string    `json:"order_type"`
	Product         string    `json:"product"`
	Quantity        int       `json:"quantity"`
	Price           float64   `json:"price"`
	TriggerPrice    float64   `json:"trigger_price"`
	Status          string    `json:"status"`
	FilledQuantity  int       `json:"filled_quantity"`
	AveragePrice    float64   `json:"average_price"`
	OrderTimestamp  time.Time `json:"order_timestamp"`
	StatusMessage   string    `json:"status_message,omitempty"`
	Tag             string    `json:"tag,omitempty"`
}

Order represents a placed order and its current state.

type OrderChargesParam 

type OrderChargesParam struct {
	OrderID         string  `json:"order_id"`
	Exchange        string  `json:"exchange"`
	Tradingsymbol   string  `json:"tradingsymbol"`
	TransactionType string  `json:"transaction_type"`
	Quantity        float64 `json:"quantity"`
	AveragePrice    float64 `json:"average_price"`
	Product         string  `json:"product"`
	OrderType       string  `json:"order_type"`
	Variety         string  `json:"variety"`
}

OrderChargesParam represents a single order for charges calculation.

type OrderChargesResult 

type OrderChargesResult struct {
	// Raw holds the full charges response from the broker for pass-through.
	Raw any `json:"raw"`
}

OrderChargesResult represents the charges for one order.

type OrderManager 

type OrderManager interface {
	// GetOrders returns all orders for the current trading day.
	GetOrders() ([]Order, error)

	// GetOrderHistory returns the state history of a specific order.
	GetOrderHistory(orderID string) ([]Order, error)

	// GetOrderTrades returns executed trades for a specific order.
	GetOrderTrades(orderID string) ([]Trade, error)

	// PlaceOrder places a new order and returns the order ID.
	PlaceOrder(params OrderParams) (OrderResponse, error)

	// ModifyOrder modifies an existing pending order.
	ModifyOrder(orderID string, params OrderParams) (OrderResponse, error)

	// CancelOrder cancels an existing pending order.
	// variety specifies the order variety (e.g., "regular", "co", "amo", "iceberg", "auction").
	CancelOrder(orderID string, variety string) (OrderResponse, error)
}

OrderManager places, modifies, cancels, and reads orders.

type OrderMarginParam 

type OrderMarginParam struct {
	Exchange        string  `json:"exchange"`
	Tradingsymbol   string  `json:"tradingsymbol"`
	TransactionType string  `json:"transaction_type"`
	Variety         string  `json:"variety"`
	Product         string  `json:"product"`
	OrderType       string  `json:"order_type"`
	Quantity        float64 `json:"quantity"`
	Price           float64 `json:"price,omitempty"`
	TriggerPrice    float64 `json:"trigger_price,omitempty"`
}

OrderMarginParam represents a single order for margin calculation.

type OrderMarginResult 

type OrderMarginResult struct {
	Type     string  `json:"type"`
	Exchange string  `json:"exchange"`
	Total    float64 `json:"total"`
	// Raw holds the full margin response from the broker for pass-through.
	Raw any `json:"raw,omitempty"`
}

OrderMarginResult represents the margin result for one order.

type OrderParams 

type OrderParams struct {
	Exchange         string  `json:"exchange"`
	Tradingsymbol    string  `json:"tradingsymbol"`
	TransactionType  string  `json:"transaction_type"`
	OrderType        string  `json:"order_type"`
	Product          string  `json:"product"`
	Quantity         int     `json:"quantity"`
	Price            float64 `json:"price,omitempty"`
	TriggerPrice     float64 `json:"trigger_price,omitempty"`
	Validity         string  `json:"validity,omitempty"`
	Tag              string  `json:"tag,omitempty"`
	Variety          string  `json:"variety,omitempty"`
	DisclosedQty     int     `json:"disclosed_quantity,omitempty"`
	MarketProtection float64 `json:"market_protection,omitempty"`
}

OrderParams contains parameters for placing or modifying an order.

type OrderResponse 

type OrderResponse struct {
	OrderID string `json:"order_id"`
}

OrderResponse is returned after placing, modifying, or cancelling an order.

type PortfolioReader 

type PortfolioReader interface {
	// GetHoldings returns the user's portfolio holdings.
	GetHoldings() ([]Holding, error)

	// GetPositions returns current day and net positions.
	GetPositions() (Positions, error)

	// GetTrades returns all executed trades for the day.
	GetTrades() ([]Trade, error)
}

PortfolioReader reads holdings, positions, and executed trades.

type Position 

type Position struct {
	Tradingsymbol string      `json:"tradingsymbol"`
	Exchange      string      `json:"exchange"`
	Product       string      `json:"product"`
	Quantity      int         `json:"quantity"`
	AveragePrice  float64     `json:"average_price"`
	LastPrice     float64     `json:"last_price"`
	PnL           money.Money `json:"pnl"`
}

Position represents a single trading position.

PnL is typed money.Money (Slice 6e c2). Same wire-format invariant as Holding.PnL — bare-float for INR via Money.MarshalJSON.

type PositionConverter 

type PositionConverter interface {
	// ConvertPosition converts a position from one product type to another.
	ConvertPosition(params ConvertPositionParams) (bool, error)
}

PositionConverter converts positions between product types.

type Positions 

type Positions struct {
	Day []Position `json:"day"`
	Net []Position `json:"net"`
}

Positions contains day and net position lists.

type Profile 

type Profile struct {
	UserID    string   `json:"user_id"`
	UserName  string   `json:"user_name"`
	Email     string   `json:"email"`
	Broker    Name     `json:"broker"`
	Exchanges []string `json:"exchanges"`
	Products  []string `json:"products"`
}

Profile contains the authenticated user's broker profile.

type ProfileReader 

type ProfileReader interface {
	// GetProfile returns the authenticated user's profile.
	GetProfile() (Profile, error)

	// GetMargins returns margin/funds information.
	GetMargins() (Margins, error)
}

ProfileReader reads account profile and funds.

type Quote 

type Quote struct {
	InstrumentToken   int     `json:"instrument_token"`
	LastPrice         float64 `json:"last_price"`
	LastQuantity      int     `json:"last_quantity"`
	AveragePrice      float64 `json:"average_price"`
	Volume            int     `json:"volume"`
	BuyQuantity       int     `json:"buy_quantity"`
	SellQuantity      int     `json:"sell_quantity"`
	OHLC              OHLC    `json:"ohlc"`
	NetChange         float64 `json:"net_change"`
	OI                float64 `json:"oi"`
	OIDayHigh         float64 `json:"oi_day_high"`
	OIDayLow          float64 `json:"oi_day_low"`
	LowerCircuitLimit float64 `json:"lower_circuit_limit"`
	UpperCircuitLimit float64 `json:"upper_circuit_limit"`
	Depth             Depth   `json:"depth"`
}

Quote contains the full market quote for a single instrument.

type RateLimitError 

type RateLimitError struct {
	// RetryAfter is the parsed Retry-After header value if the broker
	// surfaced one; otherwise zero. Callers should treat zero as
	// "unknown — fall back to the caller's default backoff".
	RetryAfter time.Duration

	// Endpoint is the logical broker operation that was throttled
	// (e.g. "place_order", "get_quotes"). Free-form, used for logs
	// and metrics labels.
	Endpoint string

	// Inner is the original error from the broker SDK. Preserved so
	// callers can still inspect details (status text, error type, etc).
	Inner error
}

RateLimitError indicates the upstream broker has throttled the request with HTTP 429 (or an equivalent typed error). Callers can detect it via: 

var rle *broker.RateLimitError
if errors.As(err, &rle) { /* react: backoff, freeze risk-guard, alert */ }

This error type is broker-agnostic — every broker adapter is expected to classify and wrap 429-equivalent throttling responses into this type so downstream consumers (riskguard auto-freeze, retry middleware, telegram notifier) need not know which broker produced the throttle.

Backward compatibility: RateLimitError wraps the original error via Unwrap(), so callers using untyped `if err != nil` paths continue to work — the underlying error is still surfaced via errors.Is.

func (*RateLimitError) Error 

func (e *RateLimitError) Error() string

Error formats the rate-limit error for human consumption (logs/audit).

func (*RateLimitError) Unwrap 

func (e *RateLimitError) Unwrap() error

Unwrap returns the underlying broker error so errors.Is and errors.As can drill through to the SDK-level cause.

type SegmentMargin 

type SegmentMargin struct {
	Available float64 `json:"available"`
	Used      float64 `json:"used"`
	Total     float64 `json:"total"`
}

SegmentMargin contains margin details for a single segment.

type Trade 

type Trade struct {
	TradeID         string  `json:"trade_id"`
	OrderID         string  `json:"order_id"`
	Exchange        string  `json:"exchange"`
	Tradingsymbol   string  `json:"tradingsymbol"`
	TransactionType string  `json:"transaction_type"`
	Quantity        int     `json:"quantity"`
	Price           float64 `json:"price"`
	Product         string  `json:"product"`
}

Trade represents an executed trade.

Source Files

View all Source files

Directories

Path Synopsis
Package conformance is the reusable broker.Client + ancillary-port conformance harness.
 Package conformance is the reusable broker.Client + ancillary-port conformance harness.
Package mock provides an in-memory implementation of broker.Client for testing.
 Package mock provides an in-memory implementation of broker.Client for testing.
Package ticker defines the broker-agnostic live-tick (websocket) port.
 Package ticker defines the broker-agnostic live-tick (websocket) port.
Package zerodha implements the broker.Client interface for Zerodha's Kite Connect API.
 Package zerodha implements the broker.Client interface for Zerodha's Kite Connect API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.