90cb450640
- Deleted the `okx_config.json` file as part of the configuration refactor. - Updated `BaseDataCollector` to include an optional `timeframes` parameter for more flexible data collection. - Modified `DataCollectionService` and `OKXCollector` to pass and utilize the new `timeframes` parameter. - Enhanced `ExchangeCollectorConfig` to validate timeframes, ensuring they are provided and correctly formatted. - Updated documentation to reflect the new configurable timeframes feature, improving clarity for users. These changes streamline the configuration process and improve the flexibility of data collection, aligning with project standards for maintainability and usability.
60 lines
2.0 KiB
Markdown
60 lines
2.0 KiB
Markdown
# Exchange Integrations
|
|
|
|
## Overview
|
|
This module provides a standardized interface for collecting real-time data from various cryptocurrency exchanges. It uses a modular architecture that allows easy addition of new exchanges while maintaining consistent behavior and error handling.
|
|
|
|
## Documentation Structure
|
|
|
|
- **[Technical Documentation](exchanges.md)**: Detailed technical documentation of the exchange module architecture, including factory pattern, configuration, and error handling.
|
|
- **Exchange-Specific Implementations**:
|
|
- **[OKX](okx_collector.md)**: Complete guide for OKX exchange integration
|
|
|
|
## Quick Links
|
|
|
|
- [Data Collection Architecture](../data_collectors.md)
|
|
- [Error Handling Guide](../error_handling.md)
|
|
- [Logging Configuration](../logging.md)
|
|
|
|
## Exchange Status
|
|
|
|
| Exchange | Status | Features | Documentation |
|
|
|----------|---------|-----------|---------------|
|
|
| OKX | ✅ Production | Trades, Order Book, Ticker, Configurable Timeframes (1s+) | [Guide](okx_collector.md) |
|
|
| Binance | 🔄 Planned | TBD | - |
|
|
| Coinbase | 🔄 Planned | TBD | - |
|
|
|
|
## Features
|
|
|
|
### Core Features
|
|
- Real-time data collection
|
|
- Robust error handling
|
|
- Automatic reconnection
|
|
- Health monitoring
|
|
- Configurable timeframes
|
|
- Support for 1-second intervals
|
|
- Flexible timeframe configuration
|
|
- Custom timeframe aggregation
|
|
|
|
### Exchange-Specific Features
|
|
- OKX: Full WebSocket support with configurable timeframes (1s+)
|
|
- More exchanges coming soon
|
|
|
|
## Adding New Exchanges
|
|
|
|
See [Technical Documentation](exchanges.md) for detailed implementation guide.
|
|
|
|
Key Steps:
|
|
1. Create exchange module in `data/exchanges/`
|
|
2. Implement collector class extending `BaseDataCollector`
|
|
3. Add WebSocket/REST implementations
|
|
4. Register in `ExchangeFactory`
|
|
5. Add documentation
|
|
|
|
## Support
|
|
|
|
- Report issues in the project issue tracker
|
|
- See [Contributing Guide](../../CONTRIBUTING.md) for development guidelines
|
|
- Check [Known Issues](exchanges.md#known-issues) for current limitations
|
|
|
|
---
|
|
*Back to [Main Documentation](../../README.md)* |