43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
|
# Exchange Integrations
|
||
|
|
|
||
|
|
This section provides documentation for integrating with different cryptocurrency exchanges.
|
||
|
|
|
||
|
|
## Architecture
|
||
|
|
|
||
|
|
The platform uses a modular architecture for exchange integration, allowing for easy addition of new exchanges without modifying core application logic.
|
||
|
|
|
||
|
|
### Core Components
|
||
|
|
|
||
|
|
- **`BaseDataCollector`**: An abstract base class defining the standard interface for all exchange collectors.
|
||
|
|
- **`ExchangeFactory`**: A factory for creating exchange-specific collector instances.
|
||
|
|
- **Exchange-Specific Modules**: Each exchange has its own module containing the collector implementation and any specific data processing logic.
|
||
|
|
|
||
|
|
For a high-level overview of the data collection system, see the [Data Collectors Documentation (`../data_collectors.md`)](../data_collectors.md).
|
||
|
|
|
||
|
|
## Supported Exchanges
|
||
|
|
|
||
|
|
### OKX
|
||
|
|
- **Status**: Production Ready
|
||
|
|
- **Features**: Real-time trades, order book, and ticker data.
|
||
|
|
- **Documentation**: [OKX Collector Guide (`okx.md`)]
|
||
|
|
|
||
|
|
### Binance
|
||
|
|
- **Status**: Planned
|
||
|
|
- **Features**: To be determined.
|
||
|
|
|
||
|
|
### Coinbase
|
||
|
|
- **Status**: Planned
|
||
|
|
- **Features**: To be determined.
|
||
|
|
|
||
|
|
## Adding a New Exchange
|
||
|
|
|
||
|
|
To add support for a new exchange, you need to:
|
||
|
|
|
||
|
|
1. Create a new module in the `data/exchanges/` directory.
|
||
|
|
2. Implement a new collector class that inherits from `BaseDataCollector`.
|
||
|
|
3. Implement the exchange-specific WebSocket connection and data parsing logic.
|
||
|
|
4. Register the new collector in the `ExchangeFactory`.
|
||
|
|
5. Add a new documentation file in this directory explaining the implementation details.
|
||
|
|
|
||
|
|
---
|
||
|
|
*Back to [Modules Documentation (`../README.md`)]*
|