pmxt

# PMXT

> One API for supported prediction markets. Unified data and hosted catalog search across Polymarket, Kalshi, Limitless, Smarkets, and 12 more venues. Trading where venues expose writes.

Docs: https://pmxt.dev/docs
API Base: https://api.pmxt.dev
Dashboard: https://pmxt.dev/dashboard
GitHub: https://github.com/pmxt-dev/pmxt

## Pages

- [Introduction](https://pmxt.dev/docs/introduction): One API for supported prediction markets. Unified data, hosted catalog search, and venue-native trading where supported.
- [Quickstart](https://pmxt.dev/docs/quickstart): API key to working code in 30 seconds.
- [Trading Quickstart](https://pmxt.dev/docs/trading-quickstart): Place your first hosted trade in 60 seconds — API key, escrow deposit, market order.
- [Authentication](https://pmxt.dev/docs/authentication): API keys, SDK setup, and venue credentials.
- [MCP Server](https://pmxt.dev/docs/mcp): Give AI assistants access to prediction markets via the Model Context Protocol.
- [Security & Credential Handling](https://pmxt.dev/docs/security): How PMXT handles credentials in hosted vs self-hosted modes, what risks to understand, and how to protect yourself.
- [Rate Limits](https://pmxt.dev/docs/rate-limits): How much traffic your API key gives you.
- [Prediction Markets 101](https://pmxt.dev/docs/concepts/prediction-markets-101): What a prediction market is, what an outcome is, and what 'price' means here.
- [Unified Schema](https://pmxt.dev/docs/concepts/unified-schema): One shape for events, markets, and outcomes — across every venue.
- [Supported Venues](https://pmxt.dev/docs/concepts/venues): Every venue PMXT currently speaks.
- [Hosted Trading](https://pmxt.dev/docs/concepts/hosted-trading): The hosted-default execution path — how PMXT routes orders, the non-custodial PreFundedEscrow, and when to switch to self-hosted.
- [Catalog UUID vs Venue ID](https://pmxt.dev/docs/concepts/catalog-uuid-vs-venue-id): Two ways to identify a market. The hosted trading API accepts either — here's when each matters.
- [Escrow Lifecycle](https://pmxt.dev/docs/guides/escrow-lifecycle): Deposit, trade, withdraw — how USDC moves through PMXT's non-custodial PreFundedEscrow.
- [Signing Orders](https://pmxt.dev/docs/guides/signing): What the SDK does for you, and how to plug in a custom signer if you need one.
- [Handling Hosted Errors](https://pmxt.dev/docs/guides/hosted-errors): Every common hosted-trading error, when it fires, and how to recover.
- [Coming from Polymarket's official SDK](https://pmxt.dev/docs/guides/migrate-to-hosted-trading): Credential and signatureType mapping for users moving off @polymarket/clob-client.
- [Self-hosted (Advanced)](https://pmxt.dev/docs/guides/self-hosted): Run pmxt-core on your own machine when hosted mode isn't the right fit.
- [Server Management](https://pmxt.dev/docs/sdk/server): The SDK auto-spawns and manages pmxt-core when running self-hosted.
- [What is the Router?](https://pmxt.dev/docs/router/overview): One API key. Hosted catalog search, matching, and price comparison.
- [Search](https://pmxt.dev/docs/router/search): Search events and markets across the hosted catalog in a single query.
- [Find Similar Events](https://pmxt.dev/docs/router/event-matching): Discover cross-venue event clusters and the markets inside each matched event.
- [Find Similar Markets](https://pmxt.dev/docs/router/matching): Discover cross-venue market clusters with relation types, confidence scores, and source markets.
- [Compare Prices Across Venues](https://pmxt.dev/docs/router/prices): Compare prices across venues and find related markets.
- [Overview](https://pmxt.dev/docs/api-reference/overview): The full venue pass-through surface — auto-generated from pmxt-core.
- [Server Health Check](https://pmxt.dev/docs/api-reference/healthCheck)
- [Load Markets](https://pmxt.dev/docs/api-reference/loadMarkets): Load and cache all markets from the exchange into `this.markets` and `this.marketsBySlug`. Subsequent calls return the cached result without hitting the API again. This is the correct way to paginate or iterate over markets without drift. Because `fetchMarkets()` always hits the API, repeated calls with different `offset` values may return inconsistent results if the exchange reorders or adds markets between requests. Use `loadMarkets()` once to get a stable snapshot, then paginate over `Object.values(exchange.markets)` locally.
- [Close](https://pmxt.dev/docs/api-reference/close): Close all WebSocket connections and clean up resources. Call this when you're done streaming to properly release connections.
- [Fetch Events](https://pmxt.dev/docs/api-reference/fetch-events)
- [Fetch Events Paginated](https://pmxt.dev/docs/api-reference/fetchEventsPaginated): Paginated variant of {@link fetchEvents}. On the first call (no `cursor`), all events are fetched from the exchange and cached in an in-memory snapshot. A cursor is returned along with the first page. Subsequent calls with that cursor serve additional pages directly from the cached snapshot -- no additional API calls are made. The snapshot is invalidated after `snapshotTTL` ms (configured via `ExchangeOptions` in the constructor). A request using a cursor from an expired snapshot throws `'Cursor has expired'`.
- [Fetch Event](https://pmxt.dev/docs/api-reference/fetch-event)
- [Fetch Markets](https://pmxt.dev/docs/api-reference/fetch-markets)
- [Fetch Markets Paginated](https://pmxt.dev/docs/api-reference/fetchMarketsPaginated): Fetch markets with cursor-based pagination backed by a stable in-memory snapshot. On the first call (or when no cursor is supplied), fetches all markets once and caches them. Subsequent calls with a cursor returned from a previous call slice directly from the cached snapshot — no additional API calls are made. The snapshot is invalidated after `snapshotTTL` ms (configured via `ExchangeOptions` in the constructor). A request using a cursor from an expired snapshot throws `'Cursor has expired'`.
- [Fetch Market](https://pmxt.dev/docs/api-reference/fetch-market)
- [Create Order](https://pmxt.dev/docs/api-reference/createOrderHosted): Place a buy or sell order on Polymarket, Opinion, or Limitless. Returns the resulting order with id, fill status, average price, fees, and the on-chain tx hash once it settles.
- [Build Order](https://pmxt.dev/docs/api-reference/buildOrderHosted): Build an order *without* placing it. Returns the order's typed-data payload (for the wallet to sign) plus a `built_order_id` to pass to `submitOrderHosted` once it's signed.
- [Submit Order](https://pmxt.dev/docs/api-reference/submitOrderHosted): Submit a signed order returned by `buildOrderHosted` and get back the resulting order — id, fill status, average price, and the on-chain tx hash once it settles.
- [Cancel Order](https://pmxt.dev/docs/api-reference/cancelOrderHosted): Start a cancel on an existing open order. Returns the cancel payload for the wallet to sign — you then submit the signature to `POST /v0/orders/cancel`.
- [Fetch Order](https://pmxt.dev/docs/api-reference/fetchOrderHosted): Look up a single order by id. Returns the order's current status, filled / remaining size, average fill price, and — once settled — the on-chain tx hash.
- [Fetch Open Orders](https://pmxt.dev/docs/api-reference/fetchOpenOrdersHosted): List the wallet's resting orders that haven't filled or been cancelled yet. Each entry has the market, outcome, side, size, price, and time-in-force.
- [Fetch My Trades](https://pmxt.dev/docs/api-reference/fetchMyTradesHosted): List the wallet's historical fills on Polymarket, Opinion, and Limitless. Each trade carries the executed price (net of venue fees), size, and on-chain settlement tx hash.
- [Fetch Positions](https://pmxt.dev/docs/api-reference/fetchPositionsHosted): List the open positions held by `address` across Polymarket, Opinion, and Limitless. Each position carries the market, outcome, share count, and average entry price.
- [Fetch Balance](https://pmxt.dev/docs/api-reference/fetchBalanceHosted): Check the USDC available for trading. Returns the wallet's balance inside the PMXT escrow on Polygon — *not* the wallet's on-chain USDC balance.
- [Fetch matched event clusters](https://pmxt.dev/docs/api-reference/getV0Matched-event-clusters): Returns connected clusters of semantically matched events across venues. Use this endpoint to browse or anchor event-level matches while preserving each venue's child markets.
- [Fetch matched market clusters](https://pmxt.dev/docs/api-reference/getV0Matched-market-clusters): Returns connected clusters of semantically matched markets across venues. Use this endpoint to browse or anchor market-level matches without flattening the response into pairwise rows.
- [Fetch OHLCV](https://pmxt.dev/docs/api-reference/fetch-ohlcv)
- [Fetch Order Book](https://pmxt.dev/docs/api-reference/fetch-order-book)
- [Fetch Order Books](https://pmxt.dev/docs/api-reference/fetchOrderBooks): Batch variant of {@link fetchOrderBook}. Fetches order books for multiple outcomes in a single request where the exchange supports it.
- [Fetch Trades](https://pmxt.dev/docs/api-reference/fetchTrades): Fetch raw trade history for a specific outcome.
- [Get Execution Price](https://pmxt.dev/docs/api-reference/getExecutionPrice): Calculate the volume-weighted average execution price for a given order size. Returns 0 if the order cannot be fully filled.
- [Get Execution Price Detailed](https://pmxt.dev/docs/api-reference/getExecutionPriceDetailed): Calculate detailed execution price information including partial fill data.
- [WebSocket Overview](https://pmxt.dev/docs/api-reference/websocket): Real-time orderbook and trade streaming via WebSocket
- [watchAllOrderBooks](https://pmxt.dev/docs/api-reference/watch-all-order-books): Stream live orderbook updates across one venue or all venues via WebSocket
- [watchOrderBook](https://pmxt.dev/docs/api-reference/watch-order-book): Stream real-time orderbook updates for a single outcome via WebSocket
- [watchOrderBooks](https://pmxt.dev/docs/api-reference/watch-order-books): Stream real-time orderbook updates for multiple outcomes via WebSocket
- [watchTrades](https://pmxt.dev/docs/api-reference/watch-trades): Stream real-time trade updates for a single outcome via WebSocket
- [List Available Feeds](https://pmxt.dev/docs/api-reference/feedList): Returns the list of available data feed providers.
- [Load Feed Markets](https://pmxt.dev/docs/api-reference/feedLoadMarkets): Returns all trading pairs supported by this feed.
- [Fetch Ticker](https://pmxt.dev/docs/api-reference/feedFetchTicker): Returns the latest ticker for a single symbol.
- [Fetch Tickers](https://pmxt.dev/docs/api-reference/feedFetchTickers): Returns the latest tickers for all symbols, or a filtered subset.
- [Fetch OHLCV](https://pmxt.dev/docs/api-reference/feedFetchOHLCV): Returns OHLCV candle data for a symbol.
- [Fetch Order Book](https://pmxt.dev/docs/api-reference/feedFetchOrderBook): Returns the current order book for a symbol (where supported).
- [Watch Ticker (WebSocket)](https://pmxt.dev/docs/api-reference/feedWatchTicker): Stream live ticker updates for a symbol via WebSocket.
- [Fetch Oracle Round](https://pmxt.dev/docs/api-reference/feedFetchOracleRound): Returns the latest Chainlink oracle round for a price feed.
- [Fetch Oracle History](https://pmxt.dev/docs/api-reference/feedFetchOracleHistory): Returns historical Chainlink oracle rounds for a price feed.
- [Fetch Historical Prices](https://pmxt.dev/docs/api-reference/feedFetchHistoricalPrices): Returns historical price data as tickers within a time range.
- [Get Auth Nonce](https://pmxt.dev/docs/api-reference/getAuthNonce): Get a cryptographic nonce for Web3 login.
- [Login With Signature](https://pmxt.dev/docs/api-reference/loginWithSignature): Login with a signed nonce to obtain session credentials.
- [Logout](https://pmxt.dev/docs/api-reference/logout): Logout and invalidate the current session.
- [Is Session Active](https://pmxt.dev/docs/api-reference/isSessionActive): Check if a session is active for the given wallet address.
- [Fetch Series](https://pmxt.dev/docs/api-reference/fetchSeries): Fetch the recurring series (fourth tier above Event -> Market -> Outcome) that this venue exposes. Returns an empty array on venues without a series concept (Limitless, Smarkets, Probable, Metaculus, Baozi, Hyperliquid, SuiBets, Polymarket US). - `params.id` -> a single matching series with its events populated where supported. - no params -> the full list, typically without nested events for payload size.
- [Fetch Event Metadata](https://pmxt.dev/docs/api-reference/fetchEventMetadata): Fetch venue-native metadata for a specific event when the exchange exposes a dedicated metadata endpoint. Kalshi implements this for `GET /events/{event_ticker}/metadata`.
- [Execute a read-only SQL query against ClickHouse](https://pmxt.dev/docs/api-reference/postV0Sql)

## Full documentation

See [llms-full.txt](https://pmxt.dev/docs/llms-full.txt) for the complete documentation.

More agent context in pmxt-dev/pmxt

One other file this repository gives its agents.