# Krono

## Docs

- [Data Flow](https://krono.fabianpiper.com/docs/architecture/data-flow.md): Understanding the event-driven pipeline from WebSocket to UI
- [Design Principles](https://krono.fabianpiper.com/docs/architecture/design-principles.md): Core concepts driving the architectural decisions
- [Overview](https://krono.fabianpiper.com/docs/architecture/overview.md): High-level architecture and package structure of Krono
- [Fetch](https://krono.fabianpiper.com/docs/core/api/asset-pairs/fetch.md): Triggers a request to the Kraken REST API to retrieve and process asset pairs.
- [Find Symbol](https://krono.fabianpiper.com/docs/core/api/asset-pairs/find-symbol.md): Look up a trading pair using string identifiers.
- [Refresh](https://krono.fabianpiper.com/docs/core/api/asset-pairs/refresh.md): Forces a re-fetch of the asset pairs data.
- [Status](https://krono.fabianpiper.com/docs/core/api/asset-pairs/status.md): Properties indicating the current operational state of the data fetcher.
- [Symbols](https://krono.fabianpiper.com/docs/core/api/asset-pairs/symbols.md): Access the processed list of available trading pairs.
- [Connect](https://krono.fabianpiper.com/docs/core/api/orderbook/connect.md): Method to establish the Kraken WebSocket connection.
- [Connected](https://krono.fabianpiper.com/docs/core/api/orderbook/connected.md): Read-only property checking if status is connected.
- [Connecting](https://krono.fabianpiper.com/docs/core/api/orderbook/connecting.md): Read-only property checking if status is connecting.
- [CurrentData](https://krono.fabianpiper.com/docs/core/api/orderbook/currentData.md): Read-only property for the latest snapshot.
- [DebounceMs](https://krono.fabianpiper.com/docs/core/api/orderbook/debounceMs.md): Getter and setter for update stability delay.
- [Debug](https://krono.fabianpiper.com/docs/core/api/orderbook/debug.md): Getter and setter to toggle logging.
- [Depth](https://krono.fabianpiper.com/docs/core/api/orderbook/depth.md): Getter and setter for the Kraken WebSocket subscription depth.
- [Destroy](https://krono.fabianpiper.com/docs/core/api/orderbook/destroy.md): Method to cleanup and dispose the orderbook instance.
- [Disconnect](https://krono.fabianpiper.com/docs/core/api/orderbook/disconnect.md): Method to close the Kraken WebSocket connection.
- [Disconnected](https://krono.fabianpiper.com/docs/core/api/orderbook/disconnected.md): Read-only property checking if status is disconnected.
- [Error](https://krono.fabianpiper.com/docs/core/api/orderbook/error.md): Property containing the last error object.
- [GroupingOptions](https://krono.fabianpiper.com/docs/core/api/orderbook/groupingOptions.md): Property containing a list of 9 price aggregation intervals. These intervals are calculated by applying a geometric multiplier sequence to the current `tickSize`.
- [History](https://krono.fabianpiper.com/docs/core/api/orderbook/history.md): Read-only property for historical data.
- [HistoryEnabled](https://krono.fabianpiper.com/docs/core/api/orderbook/historyEnabled.md): Getter and setter to toggle history recording.
- [Limit](https://krono.fabianpiper.com/docs/core/api/orderbook/limit.md): Getter and Setter for the number of visible price levels.
- [MaxHistoryLength](https://krono.fabianpiper.com/docs/core/api/orderbook/maxHistoryLength.md): Getter and setter for history buffer size.
- [OnConfigUpdate](https://krono.fabianpiper.com/docs/core/api/orderbook/onConfigUpdate.md): Subscribe to configuration changes.
- [OnData](https://krono.fabianpiper.com/docs/core/api/orderbook/onData.md): Subscribe to processed orderbook updates.
- [OnError](https://krono.fabianpiper.com/docs/core/api/orderbook/onError.md): Subscribe to error events.
- [OnHistoryUpdate](https://krono.fabianpiper.com/docs/core/api/orderbook/onHistoryUpdate.md): Subscribe to history buffer changes.
- [OnRawDataUpdate](https://krono.fabianpiper.com/docs/core/api/orderbook/onRawDataUpdate.md): Subscribe to raw, unthrottled data.
- [OnStatusUpdate](https://krono.fabianpiper.com/docs/core/api/orderbook/onStatusUpdate.md): Subscribe to connection state changes.
- [Reconnect](https://krono.fabianpiper.com/docs/core/api/orderbook/reconnect.md): Getter and setter for reconnection strategy.
- [SpreadGrouping](https://krono.fabianpiper.com/docs/core/api/orderbook/spreadGrouping.md): Getter and setter for price level aggregation.
- [Symbol](https://krono.fabianpiper.com/docs/core/api/orderbook/symbol.md): Getter and Setter for the active trading pair.
- [ThrottleMs](https://krono.fabianpiper.com/docs/core/api/orderbook/throttleMs.md): Getter and setter for the update interval.
- [TickSize](https://krono.fabianpiper.com/docs/core/api/orderbook/tickSize.md): Getter and setter for the minimum price increment for the current asset.
- [Asset Pairs](https://krono.fabianpiper.com/docs/core/configuration/asset-pairs.md): Options for fetching and managing tradable asset pairs.
- [Orderbook](https://krono.fabianpiper.com/docs/core/configuration/orderbook.md): Customize the behavior, performance, and connection logic of the Orderbook.
- [Orderbook Event Listeners](https://krono.fabianpiper.com/docs/core/event-listeners.md): Overview of all event subscription methods in the Orderbook class.
- [Getting started](https://krono.fabianpiper.com/docs/core/getting-started.md): Getting started with Krono Core - A facade and utilities for managing Kraken WebSocket connections and orderbook state.
- [Commands](https://krono.fabianpiper.com/docs/development/commands.md): Reference for CLI scripts and utilities
- [Contributing](https://krono.fabianpiper.com/docs/development/contributing.md): Guidelines for submitting code and pull requests
- [Getting Started](https://krono.fabianpiper.com/docs/development/getting-started.md): Set up your local development environment and install Krono packages
- [Project Structure](https://krono.fabianpiper.com/docs/development/structure.md): Overview of the monorepo layout and technology stack
- [Examples](https://krono.fabianpiper.com/docs/examples.md): Live examples and starter templates to get you building quickly
- [useAssetPairs](https://krono.fabianpiper.com/docs/hooks/api/useAssetPairs.md): A reactive hook for accessing asset pairs. Provides a synchronized state of Kraken trading pairs with liquidity-based filtering (top N), loading status, and management methods.
- [useOrderbookConfig](https://krono.fabianpiper.com/docs/hooks/api/useOrderbookConfig.md): Hook for accessing and modifying the orderbook configuration. Provides reactive state for all configuration parameters and methods to update them.
- [useOrderbookConnection](https://krono.fabianpiper.com/docs/hooks/api/useOrderbookConnection.md): Hook for accessing and modifying the orderbook websocket connection. Provides the current connection status and methods to connect or disconnect.
- [useOrderbookData](https://krono.fabianpiper.com/docs/hooks/api/useOrderbookData.md): The hook for accessing a live snapshot of the current orderbook. Provides the latest aggregated bids, asks, spread, and volume totals.
- [useOrderbookHistory](https://krono.fabianpiper.com/docs/hooks/api/useOrderbookHistory.md): Access historical snapshots of the orderbook stored in the local buffer.
- [useOrderbookLifecycle](https://krono.fabianpiper.com/docs/hooks/api/useOrderbookLifecycle.md): Provides methods to manage the orderbook lifecycle.
- [useOrderbookPlayback](https://krono.fabianpiper.com/docs/hooks/api/useOrderbookPlayback.md): A hook for replaying historical orderbook snapshots. Provides controls (play, pause, seek) and time-travel capabilities.
- [useOrderbookStatus](https://krono.fabianpiper.com/docs/hooks/api/useOrderbookStatus.md): Hook for accessing the orderbook websocket connectivity state.
- [Getting started](https://krono.fabianpiper.com/docs/hooks/getting-started.md): Start building with Krono Hooks for React.
- [AssetPairsProvider](https://krono.fabianpiper.com/docs/hooks/providers/asset-pairs-provider.md): Context provider that manages fetching and caching of trading pairs.
- [OrderbookProvider](https://krono.fabianpiper.com/docs/hooks/providers/orderbook-provider.md): Context provider that manages the Orderbook lifecycle and configuration.
- [Introduction](https://krono.fabianpiper.com/docs/index.md): A type-safe, modular toolkit for building high-performance orderbook visualizations with Kraken WebSocket API
- [OrderbookControls](https://krono.fabianpiper.com/docs/kit/components/OrderbookControls.md): Interactive controls for orderbook playback, including timeline navigation and live/replay modes.
- [OrderbookSettings](https://krono.fabianpiper.com/docs/kit/components/OrderbookSettings.md): Configure orderbook display preferences and behavior settings with composable components.
- [SymbolCombobox](https://krono.fabianpiper.com/docs/kit/components/OrderbookSymbolCombobox.md): Searchable dropdown for selecting trading pairs and switching between symbols.
- [OrderbookTable](https://krono.fabianpiper.com/docs/kit/components/OrderbookTable.md): Display orderbook data in a structured table format with customizable columns and formatting.
- [Asset Pairs](https://krono.fabianpiper.com/docs/kit/configuration/asset-pairs.md): Configure trading pair metadata fetching and management.
- [History](https://krono.fabianpiper.com/docs/kit/configuration/history.md): Configure historical snapshot tracking and playback features.
- [Orderbook](https://krono.fabianpiper.com/docs/kit/configuration/orderbook.md): Configure core orderbook behavior including symbol subscription, data depth, price level limits, and automatic reconnection strategy.
- [Overview](https://krono.fabianpiper.com/docs/kit/configuration/overview.md): Reference for configuring Orderbook.Root with detailed explanations of all available settings and their interactions.
- [Performance](https://krono.fabianpiper.com/docs/kit/configuration/performance.md): Improve orderbook performance with throttling and debouncing.
- [Getting Started](https://krono.fabianpiper.com/docs/kit/getting-started.md): Get up and running with Krono Kit
- [TypeScript](https://krono.fabianpiper.com/docs/typescript.md): Krono is built with TypeScript from the ground up, providing comprehensive type safety across all packages. Every API, hook, and component is fully typed to give you the best developer experience.

## Optional

- [GitHub](https://github.com/fapiper/krono)
- [Storybook](https://krono-storybook.vercel.app)
- [TAIKAI Project](https://taikai.network/kraken/hackathons/kraken-forge/projects/cmit01auz00d9jk8jju0g0vtc)