Skip to main content

Pandas API client to Polymarket

Project description

polymarket-pandas

PyPI Python Downloads License CI codecov Code style: Ruff Docs Binder

Pandas-native Python client for the full Polymarket API surface — REST, WebSocket, Relayer, and Bridge — with automatic type coercion and DataFrame output.

Documentation | Getting Started | API Reference | Notebooks | Changelog


Features

  • 102 public methods across 9 API mixins (Gamma, CLOB, Data, Rewards, Bridge, Relayer, CTF, XTracker)
  • Every endpoint returns a pd.DataFrame with automatic type coercion (datetimes, numerics, booleans)
  • Sync + Async HTTP clients — PolymarketPandas and AsyncPolymarketPandas
  • WebSocket streaming — real-time orderbook, prices, trades, sports, crypto feeds
  • pandera schemas for column documentation and optional runtime validation
  • TypedDicts for dict-returning endpoints with full IDE autocomplete
  • Order building & EIP-712 signingbuild_order, place_order, submit_orders (DataFrame batch)
  • On-chain CTF operations — merge, split, redeem positions via web3
  • Title parsers — extract bracket bounds, directional thresholds, and sports lines from market titles
  • Auto-pagination — offset-based and cursor-based _all() methods
  • Interactive Streamlit explorer with 11 pages and Plotly charts
  • MCP server with 74 tools for Claude Code / Claude Desktop

Installation

pip install polymarket-pandas

Optional extras:

pip install "polymarket-pandas[ctf]"       # on-chain merge/split/redeem (web3)
pip install "polymarket-pandas[explorer]"   # Streamlit dashboard (11 pages)
pip install "polymarket-pandas[mcp]"        # MCP server (74 tools)

Quick Start

from polymarket_pandas import PolymarketPandas

client = PolymarketPandas()

# Get active markets sorted by volume
markets = client.get_markets(closed=False, order="volume24hr", ascending=False, limit=20)
print(markets[["slug", "question", "volume24hr", "endDate"]])

# Orderbook for a token
token_id = markets["clobTokenIds"].iloc[0]
book = client.get_orderbook(token_id)

# Price history
prices = client.get_price_history(market=token_id, interval="1d", fidelity=60)

See the Getting Started guide for a complete walkthrough.


MCP Server

Query Polymarket data from any MCP client with 74 tools covering the full API surface.

polymarket-mcp           # stdio transport
polymarket-mcp --sse     # SSE transport

Add to Claude Code / Claude Desktop (~/.claude/settings.json):

{
  "mcpServers": {
    "polymarket": {
      "command": "polymarket-mcp"
    }
  }
}

See the MCP Server guide for the full list of 74 tools and environment variables.


Interactive Explorer

pip install "polymarket-pandas[explorer]"
polymarket-explore

11 pages covering Markets, Events, Series, Tags, Orderbook, Prices, Positions, Trades, Leaderboard, Rewards, and Bridge. Each page shows the raw DataFrame, an interactive Plotly chart, and the equivalent Python code.


Configuration

All credentials are read from environment variables (or a .env file). No auth needed for public endpoints.

export POLYMARKET_ADDRESS=0xYourProxyWallet
export POLYMARKET_API_KEY=your-api-key
export POLYMARKET_API_SECRET=your-secret
export POLYMARKET_API_PASSPHRASE=your-passphrase

Or derive API keys from your private key:

client = PolymarketPandas(private_key="0xYourKey")
creds = client.derive_api_key()  # auto-sets L2 credentials

See the Configuration guide for all environment variables and authentication layers.


Examples

Script Description
btc_5min.py Find BTC 5-min market, fetch orderbook and prices
btc_5min_trade_merge.py Full trading flow: submit_orders, cancel, merge
rewards_overview.py All 7 CLOB rewards endpoints
xtracker_overview.py All 7 XTracker endpoints
market_structures.py Event structures + title parsers demo
post_only_buy.py Post-only order example
rtds_ws.py Real-Time Data Streams via WebSocket
user_ws.py Private user channel — live order and trade events

Stability

See STABILITY.md for the semver commitment and deprecation policy. In short: symbols are deprecated for at least one minor release before removal, via @typing_extensions.deprecated (which IDEs and DeprecationWarning both surface).

Contributing

See CONTRIBUTING.md. TL;DR: uv sync --all-extras && uv run pre-commit install, then the same pytest / ruff / mypy commands CI runs.

Security

See SECURITY.md. Report vulnerabilities privately via GitHub security advisories.

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

polymarket_pandas-0.10.0.tar.gz (543.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

polymarket_pandas-0.10.0-py3-none-any.whl (178.8 kB view details)

Uploaded Python 3

File details

Details for the file polymarket_pandas-0.10.0.tar.gz.

File metadata

  • Download URL: polymarket_pandas-0.10.0.tar.gz
  • Upload date:
  • Size: 543.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for polymarket_pandas-0.10.0.tar.gz
Algorithm Hash digest
SHA256 d37292490f1857d29456d7100649c53cbf9d58a036ae48635850209140dfddd7
MD5 9ff6097ae85f3fc172f34775db4b21da
BLAKE2b-256 2394f1026ffb46ea2b60b287d961a5c06f65f151ec64895732a987ddc617e5f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for polymarket_pandas-0.10.0.tar.gz:

Publisher: release.yml on sigma-quantiphi/polymarket-pandas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file polymarket_pandas-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for polymarket_pandas-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 365c9f0da5381cc31c05fcaca40467b39d2bc584608b3f13aed5172a76c099de
MD5 87f8153ffab7d61f734c3d4590396a0a
BLAKE2b-256 e20964f58d1b5d8b2ffd20b9072bd2e13c919bf3c1608931b55cc458cd11f3ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for polymarket_pandas-0.10.0-py3-none-any.whl:

Publisher: release.yml on sigma-quantiphi/polymarket-pandas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page