pmxt 1.0.0__py3-none-any.whl

pmxt-1.0.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,56 @@
+pmxt/__init__.py,sha256=2fXPrnojQs2iC8-f3CbFQrcOlfcpZw6Gmt23dhAVtBU,1150
+pmxt/client.py,sha256=0UltGwG5_p96izSO7rhPnKM0rvIETW7jxrGc7vHsDRE,23163
+pmxt/models.py,sha256=Mu0hLVjQU3PM5m68poK61VQcJtPQ8ZdLdLU7pq1lqjQ,6004
+pmxt/server_manager.py,sha256=_RZ6bfTzmD4cnpsDcjgvoSEW_Ep6oCMHT6bGVpQNHdc,7812
+pmxt_internal/__init__.py,sha256=Ej91FVyDp8KIBWJ3r3I8oekLcQfjU8sZ2Jj_BiH4utQ,5973
+pmxt_internal/api_client.py,sha256=5jz0pLGtMs510i2nfDxGXdHu2bjpVXjiorcz5C2iLIo,27889
+pmxt_internal/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
+pmxt_internal/configuration.py,sha256=rRfzqNGjFtW4TJYkTvfrb-fl1km4jMJVG7pVx48DcXQ,18320
+pmxt_internal/exceptions.py,sha256=txF8A7vlan57JS69kFPs-IZF-Qhp7IZobBTJVa4fOaM,6644
+pmxt_internal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pmxt_internal/rest.py,sha256=FMj4yaV6XLr842u_ScWHSzQsTFdk0jaUeuWLJoRbogQ,9760
+pmxt_internal/api/__init__.py,sha256=ppJSCipQ5IAk2z6UZkFaGSsEmnoAnSSHb8sjb_DYUkY,101
+pmxt_internal/api/default_api.py,sha256=V_-PxsEbTL4atCQR1r7GbeFvhtsVdbf3TSbTRM--Pv8,147482
+pmxt_internal/models/__init__.py,sha256=KpXW3FEk-LTETIR0djQy7GX_NxGIElnIg_SzfHLmqAA,3196
+pmxt_internal/models/balance.py,sha256=Dj5kFiLrsXOZyyXTC18bPjWrgw7qdWnTgTSCmk_l6xk,2962
+pmxt_internal/models/base_request.py,sha256=ZNipF7ycXFkQJ6j3QmB1TzA0UO3fB54AMPlAgIA3KOA,2987
+pmxt_internal/models/base_response.py,sha256=g-NG4Swxl3cg4-YOCPl65dUeHzOnA9S7ubTj8HOYZs0,2975
+pmxt_internal/models/cancel_order_request.py,sha256=Q_tKEneDlyD9ZsqCifr4No9coPmzUWAiSnJFH2BhL5k,3153
+pmxt_internal/models/create_order200_response.py,sha256=f4urlJUUhTCOON-alIg9Ac_q3ymHqHyP_BNtDB0pyh4,3345
+pmxt_internal/models/create_order_params.py,sha256=byTxIMNeABia2D7j0UBPnr5qWPxq-kSI-wWJzOTRGvA,3638
+pmxt_internal/models/create_order_request.py,sha256=prj6TnIFbhB8eDq-6e-MK2DtfDzAB6P-SoEEEST0cP8,3616
+pmxt_internal/models/error_detail.py,sha256=590jlnQmIgqcjUQ5ef07_nWMn7fnyjuAvkUjmSoAkMs,2605
+pmxt_internal/models/error_response.py,sha256=c5DgOpTGqx9Qoz7hYKhRPAM3UfoX4GBWkyhfxerMXEI,2979
+pmxt_internal/models/exchange_credentials.py,sha256=BtZCkGnnGQ24KPolTRtoA_jtXp-5_1Y1FmQLe1L5WCo,3308
+pmxt_internal/models/fetch_balance200_response.py,sha256=VN5yrsVSKnI_WprK1U4wbl60jGEiSnu4VAOGkSM5K4o,3539
+pmxt_internal/models/fetch_markets200_response.py,sha256=olOMs8IBKPL2Foqw3r66jeGcRlJpOpGcGq0jNccUPuA,3564
+pmxt_internal/models/fetch_markets_request.py,sha256=2kV2N3jVPy7qKMpVMt-QiTP_Ea0Unrkq2R-qBnB5xKk,3627
+pmxt_internal/models/fetch_ohlcv200_response.py,sha256=npA7ztIBkBOIzxEX7M78eiQG03Ffb9Oko3DCw-SNLLo,3548
+pmxt_internal/models/fetch_ohlcv_request.py,sha256=-pEeahFvLwUCYka6kSdEx81ulczmPIR5UDTMRnHC9jU,3686
+pmxt_internal/models/fetch_ohlcv_request_args_inner.py,sha256=dmLOEq1cJWaIPYhik2k0urJ5-6mq5BW5uSiYTfcNQGY,5554
+pmxt_internal/models/fetch_open_orders200_response.py,sha256=LuEsylHrv7T8YcywHZFimOxUTzlHS9USSJry_ak5D3k,3543
+pmxt_internal/models/fetch_open_orders_request.py,sha256=RaE_WcwWR5EuumNQCgJYrqr2GRBYU33yjCnyJULextY,3172
+pmxt_internal/models/fetch_order_book200_response.py,sha256=u9In7XRD0ImGC0gqVEYLGDFBRE5tkCrU3WH2lZtcJvA,3374
+pmxt_internal/models/fetch_order_book_request.py,sha256=nDVf8SdXUwxwTd8-PUXvhJwObHNDzoGNt0Oq04XB5nU,3165
+pmxt_internal/models/fetch_positions200_response.py,sha256=mzEq-rEYJaZHmjqjcaW9wwT0oIwakLFp3uWpPXJEc5k,3551
+pmxt_internal/models/fetch_positions_request.py,sha256=F823DuKhltLMw04QrtSi1ZNVhkSISKz72evpWaEIaE8,3208
+pmxt_internal/models/fetch_trades200_response.py,sha256=fdsEd4luXJpzk6MuM192PaZ62fOBA3He3VreZhCd4-w,3527
+pmxt_internal/models/fetch_trades_request.py,sha256=GQZGh2dy-Y3n8DnR8x5b9bLH_nLmCmIJqjcTTNzcoSA,3690
+pmxt_internal/models/get_markets_by_slug_request.py,sha256=PtjXAw6hixHuYzCvSGH1aka2rZrsHmT8ofXYSuuOh9k,3173
+pmxt_internal/models/health_check200_response.py,sha256=yR_OkIlTPztO0zFmpyWllSwyaEbI48RpumfmVVCJAyc,2758
+pmxt_internal/models/history_filter_params.py,sha256=0i9oQLwJsRWRyzPZuW467y_0ccKpc2_I6T2lgZCkHd4,3239
+pmxt_internal/models/market_filter_params.py,sha256=Jun3HbQP05HEXlht1bYCrqrlgbO0QjP6vCOKCHkZn-E,3638
+pmxt_internal/models/market_outcome.py,sha256=STS17FU7VmS7bgOfUejJqfqNs_An3NJVqPQByBKkdgI,3200
+pmxt_internal/models/order.py,sha256=WniZ6JgnnhPBPyZje1wzgmsz4OjyOCIl5a-ksQFmUNM,4768
+pmxt_internal/models/order_book.py,sha256=FZQ5g81szBtpCun3vFFTDZb_xZkwUMVyEIF1ZZPzqhI,3615
+pmxt_internal/models/order_level.py,sha256=dMeuXlhBqe1kA-R1ysFjt77qJxx6ukrZHwO1y3hZ6EM,2735
+pmxt_internal/models/position.py,sha256=a2v8JudGks66xtSU_BILwnEhxqfTu1o01g-ShWHpkeA,3740
+pmxt_internal/models/price_candle.py,sha256=AebmNrnVl_JI0Vqy_IRoRh08qX9ZUdzzazKmnVTuyio,3151
+pmxt_internal/models/search_markets_request.py,sha256=BARoy2GXgV7RQNIGck6UaOyQqf0NIJkyGGbFf2cfZKc,3714
+pmxt_internal/models/search_markets_request_args_inner.py,sha256=PkusFd_OxhUsItsBpluPJA11zg0sXXjbOK-lPmemvLs,5561
+pmxt_internal/models/trade.py,sha256=U6Fc18rbwILs9FmX8CSDYYL8dF6763l8QzeMQNRxQdo,3328
+pmxt_internal/models/unified_market.py,sha256=mNyUrGKWxvI2f2KCa2uhGwq22cBdDia2hD5AtzFw8fE,4487
+pmxt-1.0.0.dist-info/METADATA,sha256=M0jpHTPYIOK3Ey0aGpjZyWTfytC_2tjPAZKgGalIyfA,6300
+pmxt-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pmxt-1.0.0.dist-info/top_level.txt,sha256=J_jrcouJ-x-5lpcXMxeW0GOSi1HsBVR5_PdSfvigVrw,19
+pmxt-1.0.0.dist-info/RECORD,,

pmxt-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pmxt-1.0.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+pmxt
+pmxt_internal

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_internal/api/__init__.py

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