@nevuamarkets/poly-websockets 0.0.2 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/package.json +7 -3
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Poly-WebSockets
|
|
2
2
|
|
|
3
|
-
A TypeScript library for real-time Polymarket
|
|
3
|
+
A TypeScript library for **real-time Polymarket market price alerts** over **Websocket** with **automatic reconnections** and **easy subscription management**.
|
|
4
|
+
|
|
5
|
+
Powering [Nevua Markets](https://nevua.markets)
|
|
4
6
|
|
|
5
7
|
## Installation
|
|
6
8
|
|
|
@@ -10,11 +12,11 @@ npm install poly-websockets
|
|
|
10
12
|
|
|
11
13
|
## Features
|
|
12
14
|
|
|
13
|
-
- 🔄 **Automatic Connection Management**: Handles WebSocket connections, reconnections, and cleanup for grouped assetId (i.e. clobTokenId) subscriptions
|
|
14
15
|
- 📊 **Real-time Market Updates**: Get `book` , `price_change`, `tick_size_change` and `last_trade_price` real-time market events from Polymarket WSS
|
|
15
16
|
- 🎯 **Derived Future Price Event**: Implements Polymarket's [price calculation logic](https://docs.polymarket.com/polymarket-learn/trading/how-are-prices-calculated#future-price) (midpoint vs last trade price based on spread)
|
|
16
|
-
- 🚦 **Rate Limiting**: Built-in rate limiting to respect Polymarket API limits
|
|
17
17
|
- 🔗 **Group Management**: Efficiently manages multiple asset subscriptions across connection groups **without losing events** when subscribing / unsubscribing assets.
|
|
18
|
+
- 🔄 **Automatic Connection Management**: Handles WebSocket connections, reconnections, and cleanup for grouped assetId (i.e. clobTokenId) subscriptions
|
|
19
|
+
- 🚦 **Rate Limiting**: Built-in rate limiting to respect Polymarket API limits
|
|
18
20
|
- 💪 **TypeScript Support**: Full TypeScript definitions for all events and handlers
|
|
19
21
|
|
|
20
22
|
## Quick Start
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nevuamarkets/poly-websockets",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
4
4
|
"description": "Plug-and-play Polymarket WebSocket price alerts",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
],
|
|
11
11
|
"scripts": {
|
|
12
12
|
"build": "tsc",
|
|
13
|
-
"prepare": "npm run build",
|
|
13
|
+
"prepare": "npm run build && npm run test",
|
|
14
14
|
"test": "vitest run"
|
|
15
15
|
},
|
|
16
16
|
"repository": {
|
|
@@ -19,10 +19,14 @@
|
|
|
19
19
|
},
|
|
20
20
|
"keywords": [
|
|
21
21
|
"polymarket",
|
|
22
|
+
"polymarket-api",
|
|
22
23
|
"websocket",
|
|
23
24
|
"price",
|
|
24
25
|
"market",
|
|
25
|
-
"alerts"
|
|
26
|
+
"alerts",
|
|
27
|
+
"real-time",
|
|
28
|
+
"trading",
|
|
29
|
+
"prediction-markets"
|
|
26
30
|
],
|
|
27
31
|
"author": "Konstantinos Lekkas",
|
|
28
32
|
"license": "AGPL-3.0",
|