Skip to main content

Python SDK for Polymarket APIs (CLOB, Gamma, Data) — powered by Rust

Project description

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.username, 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(...), get_related_by_slug(slug), 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.8+.

pip install maturin
maturin develop --release

License

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

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

polyoxide-0.13.0.tar.gz (194.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.13.0-cp39-abi3-win_amd64.whl (3.5 MB view details)

Uploaded CPython 3.9+Windows x86-64

polyoxide-0.13.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.2 MB view details)

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

polyoxide-0.13.0-cp39-abi3-macosx_11_0_arm64.whl (3.0 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

polyoxide-0.13.0-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.13.0.tar.gz.

File metadata

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

File hashes

Hashes for polyoxide-0.13.0.tar.gz
Algorithm Hash digest
SHA256 d5a5d2d3a9fe0d978fe620c4b1943c8f4be71242767177fa6a0e508b48fe4904
MD5 5ae0ab8abb80086582a44107079345da
BLAKE2b-256 11df4b323e75d00fd34857010027382c48315af846314751be0c661b0800e656

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polyoxide-0.13.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 2ef40462e99cf063ce514c2c6dc439bb350ac9775bab32fa34cef1e44ac41d4d
MD5 5e26993916d6a426529ed994857d731f
BLAKE2b-256 54d073fae48dbf6564e1fdefc0a382dba077a893f1a70c1085f5643fab2ecde8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polyoxide-0.13.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 37d198ba8588ae1f3a6821ce06b9b8629e7f36ad23ef4a7bac7a6215d2fda8db
MD5 368a28c17a931eff2e5251b079892b0a
BLAKE2b-256 195c4e481edb6bcde033cf0335c0d378b04c1d6c4e459c892cf9b276b9200732

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polyoxide-0.13.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 35c80cf15965e53ef8b80c7dafd6f9a7112de62262135e140670009d2921a859
MD5 09c7036593d4dd5399f2502ad8e1e200
BLAKE2b-256 6d96f43011d72b584eeb822e1523177f1b2c99ef88ebd557c71235c0a59c80b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polyoxide-0.13.0-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 6b0da3748bf4d4a06dad3fae8b7509e727fd216ee05d25a879a0b3eff0e38dbd
MD5 7d645bca6e051702e708b10e68bb6c04
BLAKE2b-256 3477ef20cf123d6c9e920f2d1e5e9531a56c725ae2b5d94c0486a803a3e39d5a

See more details on using hashes here.

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