finfree-bybit-ticker/README.md

26 lines
1.1 KiB
Markdown

# FinFree Bybit Ticker
The FinFree Bybit Ticker is a project designed to dynamically watch for changes in a RethinkDB database and subscribe to Bybit's tickers for all symbols that meet a specified condition. It also updates actions based on certain conditions being met.
## Features
- **Dynamic Subscription**: Automatically subscribes to Bybit ticker updates for symbols specified in the RethinkDB.
- **Real-time Database Watching**: Utilizes RethinkDB's changefeeds feature to watch for any additions, deletions, or modifications in the symbol list.
- **Conditional Logic**: Implements custom logic to perform actions when specific conditions are met, based on the incoming ticker information.
- **Efficient Updates**: Only subscribes to and acts upon symbols that meet predefined conditions, ensuring efficient use of resources.
## Requirements
- RethinkDB
- Python 3.x
- `pybit` WebSocket Client for Bybit
- `rethinkdb` Python Client
## Installation
1. **Clone the repository**:
```bash
git clone https://github.com/yourusername/finfree-bybit-ticker.git
cd finfree-bybit-ticker