pmxtjs 0.3.0 → 0.4.0

package/dist/exchanges/polymarket/index.js

@@ -0,0 +1,216 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolymarketExchange = void 0;
+const BaseExchange_1 = require("../../BaseExchange");
+const fetchMarkets_1 = require("./fetchMarkets");
+const searchMarkets_1 = require("./searchMarkets");
+const getMarketsBySlug_1 = require("./getMarketsBySlug");
+const fetchOHLCV_1 = require("./fetchOHLCV");
+const fetchOrderBook_1 = require("./fetchOrderBook");
+const fetchTrades_1 = require("./fetchTrades");
+const fetchPositions_1 = require("./fetchPositions");
+const auth_1 = require("./auth");
+const clob_client_1 = require("@polymarket/clob-client");
+class PolymarketExchange extends BaseExchange_1.PredictionMarketExchange {
+    constructor(credentials) {
+        super(credentials);
+        // Initialize auth if credentials are provided
+        if (credentials?.privateKey) {
+            this.auth = new auth_1.PolymarketAuth(credentials);
+        }
+    }
+    get name() {
+        return 'Polymarket';
+    }
+    async fetchMarkets(params) {
+        return (0, fetchMarkets_1.fetchMarkets)(params);
+    }
+    async searchMarkets(query, params) {
+        return (0, searchMarkets_1.searchMarkets)(query, params);
+    }
+    async getMarketsBySlug(slug) {
+        return (0, getMarketsBySlug_1.getMarketsBySlug)(slug);
+    }
+    async fetchOHLCV(id, params) {
+        return (0, fetchOHLCV_1.fetchOHLCV)(id, params);
+    }
+    async fetchOrderBook(id) {
+        return (0, fetchOrderBook_1.fetchOrderBook)(id);
+    }
+    async fetchTrades(id, params) {
+        return (0, fetchTrades_1.fetchTrades)(id, params);
+    }
+    // ----------------------------------------------------------------------------
+    // Trading Methods
+    // ----------------------------------------------------------------------------
+    /**
+     * Ensure authentication is initialized before trading operations.
+     */
+    ensureAuth() {
+        if (!this.auth) {
+            throw new Error('Trading operations require authentication. ' +
+                'Initialize PolymarketExchange with credentials: new PolymarketExchange({ privateKey: "0x..." })');
+        }
+        return this.auth;
+    }
+    async createOrder(params) {
+        const auth = this.ensureAuth();
+        const client = await auth.getClobClient();
+        // Map side to Polymarket enum
+        const side = params.side.toUpperCase() === 'BUY' ? clob_client_1.Side.BUY : clob_client_1.Side.SELL;
+        // For limit orders, price is required
+        if (params.type === 'limit' && !params.price) {
+            throw new Error('Price is required for limit orders');
+        }
+        // For market orders, use max slippage: 0.99 for BUY (willing to pay up to 99%), 0.01 for SELL (willing to accept down to 1%)
+        const price = params.price || (side === clob_client_1.Side.BUY ? 0.99 : 0.01);
+        try {
+            // We use createAndPostOrder which handles signing and posting
+            const response = await client.createAndPostOrder({
+                tokenID: params.outcomeId,
+                price: price,
+                side: side,
+                size: params.amount,
+                feeRateBps: 0,
+            }, {
+                tickSize: "0.01"
+            });
+            if (!response || !response.success) {
+                throw new Error(response?.errorMsg || 'Order placement failed');
+            }
+            return {
+                id: response.orderID,
+                marketId: params.marketId,
+                outcomeId: params.outcomeId,
+                side: params.side,
+                type: params.type,
+                price: price,
+                amount: params.amount,
+                status: 'open',
+                filled: 0,
+                remaining: params.amount,
+                timestamp: Date.now()
+            };
+        }
+        catch (error) {
+            console.error("Polymarket createOrder error:", error);
+            throw error;
+        }
+    }
+    async cancelOrder(orderId) {
+        const auth = this.ensureAuth();
+        const client = await auth.getClobClient();
+        try {
+            await client.cancelOrder({ orderID: orderId });
+            return {
+                id: orderId,
+                marketId: 'unknown',
+                outcomeId: 'unknown',
+                side: 'buy',
+                type: 'limit',
+                amount: 0,
+                status: 'cancelled',
+                filled: 0,
+                remaining: 0,
+                timestamp: Date.now()
+            };
+        }
+        catch (error) {
+            console.error("Polymarket cancelOrder error:", error);
+            throw error;
+        }
+    }
+    async fetchOrder(orderId) {
+        const auth = this.ensureAuth();
+        const client = await auth.getClobClient();
+        try {
+            const order = await client.getOrder(orderId);
+            return {
+                id: order.id,
+                marketId: order.market || 'unknown',
+                outcomeId: order.asset_id,
+                side: order.side.toLowerCase(),
+                type: order.order_type === 'GTC' ? 'limit' : 'market',
+                price: parseFloat(order.price),
+                amount: parseFloat(order.original_size),
+                status: order.status, // Needs precise mapping
+                filled: parseFloat(order.size_matched),
+                remaining: parseFloat(order.original_size) - parseFloat(order.size_matched),
+                timestamp: order.created_at * 1000
+            };
+        }
+        catch (error) {
+            console.error("Polymarket fetchOrder error:", error);
+            throw error;
+        }
+    }
+    async fetchOpenOrders(marketId) {
+        const auth = this.ensureAuth();
+        const client = await auth.getClobClient();
+        try {
+            const orders = await client.getOpenOrders({
+                market: marketId
+            });
+            return orders.map((o) => ({
+                id: o.id,
+                marketId: o.market || 'unknown',
+                outcomeId: o.asset_id,
+                side: o.side.toLowerCase(),
+                type: 'limit',
+                price: parseFloat(o.price),
+                amount: parseFloat(o.original_size),
+                status: 'open',
+                filled: parseFloat(o.size_matched),
+                remaining: parseFloat(o.size_left || (parseFloat(o.original_size) - parseFloat(o.size_matched))),
+                timestamp: o.created_at * 1000
+            }));
+        }
+        catch (error) {
+            console.error("Polymarket fetchOpenOrders error:", error);
+            return [];
+        }
+    }
+    async fetchPositions() {
+        const auth = this.ensureAuth();
+        const address = auth.getAddress();
+        return (0, fetchPositions_1.fetchPositions)(address);
+    }
+    async fetchBalance() {
+        const auth = this.ensureAuth();
+        const client = await auth.getClobClient();
+        try {
+            // 1. Fetch raw collateral balance (USDC)
+            // Polymarket relies strictly on USDC (Polygon) which has 6 decimals.
+            const USDC_DECIMALS = 6;
+            const balRes = await client.getBalanceAllowance({
+                asset_type: clob_client_1.AssetType.COLLATERAL
+            });
+            const rawBalance = parseFloat(balRes.balance);
+            const total = rawBalance / Math.pow(10, USDC_DECIMALS);
+            // 2. Fetch open orders to calculate locked funds
+            // We only care about BUY orders for USDC balance locking
+            const openOrders = await client.getOpenOrders({});
+            let locked = 0;
+            if (openOrders && Array.isArray(openOrders)) {
+                for (const order of openOrders) {
+                    if (order.side === clob_client_1.Side.BUY) {
+                        const remainingSize = parseFloat(order.original_size) - parseFloat(order.size_matched);
+                        const price = parseFloat(order.price);
+                        locked += remainingSize * price;
+                    }
+                }
+            }
+            return [{
+                    currency: 'USDC',
+                    total: total,
+                    available: total - locked, // Available for new trades
+                    locked: locked
+                }];
+        }
+        catch (error) {
+            console.error("Polymarket fetchBalance error:", error);
+            throw error;
+        }
+    }
+}
+exports.PolymarketExchange = PolymarketExchange;

package/dist/exchanges/polymarket/searchMarkets.d.ts

@@ -0,0 +1,3 @@
+import { MarketFilterParams } from '../../BaseExchange';
+import { UnifiedMarket } from '../../types';
+export declare function searchMarkets(query: string, params?: MarketFilterParams): Promise<UnifiedMarket[]>;

package/dist/exchanges/polymarket/searchMarkets.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.searchMarkets = searchMarkets;
+const fetchMarkets_1 = require("./fetchMarkets");
+async function searchMarkets(query, params) {
+    // Polymarket Gamma API doesn't support native search
+    // Fetch all active markets and filter client-side
+    const searchLimit = 100000; // Fetch all markets for comprehensive search
+    try {
+        // Fetch markets with a higher limit
+        const markets = await (0, fetchMarkets_1.fetchMarkets)({
+            ...params,
+            limit: searchLimit
+        });
+        // Client-side text filtering
+        const lowerQuery = query.toLowerCase();
+        const searchIn = params?.searchIn || 'title'; // Default to title-only search
+        const filtered = markets.filter(market => {
+            const titleMatch = (market.title || '').toLowerCase().includes(lowerQuery);
+            const descMatch = (market.description || '').toLowerCase().includes(lowerQuery);
+            if (searchIn === 'title')
+                return titleMatch;
+            if (searchIn === 'description')
+                return descMatch;
+            return titleMatch || descMatch; // 'both'
+        });
+        // Apply limit to filtered results
+        const limit = params?.limit || 20;
+        return filtered.slice(0, limit);
+    }
+    catch (error) {
+        console.error("Error searching Polymarket data:", error);
+        return [];
+    }
+}

package/dist/exchanges/polymarket/utils.d.ts

@@ -0,0 +1,7 @@
+import { UnifiedMarket, CandleInterval } from '../../types';
+export declare const GAMMA_API_URL = "https://gamma-api.polymarket.com/events";
+export declare const CLOB_API_URL = "https://clob.polymarket.com";
+export declare function mapMarketToUnified(event: any, market: any, options?: {
+    useQuestionAsCandidateFallback?: boolean;
+}): UnifiedMarket | null;
+export declare function mapIntervalToFidelity(interval: CandleInterval): number;

package/dist/exchanges/polymarket/utils.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLOB_API_URL = exports.GAMMA_API_URL = void 0;
+exports.mapMarketToUnified = mapMarketToUnified;
+exports.mapIntervalToFidelity = mapIntervalToFidelity;
+exports.GAMMA_API_URL = 'https://gamma-api.polymarket.com/events';
+exports.CLOB_API_URL = 'https://clob.polymarket.com';
+function mapMarketToUnified(event, market, options = {}) {
+    if (!market)
+        return null;
+    const outcomes = [];
+    // Polymarket Gamma often returns 'outcomes' and 'outcomePrices' as stringified JSON keys.
+    let outcomeLabels = [];
+    let outcomePrices = [];
+    try {
+        outcomeLabels = typeof market.outcomes === 'string' ? JSON.parse(market.outcomes) : (market.outcomes || []);
+        outcomePrices = typeof market.outcomePrices === 'string' ? JSON.parse(market.outcomePrices) : (market.outcomePrices || []);
+    }
+    catch (e) {
+        console.warn(`Error parsing outcomes for market ${market.id}:`, e);
+    }
+    // Extract CLOB token IDs for granular operations
+    let clobTokenIds = [];
+    try {
+        clobTokenIds = typeof market.clobTokenIds === 'string' ? JSON.parse(market.clobTokenIds) : (market.clobTokenIds || []);
+    }
+    catch (e) {
+        // console.warn(`Error parsing clobTokenIds for market ${market.id}`, e);
+    }
+    // Extract candidate/option name from market question for better outcome labels
+    let candidateName = null;
+    if (market.groupItemTitle) {
+        candidateName = market.groupItemTitle;
+    }
+    else if (market.question && options.useQuestionAsCandidateFallback) {
+        // Fallback or sometimes question is the candidate name in nested structures
+        // Only used if explicitly requested (e.g. for getMarketsBySlug)
+        candidateName = market.question;
+    }
+    if (outcomeLabels.length > 0) {
+        outcomeLabels.forEach((label, index) => {
+            const rawPrice = outcomePrices[index] || "0";
+            // For Yes/No markets with specific candidates, use the candidate name
+            let outcomeLabel = label;
+            if (candidateName && label.toLowerCase() === 'yes') {
+                outcomeLabel = candidateName;
+            }
+            else if (candidateName && label.toLowerCase() === 'no') {
+                outcomeLabel = `Not ${candidateName}`;
+            }
+            // 24h Price Change
+            // Polymarket API provides 'oneDayPriceChange' on the market object
+            let priceChange = 0;
+            if (index === 0 || label.toLowerCase() === 'yes' || (candidateName && label === candidateName)) {
+                priceChange = Number(market.oneDayPriceChange || 0);
+            }
+            outcomes.push({
+                id: clobTokenIds[index] || String(index), // Use CLOB Token ID as the primary ID
+                label: outcomeLabel,
+                price: parseFloat(rawPrice) || 0,
+                priceChange24h: priceChange,
+                metadata: {
+                    // clobTokenId is now the main ID, but keeping it in metadata for backward compat if needed
+                    clobTokenId: clobTokenIds[index]
+                }
+            });
+        });
+    }
+    return {
+        id: market.id,
+        title: market.question ? `${event.title} - ${market.question}` : event.title,
+        description: market.description || event.description,
+        outcomes: outcomes,
+        resolutionDate: market.endDate ? new Date(market.endDate) : (market.end_date_iso ? new Date(market.end_date_iso) : new Date()),
+        volume24h: Number(market.volume24hr || market.volume_24h || 0),
+        volume: Number(market.volume || 0),
+        liquidity: Number(market.liquidity || market.rewards?.liquidity || 0),
+        openInterest: Number(market.openInterest || market.open_interest || 0),
+        url: `https://polymarket.com/event/${event.slug}`,
+        image: event.image || market.image || `https://polymarket.com/api/og?slug=${event.slug}`,
+        category: event.category || event.tags?.[0]?.label,
+        tags: event.tags?.map((t) => t.label) || []
+    };
+}
+function mapIntervalToFidelity(interval) {
+    const mapping = {
+        '1m': 1,
+        '5m': 5,
+        '15m': 15,
+        '1h': 60,
+        '6h': 360,
+        '1d': 1440
+    };
+    return mapping[interval];
+}

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 export * from './BaseExchange';
 export * from './types';
-export * from './exchanges/Polymarket';
-export * from './exchanges/Kalshi';
-import { PolymarketExchange } from './exchanges/Polymarket';
-import { KalshiExchange } from './exchanges/Kalshi';
+export * from './exchanges/polymarket';
+export * from './exchanges/kalshi';
+import { PolymarketExchange } from './exchanges/polymarket';
+import { KalshiExchange } from './exchanges/kalshi';
 declare const pmxt: {
     polymarket: typeof PolymarketExchange;
     kalshi: typeof KalshiExchange;

package/dist/index.js

@@ -16,14 +16,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BaseExchange"), exports);
 __exportStar(require("./types"), exports);
-__exportStar(require("./exchanges/Polymarket"), exports);
-__exportStar(require("./exchanges/Kalshi"), exports);
-const Polymarket_1 = require("./exchanges/Polymarket");
-const Kalshi_1 = require("./exchanges/Kalshi");
+__exportStar(require("./exchanges/polymarket"), exports);
+__exportStar(require("./exchanges/kalshi"), exports);
+const polymarket_1 = require("./exchanges/polymarket");
+const kalshi_1 = require("./exchanges/kalshi");
 const pmxt = {
-    polymarket: Polymarket_1.PolymarketExchange,
-    kalshi: Kalshi_1.KalshiExchange,
-    Polymarket: Polymarket_1.PolymarketExchange,
-    Kalshi: Kalshi_1.KalshiExchange
+    polymarket: polymarket_1.PolymarketExchange,
+    kalshi: kalshi_1.KalshiExchange,
+    Polymarket: polymarket_1.PolymarketExchange,
+    Kalshi: kalshi_1.KalshiExchange
 };
 exports.default = pmxt;

package/dist/types.d.ts

@@ -45,3 +45,41 @@ export interface Trade {
     amount: number;
     side: 'buy' | 'sell' | 'unknown';
 }
+export interface Order {
+    id: string;
+    marketId: string;
+    outcomeId: string;
+    side: 'buy' | 'sell';
+    type: 'market' | 'limit';
+    price?: number;
+    amount: number;
+    status: 'pending' | 'open' | 'filled' | 'cancelled' | 'rejected';
+    filled: number;
+    remaining: number;
+    timestamp: number;
+    fee?: number;
+}
+export interface Position {
+    marketId: string;
+    outcomeId: string;
+    outcomeLabel: string;
+    size: number;
+    entryPrice: number;
+    currentPrice: number;
+    unrealizedPnL: number;
+    realizedPnL?: number;
+}
+export interface Balance {
+    currency: string;
+    total: number;
+    available: number;
+    locked: number;
+}
+export interface CreateOrderParams {
+    marketId: string;
+    outcomeId: string;
+    side: 'buy' | 'sell';
+    type: 'market' | 'limit';
+    amount: number;
+    price?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmxtjs",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "pmxt is a unified prediction market data API. The ccxt for prediction markets.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,13 +21,17 @@
   "license": "MIT",
   "type": "commonjs",
   "dependencies": {
+    "@polymarket/clob-client": "^5.2.0",
     "axios": "^1.7.9",
+    "dotenv": "^17.2.3",
+    "ethers": "^5.8.0",
     "jest": "^30.2.0",
     "tsx": "^4.21.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",
     "@types/node": "^25.0.3",
+    "identity-obj-proxy": "^3.0.0",
     "ts-jest": "^29.4.6",
     "typescript": "^5.9.3"
   }

package/readme.md

@@ -8,7 +8,7 @@
 <table>
 <tr>
 <td rowspan="3">
-<a href="https://www.producthunt.com/products/qoery-python-sdk?embed=true&amp;utm_source=badge-featured&amp;utm_medium=badge&amp;utm_campaign=badge-qoery-python-sdk" target="_blank" rel="noopener noreferrer"><img alt="Qoery Python SDK - 50% cheaper crypto data. Now in Python. | Product Hunt" width="250" height="54" src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=1056631&amp;theme=light&amp;t=1767263265752"></a>
+<a href="https://www.producthunt.com/products/ccxt-for-prediction-markets?embed=true&amp;utm_source=badge-featured&amp;utm_medium=badge&amp;utm_campaign=badge-ccxt-for-prediction-markets" target="_blank" rel="noopener noreferrer"><img alt="CCXT for Prediction Markets - A unified API for prediction market data across exchanges. | Product Hunt" width="250" height="54" src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=1060549&amp;theme=light&amp;t=1768206672608"></a>
 </td>
 <td>
 <img src="https://img.shields.io/github/watchers/qoery-com/pmxt?style=social" alt="GitHub watchers">
@@ -54,33 +54,19 @@ Different prediction market platforms have different APIs, data formats, and con
 
 ## Quick Example
 
-Search for markets across Polymarket and Kalshi using the same API:
+Get the current price for any market in seconds:
 
 ```typescript
 import pmxt from 'pmxtjs';
 
-const query = process.argv[2] || 'Who will Trump nominate as Fed Chair?';
-console.log(`Searching for "${query}"...\n`);
+async function main() {
+  const poly = new pmxt.polymarket();
+  const [market] = await poly.searchMarkets('Trump');
 
-// Polymarket
-const polymarket = new pmxt.polymarket();
-const polyResults = await polymarket.searchMarkets(query, { sort: 'volume' });
+  console.log(`${market.title} - ${market.outcomes[0].label}: ${marketoutcomes[0].price * 100}%`);
+}
 
-console.log(`--- Polymarket Found ${polyResults.length} ---`);
-polyResults.slice(0, 10).forEach(m => {
-    const label = m.outcomes[0]?.label || 'Unknown';
-    console.log(`[${m.id}] ${m.title} - ${label} (Vol24h: $${m.volume24h.toLocaleString()})`);
-});
-
-// Kalshi
-const kalshi = new pmxt.kalshi();
-const kalshiResults = await kalshi.searchMarkets(query);
-
-console.log(`\n--- Kalshi Found ${kalshiResults.length} ---`);
-kalshiResults.slice(0, 10).forEach(m => {
-    const label = m.outcomes[0]?.label || 'Unknown';
-    console.log(`[${m.id}] ${m.title} - ${label} (Vol24h: $${m.volume24h.toLocaleString()})`);
-});
+main();
 ```
 
 ## Installation
@@ -94,13 +80,47 @@ npm install pmxtjs
 - Polymarket
 - Kalshi
 
+## Trading
+pmxt supports trading functionality (placing and cancelling orders).
+
+### Setup
+To trade, you must provide your private credentials.
+
+- **Polymarket**: Requires your Polygon Private Key. [View Setup Guide](docs/SETUP_POLYMARKET.md)
+- **Kalshi**: Requires API Key & Private Key (Coming Soon).
+
+### Trading Example
+
+```typescript
+import pmxt from 'pmxtjs';
+
+const exchange = new pmxt.Polymarket({
+    privateKey: process.env.POLYMARKET_PRIVATE_KEY
+});
+
+// Check Balance
+const balance = await exchange.fetchBalance();
+console.log('Balance:', balance);
+
+// Place an Order
+const order = await exchange.createOrder({
+    marketId: 'market-123',
+    outcomeId: 'token-id-456',
+    side: 'buy',
+    type: 'limit',
+    price: 0.50,
+    amount: 100
+});
+console.log('Order:', order);
+```
+
 ## Documentation
 
-See the [API Reference](pmxt/API_REFERENCE.md) for detailed documentation and more examples.
+See the [API Reference](API_REFERENCE.md) for detailed documentation and more examples.
 
 ## Examples
 
-Check out the [examples](pmxt/examples/) directory for more use cases:
+Check out the [examples](examples/) directory for more use cases:
 - Market search
 - Order book data
 - Historical prices