Skip to main content

Polyoxide

Python SDK for Polymarket APIs, powered by Rust via PyO3 and maturin.

Every client comes in async and sync variants. Async methods return Python awaitables; sync methods block via an internal Tokio runtime and release the GIL while waiting.

Async Sync API Description
Gamma GammaSync Gamma Market data, events, series, tags, comments, sports, search, users
ClobClient ClobClientSync CLOB Order book, prices, spreads, trade history, fee rates
DataApi DataApiSync Data User positions/trades/activity, leaderboard, holders, volume, open interest

Installation

pip install polyoxide

Wheels are published for Linux (x86_64, aarch64), macOS (x86_64, aarch64), and Windows (x86_64).

Quick Start

Async (Gamma -- market data)

import asyncio
from polyoxide import Gamma

async def main():
    gamma = Gamma()
    markets = await gamma.markets().list(limit=5, open=True)
    for m in markets:
        print(f"{m.question}  --  {m.slug}")

asyncio.run(main())

Sync (Gamma)

from polyoxide import GammaSync

gamma = GammaSync()
markets = gamma.markets().list(limit=5, open=True)
for m in markets:
    print(f"{m.question}  --  {m.slug}")

CLOB (order book data)

from polyoxide import ClobClientSync

clob = ClobClientSync()
book = clob.markets().order_book("TOKEN_ID")
print(book.bids, book.asks)

spread = clob.markets().spread("TOKEN_ID")
print(spread)

Data API (user positions and leaderboard)

import asyncio
from polyoxide import DataApi

async def main():
    data = DataApi()

    # Leaderboard
    leaders = await data.leaderboard().get(limit=10, time_period="WEEK")
    for t in leaders:
        print(t.user_name, t.pnl)

    # User positions
    positions = await data.user("0xADDRESS").list_positions(limit=5)
    for p in positions:
        print(p.title, p.size)

asyncio.run(main())

Client API Reference

Gamma / GammaSync

Constructed with optional base_url, timeout_ms, and pool_size keyword arguments.

Namespace Methods
.markets() get(id), get_by_slug(slug), list(...), tags(id)
.events() get(id), get_by_slug(slug), list(...), tags(id), tweet_count(id), comment_count(id)
.series() get(id), list(...)
.tags() get(id), get_by_slug(slug), list(...), get_related(id), get_related_by_slug(slug)
.comments() get(id), list(...), by_user(address)
.sports() list(), market_types(), list_teams(...)
.search() public_search(query, ...)
.user() get(address)
.health() ping()

ClobClient / ClobClientSync

No arguments required (uses public/unauthenticated endpoints).

Namespace Methods
.markets() get(condition_id), get_by_token_ids(token_ids), list(), order_book(token_id), price(token_id, side), midpoint(token_id), prices_history(token_id), neg_risk(token_id), fee_rate(token_id), tick_size(token_id), spread(token_id), last_trade_price(token_id), live_activity(condition_id), simplified(), sampling(), sampling_simplified(), calculate_price(token_id, side, amount)
.health() ping(), server_time()

DataApi / DataApiSync

Constructed with optional base_url, timeout_ms, and pool_size keyword arguments.

Namespace Methods
.user(address) list_positions(...), positions_value(...), closed_positions(...), trades(...), activity(...), traded()
.trades() list(...)
.holders() list(markets, ...)
.open_interest() get(...)
.live_volume() get(event_id)
.leaderboard() get(...)
.builders() leaderboard(...), volume(...)
.health() ping()

Result Objects

All response objects expose named properties matching the upstream JSON fields, plus:

  • .to_dict() -- convert to a plain Python dict
  • str(obj) -- JSON string representation
  • repr(obj) -- type-annotated representation

Error Handling

All exceptions inherit from PolyoxideError:

from polyoxide import PolyoxideError, ApiError, RateLimitError

try:
    markets = gamma.markets().list()
except RateLimitError:
    print("slow down")
except ApiError as e:
    print(f"API error: {e}")
except PolyoxideError as e:
    print(f"something else: {e}")
Exception When
ApiError API returned an error response
AuthenticationError Invalid or missing credentials
ValidationError Request parameters failed validation
RateLimitError Rate limit exceeded (HTTP 429)
NetworkError Connection failure
TimeoutError Request timed out

Async Support

Async clients (Gamma, ClobClient, DataApi) use pyo3-async-runtimes to bridge Rust futures into Python awaitables. They work with asyncio.run(), await, and any asyncio-compatible event loop.

Sync clients (GammaSync, ClobClientSync, DataApiSync) execute on a shared background Tokio runtime and release the GIL while blocking, so they are safe to use from threaded Python code.

Type Stubs

A .pyi stub file is included at python/polyoxide/__init__.pyi for editor autocomplete and type checking.

Building from Source

Requires Rust and Python 3.9+.

pip install maturin
maturin develop --release

License

Licensed under either of MIT or Apache-2.0 at your option.

Download files

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

Source Distribution

polyoxide-0.24.2.tar.gz (304.3 kB view details)

Uploaded Source

Built Distributions

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

polyoxide-0.24.2-cp39-abi3-win_amd64.whl (3.4 MB view details)

Uploaded CPython 3.9+Windows x86-64

polyoxide-0.24.2-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.1 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

polyoxide-0.24.2-cp39-abi3-macosx_11_0_arm64.whl (2.9 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

polyoxide-0.24.2-cp39-abi3-macosx_10_12_x86_64.whl (3.1 MB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

File details

Details for the file polyoxide-0.24.2.tar.gz.

File metadata

  • Download URL: polyoxide-0.24.2.tar.gz
  • Upload date:
  • Size: 304.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.14.1

File hashes

Hashes for polyoxide-0.24.2.tar.gz
Algorithm Hash digest
SHA256 7391acf385025dcddb8e99328db4a22e0cface80be96c1344a3db5958560d073
MD5 b20032acc854916b0be438f7ea241e1e
BLAKE2b-256 6f2032ceed8f1d7182291559f3995d1d6b44e92209019b3e747c7a08ad03e815

See more details on using hashes here.

File details

Details for the file polyoxide-0.24.2-cp39-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for polyoxide-0.24.2-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 cb0330905b5532b12ead661531ef7ae5141a4226fb392d139e09437f5397326f
MD5 e542b048bc0721d5c8544474dd0703c3
BLAKE2b-256 86884634fee311c1cc8bc9a6151fcb673cb77102425a364f22b8ea714f5104df

See more details on using hashes here.

File details

Details for the file polyoxide-0.24.2-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for polyoxide-0.24.2-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c4da6a605f27ee2c97090fe4e8e498facce4908ebbe15011b78c05bcaf1b60c9
MD5 208959f4b9ae5ca893e7d7dd54512d9d
BLAKE2b-256 356c1f9c0595ed029435ed02c3494a75ba6c74011c4ee2e1e28766096479a92d

See more details on using hashes here.

File details

Details for the file polyoxide-0.24.2-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for polyoxide-0.24.2-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 149dfe8b2ec05910bb14c22760e5b803ede409f87eef559a0d338eb4d526b5dc
MD5 76cc2b961b55395fca41b2e989dcc1d7
BLAKE2b-256 8127c111583230d48cab5420b51cd755166cd00def549c87c8c399e0f39b58fb

See more details on using hashes here.

File details

Details for the file polyoxide-0.24.2-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for polyoxide-0.24.2-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 fbfe67eeb00281f911a5a841d31b712c7d173dd73ac2661db8682da2fdd095c0
MD5 2f4ef3e7c55a9a5c5d6add596edff2e2
BLAKE2b-256 44e62d834ff22ef970e9cd09f4902df642cccf416fdeaeba29dac09370d9a09c

See more details on using hashes here.

Release history Release notifications | RSS feed

0.29.0

5 files

0.28.1

5 files

0.28.0

5 files

0.27.0

5 files

0.26.1

5 files

0.26.0

5 files

0.25.0

5 files

This release

0.24.2 This release

5 files

0.24.1

5 files

0.24.0

5 files

0.23.0

5 files

0.22.0

5 files

0.21.0

5 files

0.20.0

5 files

0.19.0

5 files

0.18.2

5 files

0.18.1

5 files

0.18.0

5 files

0.17.0

5 files

0.16.0

5 files

0.15.1

5 files

0.15.0

5 files

0.14.0

5 files

0.13.0

5 files

0.12.5

5 files

0.12.4

5 files

0.12.3

5 files

0.12.2

5 files

0.12.1

5 files

0.12.0

5 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page