PolyOrderbooks Python SDK
Official Python client for the PolyOrderbooks API — historical Polymarket order books, prices, and liquidity metrics.
What is covered
Polymarket crypto markets: up/down rounds (5m, 15m, 4h), price thresholds, and related event markets. Order books are captured at 250ms resolution and resolved markets are stored alongside their winning outcome.
Every plan can query down to 250ms, including the free tier. Plans differ on history
window and request volume — see pricing.
Install
pip install polyorderbooks
Or install the latest from GitHub:
pip install git+https://github.com/polyorderbookslabs/polyorderbooks-python.git
Quickstart
Get an API key from polyorderbooks.com/signup, then:
import os
from datetime import datetime, timedelta, timezone
from polyorderbooks import PolyOrderbooksClient
client = PolyOrderbooksClient(api_key=os.environ["POLYORDERBOOKS_API_KEY"])
# Or rely on POLYORDERBOOKS_API_KEY in the environment:
# client = PolyOrderbooksClient()
markets = client.list_markets(search="bitcoin", limit=5)
slug = markets["data"][0]["slug"]
end = datetime.now(timezone.utc)
start = end - timedelta(hours=6)
books = client.get_market_books(
slug,
start_ts=start.isoformat().replace("+00:00", "Z"),
end_ts=end.isoformat().replace("+00:00", "Z"),
resolution="1s",
limit=100,
)
for outcome, points in books["data"].items():
for point in points[:2]:
bids = point.get("bids") or []
asks = point.get("asks") or []
best_bid = bids[0][0] if bids else None
best_ask = asks[0][0] if asks else None
print(point["t"], outcome, "bid", best_bid, "ask", best_ask)
client.close()
markets["data"] is a list of market objects. Each item includes more fields (public_id, volume, event_slug, …); the essentials look like:
[
{
"slug": "will-bitcoin-hit-150k-in-2026",
"question": "Will Bitcoin hit $150k in 2026?",
"status": "active"
},
{
"slug": "fed-rate-cut-september-2026",
"question": "Will the Fed cut rates in September 2026?",
"status": "active"
}
]
books["data"] is keyed by outcome label ("Yes", "No"), and each snapshot is
{"t", "bids", "asks"}. Ladders are [price, size] pairs, best price first —
bids descend, asks ascend. Depth varies per snapshot, so do not assume a fixed
number of levels:
{
"t": "2026-08-19T02:00:00Z",
"bids": [[0.19, 147.34], [0.18, 63.69], [0.17, 277.77]],
"asks": [[0.20, 13.6], [0.21, 152.17]]
}
A snapshot list can be empty for markets with no captures in the requested
window, so guard before indexing bids[0] / asks[0].
Context manager usage:
with PolyOrderbooksClient() as client:
usage = client.get_usage()
print(usage["plan"], usage["limits"])
Pagination
Use metadata.next_cursor manually, or helpers:
for page in client.iter_market_books(
slug,
start_ts="2026-04-01T00:00:00Z",
end_ts="2026-04-02T00:00:00Z",
resolution="1s",
):
process(page["data"])
API coverage
| Method | Endpoint |
|---|---|
get_usage() |
GET /v1/usage |
list_series(...) |
GET /v1/series |
list_events(...) |
GET /v1/events |
list_markets(...) |
GET /v1/markets |
get_market(id_or_slug) |
GET /v1/markets/{id_or_slug} |
list_tags() |
GET /v1/tags |
get_market_metrics(...) |
GET /v1/markets/{id_or_slug}/metrics |
get_market_prices(...) |
GET /v1/markets/{id_or_slug}/prices |
get_market_books(...) |
GET /v1/markets/{id_or_slug}/books |
get_token_prices(...) |
GET /v1/tokens/{token_id}/prices |
get_token_books(...) |
GET /v1/tokens/{token_id}/books |
Authentication
Send your API key via the client constructor or POLYORDERBOOKS_API_KEY. The SDK sets X-API-Key on every request (the API also accepts Authorization: Bearer pob_…).
Errors
from polyorderbooks import AuthenticationError, NotFoundError, RateLimitError, APIError
AuthenticationError— 401NotFoundError— 404RateLimitError— 429APIError— other HTTP failures
Every error carries status_code, message and the parsed body.
RateLimitError also carries retry_after, the seconds the API asked you to
wait:
import time
from polyorderbooks import RateLimitError
try:
books = client.get_market_books(slug, start_ts=..., end_ts=..., resolution="1s")
except RateLimitError as err:
time.sleep(err.retry_after or 1)
Development
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
pytest
Links
- Product: polyorderbooks.com
- Docs: docs.polyorderbooks.com
- OpenAPI: docs.polyorderbooks.com/openapi.json
License
MIT — see LICENSE.
Metadata
Release files for polyorderbooks 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| polyorderbooks-0.2.1.tar.gz | 10.4 kB | Without provenance | Details for polyorderbooks-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| polyorderbooks-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for polyorderbooks-0.2.1-py3-none-any.whl |
Total release size: 18.8 kB
Release files / polyorderbooks-0.2.1.tar.gz
| Download URL | polyorderbooks-0.2.1.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ada2675f811f63a8ad2f562a427e32de03d5e8451301951a39ae7ac2937d1920
|
|
BLAKE2b-256 checksum How to use checksums |
a8be2f0b5f6d306c70552600c045563d4c1f57ceb8837cf26aef80740a32c918
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.7
|
Release files / polyorderbooks-0.2.1-py3-none-any.whl
| Download URL | polyorderbooks-0.2.1-py3-none-any.whl |
|---|---|
| Size | 8.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d216dc3402a1cc9fdeeb1b0b0f9fa4300d3c992acb728840720212882aaa9fad
|
|
BLAKE2b-256 checksum How to use checksums |
f8a5040e04dae3af1c6661a71ca05500809c764541f286597f507735a4eb328e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.7
|
Security for polyorderbooks 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.