-
Notifications
You must be signed in to change notification settings - Fork 266
Open
Milestone
Description
Refactor key type and enum names in the v3 branch to align with industry-standard terminology, reduce ambiguity, and improve long-term maintainability.
✅ Renames to implement
Quote→Bar(OHLCV aggregation input)QuoteD→BarDTrade→TradeTick(individual trade print)PeriodSize→BarInterval(time-based aggregation interval)
📌 Guidelines
- Update all type declarations, references, XML docs, and examples
- Maintain 1:1 semantic mapping — only the naming is changing
- This rename is v3-only (no need to maintain old aliases or backward compatibility)
- Ensure sample/test data and unit test names are updated consistently
- rename items above where applicable
- update all XML docs, prefer
crefwhere possible - update user documentation accordingly
- update migrations
[Obsolete]and guide - for
BarIntervalinclude map to string equivalents for test SSE server use (e.g.5m,1d, etc.
Related to:
- Implement consistent test method naming conventions repository-wide #1533
- File reorganization for .NET naming conventions #1810
Historically we've been using the term Quote to represent OHLCV aggregate bars, which is somewhat out of line with industry terminology, despite being fairly common to see on websites "stock quotes" and such. This renaming in v3 allows for future expansions to incorporate correct terminology as follows.
| Term | Future usage | Why reserved? |
|---|---|---|
Quote |
Snapshot of best bid/ask (NBBO or venue-level) | Aligns with FIX/ITCH, vendor APIs (e.g. Alpaca, Polygon), and expected usage in real-time quote tracking |
QuoteTick |
Streaming update of bid/ask quote (WebSocket feed) | Clean distinction from static Quote; used by Binance, Tradier, Alpaca and others |
QuoteBook (or OrderBookSnapshot) |
Full Level 2 book snapshot | Useful for order book visualization or simulation, not conflated with top-of-book |
BookUpdate |
Level 2 order book delta stream (depth updates) | Complements QuoteBook; matches crypto & futures exchange feeds |
BarUpdate |
Real-time streamed bar update (OHLCV in-progress) | For building candles live from ticks; avoids repurposing Bar |
Candle |
View-layer or frontend-specific alias for Bar | Reserved for UI or pattern analysis, not core indicator inputs |
TickBar / VolumeBar / RangeBar |
Future bar types by event count, volume, or price range | Fit within Bar ecosystem but allow method-level type distinction if needed |
Trade |
Reserved for system-level or portfolio execution | Prevents name collision in higher-level trading contexts (orders, fills, PnL tracking) |
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Projects
Status
No status