wasay2205

📈 polymarket-orderbook-watcher - Monitor BTC Orderbooks Easily

📜 Overview

The polymarket-orderbook-watcher is a simple tool to view real-time orderbooks for Polymarket’s BTC Up/Down markets. This application helps you keep track of market movements every 15 minutes.

🚀 Getting Started

🔗 Download & Install

To get started, you need to download the application. Visit this page to download.

📥 System Requirements

Before running the application, ensure you have the following:

• Node.js 22+: This version is necessary for the application to run properly. You can download Node.js from the official website.

🛠️ Installation Steps

Once you have installed Node.js, follow these steps to set up the application:

1. Open your Terminal or Command Prompt:
   • On Windows: Press Win + R, type cmd, and hit Enter.
   • On macOS: Open Finder, go to Applications, then Utilities, and launch Terminal.
   • On Linux: Use your preferred terminal application.

2. Clone the Repository: In the terminal, run the following command to download the project files:

   git clone https://github.com/wasay2205/polymarket-orderbook-watcher.git
   

3. Navigate to the Project Folder: Change your directory to the folder created by the clone command:

   cd polymarket-orderbook-watcher
   

4. Install Dependencies: Run the following command to install the required packages:

   pnpm install
   

5. Build the Application: Once the installation is complete, build the application with this command:

   pnpm build
   

🔍 Usage Instructions

After installation, you can run the application. Here’s how:

1. Run the Application: Execute the following command in the terminal:

   node dist/cli.js
   

2. What Happens Next:

   • The application will fetch the current 15-minute BTC Up/Down market from Polymarket.
   • It will connect to the orderbook WebSocket.
   • You will see real-time bids and asks for both “Up” and “Down” outcomes.
   • The application switches to the next market automatically when the 15-minute window ends.

⏲️ Features Provided

• Live Orderbook Display: Observe live updates of the current BTC Up/Down market.
• Automatic Switching: The application automatically transitions to the new market every 15 minutes.
• Countdown Timer: Keep track of time remaining until the next market window.
• Bid/Ask Visualization: Easily see bids and asks for both outcomes, ensuring you stay informed.

📅 Schedule of Updates

The application is designed to keep you updated. The markets refresh every 15 minutes, so you won’t miss any crucial changes. Make sure to keep the application running during these intervals to receive the latest data.

❓ Troubleshooting

If you experience any issues while downloading or running the application, consider the following:

• Ensure Node.js is Installed: Verify that Node.js 22+ is correctly installed by running node -v in the terminal.
• Check Your Internet Connection: The application requires internet access to connect to Polymarket.
• Report Any Bugs: If you find any problems, please report them on the repository page for further support.

🛠️ Further Resources

• Documentation: For more information on usage and advanced features, refer to the GitHub repository.
• Community Support: Join discussions or seek help from other users in the Issues section of the repository.

⚙️ License

This project is licensed under the MIT License. You are free to use, modify, and share it under the terms of this license.

With these steps, you should be able to download and run the polymarket-orderbook-watcher application with ease. Happy trading!