Welcome to the Cryptofeed documentation. This guide will help you navigate all available documentation.
- Core Documentation - Essential guides for using Cryptofeed
- Configuration, data types, callbacks, authentication channels, performance tuning
- Architecture - System design and integration patterns
- Exchange Integration - Adding new exchanges and exchange-specific guides
- Consumer Integration - Building downstream consumers and storage solutions
- Kafka Setup & Operations - Kafka producer configuration, tuning, and troubleshooting
- Proxy Configuration - HTTP/SOCKS proxy setup and usage
- Operations Runbooks - Migration procedures and operational guides
- Monitoring & Alerts - Prometheus, Grafana dashboards, and alerting
- Schemas & Data Types - Protobuf schema documentation and examples
- Specifications - Feature specifications and implementation details
- Technical Analysis - Architectural analysis, exploration reports, and research findings
- Archive - Completed execution reports and historical documentation
- Testing & Verification - E2E testing procedures and test planning
- Performance Benchmarks - Performance metrics and optimization results
docs/
├── core/ # User-facing documentation
├── architecture/ # System design and patterns
├── exchanges/ # Exchange integration guides
├── kafka/ # Kafka operations
├── proxy/ # Proxy system documentation
├── schemas/ # Data schema and protobuf docs
├── consumers/ # Consumer integration guides
├── monitoring/ # Monitoring and alerting
├── operations/ # Operational runbooks
├── testing/ # Testing documentation
├── benchmarks/ # Performance benchmarks
├── investigations/ # Technical investigations
├── analysis/ # Research and analysis
├── specs/ # Specifications
└── archive/ # Historical reports
| Task | Location |
|---|---|
| Configure Cryptofeed? | Configuration Guide |
| Connect to an exchange? | Exchange Integration |
| Set up Kafka? | Kafka Documentation |
| Use HTTP proxies? | Proxy Guide |
| Build a consumer? | Consumer Integration |
| Understand the data flow? | Architecture: Data Flow |
| Migrate from CCXT? | Consumer Migration Guide |
| View performance metrics? | Kafka Performance Tuning |
| Set up monitoring? | Monitoring Guide |
| Add a new exchange? | Exchange Integration |
- High Level Overview - System overview and core concepts
- Data Types - Cryptofeed data structure and types
- Callbacks - Implementing data callbacks
- Configuration - Configuration and setup
- Authenticated Channels - Private data channels
- Performance Considerations - Performance tuning and optimization
- REST Endpoints - REST API endpoints
- Data Integrity for Orderbooks - Orderbook validation
- Transparent Proxy System - HTTP/SOCKS proxy support for all exchanges
- Proxy Testing Guide - Test suites and integration verification
- Kafka Producer - High-performance Kafka integration for market data
- Specification Dashboard - Overview of all specifications
- Completed Specifications - Finished and released features
- Active Development - Current work-in-progress specs
- Normalized Data Schema - Baseline schemas, governance, and monitoring
- Protobuf Serialization - Binary message format
- Kafka Producer Integration - Event streaming setup
- Adding a New Exchange - Implementation guide
- Native Exchange Blueprint - Pattern for native integrations
- CCXT Generic Integration - Using CCXT for exchanges
- Backpack Exchange - Native Backpack integration
- Kafka Configuration - Config setup
- Producer Tuning - Performance optimization
- Troubleshooting - Common issues and solutions
- Schema Management - Schema registry setup
- Rollback Procedures - Emergency procedures
- Migration Runbooks - Migration procedures
- Operational Guides - Deployment and management
- Monitoring Setup - Prometheus and Grafana configuration
- Alert Rules - Alerting configuration
- Consumer Integration Guide - Building consumers
- Consumer Templates - Code templates for common patterns
- Migration Guide - Moving to Cryptofeed
- E2E Testing - End-to-end test procedures
- Testing Planning - Test plans and coordination
- Test Results - Execution results and analysis
- Codebase Exploration - Codebase structure and patterns
- Architecture Analysis - System design findings
- Market Data Analysis - Data schema and mapping analysis
- Protobuf Analysis - Serialization research
- Exploration Reports - Research and discovery documentation
- Execution Reports - Completion reports and deliverables
- Issues & Investigations - Technical deep-dives and problem analysis
- Performance Metrics - Throughput, latency, and resource usage benchmarks
Documentation should follow these guidelines:
- Core Documentation (
core/) - User-facing guides and how-tos - Architecture (
architecture/) - System design and technical decisions - Analysis (
analysis/) - Research, exploration, and validation reports - Archive (
archive/) - Completed work and historical reports
For more information, see CONTRIBUTING.md.
Last updated: November 14, 2025