pmxt 0.1.0__tar.gz → 1.0.0__tar.gz

pmxt-1.0.0/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.4
+Name: pmxt
+Version: 1.0.0
+Summary: Unified prediction market data API - The ccxt for prediction markets
+Author: PMXT Contributors
+License: MIT
+Project-URL: Homepage, https://github.com/pmxt-dev/pmxt
+Project-URL: Documentation, https://github.com/pmxt-dev/pmxt#readme
+Project-URL: Repository, https://github.com/pmxt-dev/pmxt
+Project-URL: Issues, https://github.com/pmxt-dev/pmxt/issues
+Keywords: prediction markets,polymarket,kalshi,trading,api
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3>=1.26.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+
+# PMXT Python SDK
+
+A unified Python interface for interacting with multiple prediction market exchanges (Kalshi, Polymarket).
+
+> **Note**: This SDK requires the PMXT sidecar server to be running. See [Installation](#installation) below.
+
+## Installation
+
+```bash
+pip install pmxt
+```
+
+**Prerequisites**: The Python SDK requires the PMXT server, which is distributed via npm:
+
+```bash
+npm install -g pmxtjs
+```
+
+That's it! The server will start automatically when you use the SDK.
+
+## Quick Start
+
+```python
+import pmxt
+
+# Initialize exchanges (server starts automatically!)
+poly = pmxt.Polymarket()
+kalshi = pmxt.Kalshi()
+
+# Search for markets
+markets = poly.search_markets("Trump")
+print(markets[0].title)
+
+# Get outcome details
+outcome = markets[0].outcomes[0]
+print(f"{outcome.label}: {outcome.price * 100:.1f}%")
+
+# Fetch historical data (use outcome.id!)
+candles = poly.fetch_ohlcv(
+    outcome.id,
+    pmxt.HistoryFilterParams(resolution="1d", limit=30)
+)
+
+# Get current order book
+order_book = poly.fetch_order_book(outcome.id)
+spread = order_book.asks[0].price - order_book.bids[0].price
+print(f"Spread: {spread * 100:.2f}%")
+```
+
+### How It Works
+
+The Python SDK automatically manages the PMXT sidecar server:
+
+1. **First API call**: Checks if server is running
+2. **Auto-start**: Starts server if needed (takes ~1-2 seconds)
+3. **Reuse**: Multiple Python processes share the same server
+4. **Zero config**: Just import and use!
+
+### Manual Server Control (Optional)
+
+If you prefer to manage the server yourself:
+
+```python
+# Disable auto-start
+poly = pmxt.Polymarket(auto_start_server=False)
+
+# Or start the server manually in a separate terminal
+# $ pmxt-server
+```
+
+## Authentication (for Trading)
+
+### Polymarket
+
+Requires your **Polygon Private Key**:
+
+```python
+import os
+import pmxt
+
+poly = pmxt.Polymarket(
+    private_key=os.getenv("POLYMARKET_PRIVATE_KEY")
+)
+
+# Check balance
+balances = poly.fetch_balance()
+print(f"Available: ${balances[0].available}")
+
+# Place order
+order = poly.create_order(pmxt.CreateOrderParams(
+    market_id="663583",
+    outcome_id="10991849...",
+    side="buy",
+    type="limit",
+    amount=10,
+    price=0.55
+))
+```
+
+### Kalshi
+
+Requires **API Key** and **Private Key**:
+
+```python
+import os
+import pmxt
+
+kalshi = pmxt.Kalshi(
+    api_key=os.getenv("KALSHI_API_KEY"),
+    private_key=os.getenv("KALSHI_PRIVATE_KEY")
+)
+
+# Check positions
+positions = kalshi.fetch_positions()
+for pos in positions:
+    print(f"{pos.outcome_label}: ${pos.unrealized_pnl:.2f}")
+```
+
+## API Reference
+
+### Market Data Methods
+
+- `fetch_markets(params?)` - Get active markets
+- `search_markets(query, params?)` - Search markets by keyword
+- `get_markets_by_slug(slug)` - Get market by URL slug/ticker
+- `fetch_ohlcv(outcome_id, params)` - Get historical price candles
+- `fetch_order_book(outcome_id)` - Get current order book
+- `fetch_trades(outcome_id, params)` - Get trade history
+
+### Trading Methods (require authentication)
+
+- `create_order(params)` - Place a new order
+- `cancel_order(order_id)` - Cancel an open order
+- `fetch_order(order_id)` - Get order details
+- `fetch_open_orders(market_id?)` - Get all open orders
+
+### Account Methods (require authentication)
+
+- `fetch_balance()` - Get account balance
+- `fetch_positions()` - Get current positions
+
+## Data Models
+
+All methods return clean Python dataclasses:
+
+```python
+@dataclass
+class UnifiedMarket:
+    id: str
+    title: str
+    outcomes: List[MarketOutcome]
+    volume_24h: float
+    liquidity: float
+    url: str
+    # ... more fields
+
+@dataclass
+class MarketOutcome:
+    id: str              # Use this for fetch_ohlcv/fetch_order_book
+    label: str           # "Trump", "Yes", etc.
+    price: float         # 0.0 to 1.0 (probability)
+    # ... more fields
+```
+
+See the [full API reference](../../API_REFERENCE.md) for complete documentation.
+
+## Important Notes
+
+### Use `outcome.id`, not `market.id`
+
+For deep-dive methods like `fetch_ohlcv()`, `fetch_order_book()`, and `fetch_trades()`, you must use the **outcome ID**, not the market ID:
+
+```python
+markets = poly.search_markets("Trump")
+outcome_id = markets[0].outcomes[0].id  # ✅ Correct
+
+candles = poly.fetch_ohlcv(outcome_id, ...)  # ✅ Works
+candles = poly.fetch_ohlcv(markets[0].id, ...)  # ❌ Wrong!
+```
+
+### Prices are 0.0 to 1.0
+
+All prices represent probabilities (0.0 to 1.0). Multiply by 100 for percentages:
+
+```python
+outcome = markets[0].outcomes[0]
+print(f"Price: {outcome.price * 100:.1f}%")  # "Price: 55.3%"
+```
+
+### Timestamps are Unix milliseconds
+
+```python
+from datetime import datetime
+
+candle = candles[0]
+dt = datetime.fromtimestamp(candle.timestamp / 1000)
+print(dt)
+```
+
+## Development
+
+```bash
+# Clone the repo
+git clone https://github.com/qoery-com/pmxt.git
+cd pmxt/sdks/python
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+```
+
+## License
+
+MIT

pmxt-1.0.0/README.md

@@ -0,0 +1,216 @@
+# PMXT Python SDK
+
+A unified Python interface for interacting with multiple prediction market exchanges (Kalshi, Polymarket).
+
+> **Note**: This SDK requires the PMXT sidecar server to be running. See [Installation](#installation) below.
+
+## Installation
+
+```bash
+pip install pmxt
+```
+
+**Prerequisites**: The Python SDK requires the PMXT server, which is distributed via npm:
+
+```bash
+npm install -g pmxtjs
+```
+
+That's it! The server will start automatically when you use the SDK.
+
+## Quick Start
+
+```python
+import pmxt
+
+# Initialize exchanges (server starts automatically!)
+poly = pmxt.Polymarket()
+kalshi = pmxt.Kalshi()
+
+# Search for markets
+markets = poly.search_markets("Trump")
+print(markets[0].title)
+
+# Get outcome details
+outcome = markets[0].outcomes[0]
+print(f"{outcome.label}: {outcome.price * 100:.1f}%")
+
+# Fetch historical data (use outcome.id!)
+candles = poly.fetch_ohlcv(
+    outcome.id,
+    pmxt.HistoryFilterParams(resolution="1d", limit=30)
+)
+
+# Get current order book
+order_book = poly.fetch_order_book(outcome.id)
+spread = order_book.asks[0].price - order_book.bids[0].price
+print(f"Spread: {spread * 100:.2f}%")
+```
+
+### How It Works
+
+The Python SDK automatically manages the PMXT sidecar server:
+
+1. **First API call**: Checks if server is running
+2. **Auto-start**: Starts server if needed (takes ~1-2 seconds)
+3. **Reuse**: Multiple Python processes share the same server
+4. **Zero config**: Just import and use!
+
+### Manual Server Control (Optional)
+
+If you prefer to manage the server yourself:
+
+```python
+# Disable auto-start
+poly = pmxt.Polymarket(auto_start_server=False)
+
+# Or start the server manually in a separate terminal
+# $ pmxt-server
+```
+
+## Authentication (for Trading)
+
+### Polymarket
+
+Requires your **Polygon Private Key**:
+
+```python
+import os
+import pmxt
+
+poly = pmxt.Polymarket(
+    private_key=os.getenv("POLYMARKET_PRIVATE_KEY")
+)
+
+# Check balance
+balances = poly.fetch_balance()
+print(f"Available: ${balances[0].available}")
+
+# Place order
+order = poly.create_order(pmxt.CreateOrderParams(
+    market_id="663583",
+    outcome_id="10991849...",
+    side="buy",
+    type="limit",
+    amount=10,
+    price=0.55
+))
+```
+
+### Kalshi
+
+Requires **API Key** and **Private Key**:
+
+```python
+import os
+import pmxt
+
+kalshi = pmxt.Kalshi(
+    api_key=os.getenv("KALSHI_API_KEY"),
+    private_key=os.getenv("KALSHI_PRIVATE_KEY")
+)
+
+# Check positions
+positions = kalshi.fetch_positions()
+for pos in positions:
+    print(f"{pos.outcome_label}: ${pos.unrealized_pnl:.2f}")
+```
+
+## API Reference
+
+### Market Data Methods
+
+- `fetch_markets(params?)` - Get active markets
+- `search_markets(query, params?)` - Search markets by keyword
+- `get_markets_by_slug(slug)` - Get market by URL slug/ticker
+- `fetch_ohlcv(outcome_id, params)` - Get historical price candles
+- `fetch_order_book(outcome_id)` - Get current order book
+- `fetch_trades(outcome_id, params)` - Get trade history
+
+### Trading Methods (require authentication)
+
+- `create_order(params)` - Place a new order
+- `cancel_order(order_id)` - Cancel an open order
+- `fetch_order(order_id)` - Get order details
+- `fetch_open_orders(market_id?)` - Get all open orders
+
+### Account Methods (require authentication)
+
+- `fetch_balance()` - Get account balance
+- `fetch_positions()` - Get current positions
+
+## Data Models
+
+All methods return clean Python dataclasses:
+
+```python
+@dataclass
+class UnifiedMarket:
+    id: str
+    title: str
+    outcomes: List[MarketOutcome]
+    volume_24h: float
+    liquidity: float
+    url: str
+    # ... more fields
+
+@dataclass
+class MarketOutcome:
+    id: str              # Use this for fetch_ohlcv/fetch_order_book
+    label: str           # "Trump", "Yes", etc.
+    price: float         # 0.0 to 1.0 (probability)
+    # ... more fields
+```
+
+See the [full API reference](../../API_REFERENCE.md) for complete documentation.
+
+## Important Notes
+
+### Use `outcome.id`, not `market.id`
+
+For deep-dive methods like `fetch_ohlcv()`, `fetch_order_book()`, and `fetch_trades()`, you must use the **outcome ID**, not the market ID:
+
+```python
+markets = poly.search_markets("Trump")
+outcome_id = markets[0].outcomes[0].id  # ✅ Correct
+
+candles = poly.fetch_ohlcv(outcome_id, ...)  # ✅ Works
+candles = poly.fetch_ohlcv(markets[0].id, ...)  # ❌ Wrong!
+```
+
+### Prices are 0.0 to 1.0
+
+All prices represent probabilities (0.0 to 1.0). Multiply by 100 for percentages:
+
+```python
+outcome = markets[0].outcomes[0]
+print(f"Price: {outcome.price * 100:.1f}%")  # "Price: 55.3%"
+```
+
+### Timestamps are Unix milliseconds
+
+```python
+from datetime import datetime
+
+candle = candles[0]
+dt = datetime.fromtimestamp(candle.timestamp / 1000)
+print(dt)
+```
+
+## Development
+
+```bash
+# Clone the repo
+git clone https://github.com/qoery-com/pmxt.git
+cd pmxt/sdks/python
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+```
+
+## License
+
+MIT

pmxt-1.0.0/generated/pmxt_internal/__init__.py

@@ -0,0 +1,124 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    PMXT Sidecar API
+
+    A unified local sidecar API for prediction markets (Polymarket, Kalshi). This API acts as a JSON-RPC-style gateway. Each endpoint corresponds to a specific method on the generic exchange implementation. 
+
+    The version of the OpenAPI document: 0.4.4
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "DefaultApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "Balance",
+    "BaseRequest",
+    "BaseResponse",
+    "CancelOrderRequest",
+    "CreateOrder200Response",
+    "CreateOrderParams",
+    "CreateOrderRequest",
+    "ErrorDetail",
+    "ErrorResponse",
+    "ExchangeCredentials",
+    "FetchBalance200Response",
+    "FetchMarkets200Response",
+    "FetchMarketsRequest",
+    "FetchOHLCV200Response",
+    "FetchOHLCVRequest",
+    "FetchOHLCVRequestArgsInner",
+    "FetchOpenOrders200Response",
+    "FetchOpenOrdersRequest",
+    "FetchOrderBook200Response",
+    "FetchOrderBookRequest",
+    "FetchPositions200Response",
+    "FetchPositionsRequest",
+    "FetchTrades200Response",
+    "FetchTradesRequest",
+    "GetMarketsBySlugRequest",
+    "HealthCheck200Response",
+    "HistoryFilterParams",
+    "MarketFilterParams",
+    "MarketOutcome",
+    "Order",
+    "OrderBook",
+    "OrderLevel",
+    "Position",
+    "PriceCandle",
+    "SearchMarketsRequest",
+    "SearchMarketsRequestArgsInner",
+    "Trade",
+    "UnifiedMarket",
+]
+
+# import apis into sdk package
+from pmxt_internal.api.default_api import DefaultApi as DefaultApi
+
+# import ApiClient
+from pmxt_internal.api_response import ApiResponse as ApiResponse
+from pmxt_internal.api_client import ApiClient as ApiClient
+from pmxt_internal.configuration import Configuration as Configuration
+from pmxt_internal.exceptions import OpenApiException as OpenApiException
+from pmxt_internal.exceptions import ApiTypeError as ApiTypeError
+from pmxt_internal.exceptions import ApiValueError as ApiValueError
+from pmxt_internal.exceptions import ApiKeyError as ApiKeyError
+from pmxt_internal.exceptions import ApiAttributeError as ApiAttributeError
+from pmxt_internal.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from pmxt_internal.models.balance import Balance as Balance
+from pmxt_internal.models.base_request import BaseRequest as BaseRequest
+from pmxt_internal.models.base_response import BaseResponse as BaseResponse
+from pmxt_internal.models.cancel_order_request import CancelOrderRequest as CancelOrderRequest
+from pmxt_internal.models.create_order200_response import CreateOrder200Response as CreateOrder200Response
+from pmxt_internal.models.create_order_params import CreateOrderParams as CreateOrderParams
+from pmxt_internal.models.create_order_request import CreateOrderRequest as CreateOrderRequest
+from pmxt_internal.models.error_detail import ErrorDetail as ErrorDetail
+from pmxt_internal.models.error_response import ErrorResponse as ErrorResponse
+from pmxt_internal.models.exchange_credentials import ExchangeCredentials as ExchangeCredentials
+from pmxt_internal.models.fetch_balance200_response import FetchBalance200Response as FetchBalance200Response
+from pmxt_internal.models.fetch_markets200_response import FetchMarkets200Response as FetchMarkets200Response
+from pmxt_internal.models.fetch_markets_request import FetchMarketsRequest as FetchMarketsRequest
+from pmxt_internal.models.fetch_ohlcv200_response import FetchOHLCV200Response as FetchOHLCV200Response
+from pmxt_internal.models.fetch_ohlcv_request import FetchOHLCVRequest as FetchOHLCVRequest
+from pmxt_internal.models.fetch_ohlcv_request_args_inner import FetchOHLCVRequestArgsInner as FetchOHLCVRequestArgsInner
+from pmxt_internal.models.fetch_open_orders200_response import FetchOpenOrders200Response as FetchOpenOrders200Response
+from pmxt_internal.models.fetch_open_orders_request import FetchOpenOrdersRequest as FetchOpenOrdersRequest
+from pmxt_internal.models.fetch_order_book200_response import FetchOrderBook200Response as FetchOrderBook200Response
+from pmxt_internal.models.fetch_order_book_request import FetchOrderBookRequest as FetchOrderBookRequest
+from pmxt_internal.models.fetch_positions200_response import FetchPositions200Response as FetchPositions200Response
+from pmxt_internal.models.fetch_positions_request import FetchPositionsRequest as FetchPositionsRequest
+from pmxt_internal.models.fetch_trades200_response import FetchTrades200Response as FetchTrades200Response
+from pmxt_internal.models.fetch_trades_request import FetchTradesRequest as FetchTradesRequest
+from pmxt_internal.models.get_markets_by_slug_request import GetMarketsBySlugRequest as GetMarketsBySlugRequest
+from pmxt_internal.models.health_check200_response import HealthCheck200Response as HealthCheck200Response
+from pmxt_internal.models.history_filter_params import HistoryFilterParams as HistoryFilterParams
+from pmxt_internal.models.market_filter_params import MarketFilterParams as MarketFilterParams
+from pmxt_internal.models.market_outcome import MarketOutcome as MarketOutcome
+from pmxt_internal.models.order import Order as Order
+from pmxt_internal.models.order_book import OrderBook as OrderBook
+from pmxt_internal.models.order_level import OrderLevel as OrderLevel
+from pmxt_internal.models.position import Position as Position
+from pmxt_internal.models.price_candle import PriceCandle as PriceCandle
+from pmxt_internal.models.search_markets_request import SearchMarketsRequest as SearchMarketsRequest
+from pmxt_internal.models.search_markets_request_args_inner import SearchMarketsRequestArgsInner as SearchMarketsRequestArgsInner
+from pmxt_internal.models.trade import Trade as Trade
+from pmxt_internal.models.unified_market import UnifiedMarket as UnifiedMarket
+

pmxt-1.0.0/generated/pmxt_internal/api/__init__.py

@@ -0,0 +1,5 @@
+# flake8: noqa
+
+# import apis into api package
+from pmxt_internal.api.default_api import DefaultApi
+