polyorderbooks 0.1.0__py3-none-any.whl

polyorderbooks/__init__.py

@@ -0,0 +1,20 @@
+"""Official Python client for the PolyOrderbooks API."""
+
+from polyorderbooks.client import PolyOrderbooksClient
+from polyorderbooks.exceptions import (
+    APIError,
+    AuthenticationError,
+    NotFoundError,
+    PolyOrderbooksError,
+    RateLimitError,
+)
+
+__all__ = [
+    "APIError",
+    "AuthenticationError",
+    "NotFoundError",
+    "PolyOrderbooksClient",
+    "PolyOrderbooksError",
+    "RateLimitError",
+]
+__version__ = "0.1.0"

polyorderbooks/_http.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import os
+from typing import Any
+
+import httpx
+
+from polyorderbooks.exceptions import (
+    APIError,
+    AuthenticationError,
+    NotFoundError,
+    RateLimitError,
+)
+
+DEFAULT_BASE_URL = "https://api.polyorderbooks.com"
+DEFAULT_TIMEOUT = 60.0
+ENV_API_KEY = "POLYORDERBOOKS_API_KEY"
+
+
+def resolve_api_key(explicit: str | None) -> str:
+    api_key = explicit or os.environ.get(ENV_API_KEY)
+    if not api_key:
+        raise ValueError(
+            "API key required. Pass api_key=... or set POLYORDERBOOKS_API_KEY."
+        )
+    return api_key
+
+
+def build_headers(api_key: str) -> dict[str, str]:
+    return {
+        "Accept": "application/json",
+        "X-API-Key": api_key,
+        "User-Agent": "polyorderbooks-python/0.1.0",
+    }
+
+
+def parse_error_message(response: httpx.Response) -> str:
+    try:
+        payload = response.json()
+    except ValueError:
+        return response.text or response.reason_phrase
+
+    if isinstance(payload, dict):
+        detail = payload.get("detail")
+        if isinstance(detail, str) and detail:
+            return detail
+        message = payload.get("message")
+        if isinstance(message, str) and message:
+            return message
+    return response.reason_phrase
+
+
+def raise_for_status(response: httpx.Response) -> None:
+    if response.is_success:
+        return
+
+    message = parse_error_message(response)
+    kwargs = {"body": None}
+    try:
+        kwargs["body"] = response.json()
+    except ValueError:
+        kwargs["body"] = response.text
+
+    status = response.status_code
+    if status == 401:
+        raise AuthenticationError(status, message, **kwargs)
+    if status == 404:
+        raise NotFoundError(status, message, **kwargs)
+    if status == 429:
+        raise RateLimitError(status, message, **kwargs)
+    raise APIError(status, message, **kwargs)
+
+
+def request_json(
+    client: httpx.Client,
+    method: str,
+    path: str,
+    *,
+    params: dict[str, Any] | None = None,
+) -> dict[str, Any]:
+    response = client.request(method, path, params=params)
+    raise_for_status(response)
+    payload = response.json()
+    if not isinstance(payload, dict):
+        raise APIError(response.status_code, "Expected JSON object response.")
+    return payload

polyorderbooks/client.py

@@ -0,0 +1,309 @@
+from __future__ import annotations
+
+from collections.abc import Iterator
+from typing import Any, Literal
+
+import httpx
+
+from polyorderbooks._http import (
+    DEFAULT_BASE_URL,
+    DEFAULT_TIMEOUT,
+    build_headers,
+    request_json,
+    resolve_api_key,
+)
+
+Resolution = Literal["1s", "60s", "1m", "5m", "10m", "15m", "1h", "6h", "1d"]
+SortField = Literal["updated_at", "created_at", "start_date", "end_date", "title"]
+SortOrder = Literal["asc", "desc"]
+TagsMatch = Literal["any", "all"]
+
+
+class PolyOrderbooksClient:
+    """Sync client for the PolyOrderbooks read API."""
+
+    def __init__(
+        self,
+        api_key: str | None = None,
+        *,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = DEFAULT_TIMEOUT,
+    ) -> None:
+        self._api_key = resolve_api_key(api_key)
+        self._base_url = base_url.rstrip("/")
+        self._client = httpx.Client(
+            base_url=self._base_url,
+            headers=build_headers(self._api_key),
+            timeout=timeout,
+        )
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> PolyOrderbooksClient:
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        self.close()
+
+    # --- Utility ---
+
+    def get_usage(self) -> dict[str, Any]:
+        """Return plan, limits, and quota usage for the authenticated API key."""
+        return request_json(self._client, "GET", "/v1/usage")
+
+    # --- Discovery ---
+
+    def list_series(
+        self,
+        *,
+        search: str | None = None,
+        tags: list[str] | str | None = None,
+        tags_match: TagsMatch = "any",
+        start_date_min: str | None = None,
+        start_date_max: str | None = None,
+        end_date_min: str | None = None,
+        end_date_max: str | None = None,
+        sort: SortField = "updated_at",
+        order: SortOrder = "desc",
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        params = self._discovery_params(
+            search=search,
+            tags=tags,
+            tags_match=tags_match,
+            start_date_min=start_date_min,
+            start_date_max=start_date_max,
+            end_date_min=end_date_min,
+            end_date_max=end_date_max,
+            sort=sort,
+            order=order,
+            limit=limit,
+            cursor=cursor,
+        )
+        return request_json(self._client, "GET", "/v1/series", params=params)
+
+    def list_events(
+        self,
+        *,
+        search: str | None = None,
+        series_id: str | None = None,
+        series_slug: str | None = None,
+        sort: SortField = "updated_at",
+        order: SortOrder = "desc",
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        params = self._discovery_params(
+            search=search,
+            series_id=series_id,
+            series_slug=series_slug,
+            sort=sort,
+            order=order,
+            limit=limit,
+            cursor=cursor,
+        )
+        return request_json(self._client, "GET", "/v1/events", params=params)
+
+    def list_markets(
+        self,
+        *,
+        search: str | None = None,
+        event_id: str | None = None,
+        event_slug: str | None = None,
+        include_closed: bool = False,
+        sort: SortField = "updated_at",
+        order: SortOrder = "desc",
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        params = self._discovery_params(
+            search=search,
+            event_id=event_id,
+            event_slug=event_slug,
+            include_closed=include_closed,
+            sort=sort,
+            order=order,
+            limit=limit,
+            cursor=cursor,
+        )
+        return request_json(self._client, "GET", "/v1/markets", params=params)
+
+    def get_market(self, id_or_slug: str) -> dict[str, Any]:
+        return request_json(
+            self._client, "GET", f"/v1/markets/{id_or_slug}"
+        )
+
+    def list_tags(self) -> dict[str, Any]:
+        return request_json(self._client, "GET", "/v1/tags")
+
+    # --- History ---
+
+    def get_market_metrics(
+        self,
+        id_or_slug: str,
+        *,
+        start_ts: str,
+        end_ts: str,
+        resolution: Resolution,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        return self._history_request(
+            f"/v1/markets/{id_or_slug}/metrics",
+            start_ts=start_ts,
+            end_ts=end_ts,
+            resolution=resolution,
+            limit=limit,
+            cursor=cursor,
+        )
+
+    def get_market_prices(
+        self,
+        id_or_slug: str,
+        *,
+        start_ts: str,
+        end_ts: str,
+        resolution: Resolution,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        return self._history_request(
+            f"/v1/markets/{id_or_slug}/prices",
+            start_ts=start_ts,
+            end_ts=end_ts,
+            resolution=resolution,
+            limit=limit,
+            cursor=cursor,
+        )
+
+    def get_market_books(
+        self,
+        id_or_slug: str,
+        *,
+        start_ts: str,
+        end_ts: str,
+        resolution: Resolution,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        return self._history_request(
+            f"/v1/markets/{id_or_slug}/books",
+            start_ts=start_ts,
+            end_ts=end_ts,
+            resolution=resolution,
+            limit=limit,
+            cursor=cursor,
+        )
+
+    def get_token_prices(
+        self,
+        token_id: str,
+        *,
+        start_ts: str,
+        end_ts: str,
+        resolution: Resolution,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        return self._history_request(
+            f"/v1/tokens/{token_id}/prices",
+            start_ts=start_ts,
+            end_ts=end_ts,
+            resolution=resolution,
+            limit=limit,
+            cursor=cursor,
+        )
+
+    def get_token_books(
+        self,
+        token_id: str,
+        *,
+        start_ts: str,
+        end_ts: str,
+        resolution: Resolution,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        return self._history_request(
+            f"/v1/tokens/{token_id}/books",
+            start_ts=start_ts,
+            end_ts=end_ts,
+            resolution=resolution,
+            limit=limit,
+            cursor=cursor,
+        )
+
+    # --- Pagination helpers ---
+
+    def iter_markets(
+        self,
+        **params: Any,
+    ) -> Iterator[dict[str, Any]]:
+        """Yield each page from ``list_markets`` until ``next_cursor`` is exhausted."""
+        yield from self._iter_pages(self.list_markets, params)
+
+    def iter_market_books(
+        self,
+        id_or_slug: str,
+        **params: Any,
+    ) -> Iterator[dict[str, Any]]:
+        """Yield each page from ``get_market_books`` until ``next_cursor`` is exhausted."""
+        yield from self._iter_pages(
+            lambda **kw: self.get_market_books(id_or_slug, **kw),
+            params,
+        )
+
+    def _history_request(
+        self,
+        path: str,
+        *,
+        start_ts: str,
+        end_ts: str,
+        resolution: Resolution,
+        limit: int | None,
+        cursor: str | None,
+    ) -> dict[str, Any]:
+        params = self._compact(
+            start_ts=start_ts,
+            end_ts=end_ts,
+            resolution=resolution,
+            limit=limit,
+            cursor=cursor,
+        )
+        return request_json(self._client, "GET", path, params=params)
+
+    def _discovery_params(self, **kwargs: Any) -> dict[str, Any]:
+        params = dict(kwargs)
+        tags = params.pop("tags", None)
+        if tags is not None:
+            if isinstance(tags, list):
+                params["tags"] = ",".join(tags)
+            else:
+                params["tags"] = tags
+        include_closed = params.pop("include_closed", None)
+        if include_closed is not None:
+            params["include_closed"] = str(include_closed).lower()
+        return self._compact(**params)
+
+    @staticmethod
+    def _compact(**kwargs: Any) -> dict[str, Any]:
+        return {key: value for key, value in kwargs.items() if value is not None}
+
+    @staticmethod
+    def _iter_pages(
+        fetch_page: Any,
+        params: dict[str, Any],
+    ) -> Iterator[dict[str, Any]]:
+        cursor: str | None = None
+        while True:
+            page_params = dict(params)
+            if cursor:
+                page_params["cursor"] = cursor
+            page = fetch_page(**page_params)
+            yield page
+            metadata = page.get("metadata") or {}
+            cursor = metadata.get("next_cursor")
+            if not cursor:
+                break

polyorderbooks/exceptions.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from typing import Any
+
+
+class PolyOrderbooksError(Exception):
+    """Base error for the PolyOrderbooks SDK."""
+
+
+class APIError(PolyOrderbooksError):
+    """HTTP error returned by the PolyOrderbooks API."""
+
+    def __init__(self, status_code: int, message: str, *, body: Any | None = None) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.message = message
+        self.body = body
+
+
+class AuthenticationError(APIError):
+    """Missing or invalid API key (401)."""
+
+
+class NotFoundError(APIError):
+    """Resource not found (404)."""
+
+
+class RateLimitError(APIError):
+    """Rate limit exceeded (429)."""

polyorderbooks-0.1.0.dist-info/METADATA

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: polyorderbooks
+Version: 0.1.0
+Summary: Official Python SDK for the PolyOrderbooks historical Polymarket data API.
+Project-URL: Homepage, https://polyorderbooks.com
+Project-URL: Documentation, https://docs.polyorderbooks.com
+Project-URL: Repository, https://github.com/polyorderbooks/python-sdk
+Project-URL: Issues, https://github.com/polyorderbooks/python-sdk/issues
+Author-email: PolyOrderbooks <contact@polyorderbooks.com>
+License: MIT
+License-File: LICENSE
+Keywords: api,order-book,polymarket,prediction-markets
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx<1.0.0,>=0.27.0
+Provides-Extra: dev
+Requires-Dist: pytest-httpx>=0.35.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# PolyOrderbooks Python SDK
+
+Official Python client for the [PolyOrderbooks API](https://docs.polyorderbooks.com) — historical Polymarket order books, prices, and liquidity metrics.
+
+[![CI](https://github.com/polyorderbooks/python-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/polyorderbooks/python-sdk/actions/workflows/ci.yml)
+
+## Install
+
+```bash
+pip install polyorderbooks
+```
+
+Or install the latest from GitHub:
+
+```bash
+pip install git+https://github.com/polyorderbooks/python-sdk.git
+```
+
+## Quickstart
+
+Get an API key from [polyorderbooks.com/signup](https://polyorderbooks.com/signup), then:
+
+```python
+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="60s",
+    limit=100,
+)
+
+for outcome, points in books["data"].items():
+    for point in points[:2]:
+        bids = point.get("b") or []
+        asks = point.get("a") 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()
+```
+
+Context manager usage:
+
+```python
+with PolyOrderbooksClient() as client:
+    usage = client.get_usage()
+    print(usage["plan"], usage["limits"])
+```
+
+## Pagination
+
+Use `metadata.next_cursor` manually, or helpers:
+
+```python
+for page in client.iter_market_books(
+    slug,
+    start_ts="2026-04-01T00:00:00Z",
+    end_ts="2026-04-02T00:00:00Z",
+    resolution="60s",
+):
+    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
+
+```python
+from polyorderbooks import AuthenticationError, NotFoundError, RateLimitError, APIError
+```
+
+- `AuthenticationError` — 401
+- `NotFoundError` — 404
+- `RateLimitError` — 429
+- `APIError` — other HTTP failures
+
+## Development
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## Links
+
+- Product: [polyorderbooks.com](https://polyorderbooks.com)
+- Docs: [docs.polyorderbooks.com](https://docs.polyorderbooks.com)
+- OpenAPI: [docs.polyorderbooks.com/openapi.json](https://docs.polyorderbooks.com/openapi.json)
+
+## License
+
+MIT — see [LICENSE](LICENSE).

polyorderbooks-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+polyorderbooks/__init__.py,sha256=JwfIUzqmssLLwgiYSfRQ9b7oWgnFBHc3D5VqoQ_8s9Y,436
+polyorderbooks/_http.py,sha256=0EF0jPjIsNrEmWLd34WAqclcoe3rJBjWH38jEv9Z5rw,2261
+polyorderbooks/client.py,sha256=YSB998crcEinpY3ru1MGl8v7A9b6dRXP0A2dcHHHHLE,8825
+polyorderbooks/exceptions.py,sha256=mgBTac_twpj5PxlKDaHZnkKzFyRM6tnN--rXWHxnq_U,689
+polyorderbooks-0.1.0.dist-info/METADATA,sha256=FJg_WKmQx9mqIQRbch1XfUy1LtfirlkwND_kdhCUNzQ,4682
+polyorderbooks-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+polyorderbooks-0.1.0.dist-info/licenses/LICENSE,sha256=lCKRPH_aMyu0sknO7QW6G7Hi7uzhW8Mc_ow2Bm4bjas,1071
+polyorderbooks-0.1.0.dist-info/RECORD,,

polyorderbooks-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

polyorderbooks-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PolyOrderbooks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.