predictunify-docs/temp_readme at main · chendrizzy/predictunify-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<p align="center">
  <img src="assets/icon.png" alt="PredictUnify Logo" width="180" height="180" />
</p>

<h1 align="center">PredictUnify API Documentation</h1>

<p align="center">
  <strong>The Unified REST API for Polymarket Prediction Markets</strong>
</p>

<p align="center">
  <a href="https://chendrizzy.github.io/predictunify-docs/" target="_blank">
    <img src="https://img.shields.io/badge/Read%20the%20Docs-Live%20Site-blue?style=for-the-badge&logo=docusaurus" alt="Read the Docs" />
  </a>
  <a href="https://rapidapi.com/chendrizzy/api/predictunify" target="_blank">
    <img src="https://img.shields.io/badge/Subscribe%20on-RapidAPI-blue?style=for-the-badge&logo=rapidapi" alt="Available on RapidAPI" />
  </a>
</p>

---

## ⚡️ Overview

**PredictUnify** abstracts away the complexities of the Polygon blockchain and CTF (Conditional Token Framework), enabling developers to build trading bots, dashboards, and analytics tools using standard HTTP requests.

### [➡️ Click here to view the full Documentation](https://chendrizzy.github.io/predictunify-docs/)

---

### Key Features

- **📈 Real-Time Market Data**: Live odds, volume, and liquidity for thousands of markets.
- **🤖 Algorithmic Trading**: Programmatic execution of limit and market orders.
- **📊 Historical Data**: OHLCV candlestick charts (1m to 1d intervals) for backtesting.
- **💼 Portfolio Management**: Real-time tracking of positions, P&L, and cash balance.
- **🔒 Non-Custodial**: Your keys, your funds. We pass credentials through securely and never store them.

### Quick Example

```bash
curl --request GET \
	--url 'https://predictunify.p.rapidapi.com/markets?status=active&sortBy=volume&limit=5' \
	--header 'X-RapidAPI-Key: <YOUR_RAPIDAPI_KEY>'
```

[**Get your API Key on RapidAPI**](https://rapidapi.com/chendrizzy/api/predictunify)

---

## 📄 Repository Structure

This repository contains the source code for the documentation site.

- **`docs/`**: Markdown source files for the documentation.
- **`docs/api/`**: Auto-generated API reference from OpenAPI spec.
- **`docusaurus.config.ts`**: Site configuration.

To run this documentation locally:

```bash
npm install
npm start
```