polymarket-apis 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

polymarket_apis/clients/data_client.py

@@ -7,7 +7,9 @@ import httpx
 from ..types.common import EthAddress, TimeseriesPoint
 from ..types.data_types import (
     Activity,
+    EventLiveVolume,
     HolderResponse,
+    MarketValue,
     Position,
     Trade,
     UserMetric,
@@ -24,29 +26,40 @@ class PolymarketDataClient:
     def _build_url(self, endpoint: str) -> str:
         return urljoin(self.base_url, endpoint)
 
+    def get_ok(self) -> str:
+        response = self.client.get(self.base_url)
+        response.raise_for_status()
+        return response.json()["data"]
+
     def get_positions(
-            self,
-            user: str,
-            condition_id: Optional[Union[str, list[str]]] = None,
-            size_threshold: float = 1.0,
-            redeemable: Optional[bool] = None,
-            mergeable: Optional[bool] = None,
-            title: Optional[str] = None,
-            limit: int = 100,
-            offset: int = 0,
-            sort_by: Literal[
-                "TOKENS",
-                "CURRENT",
-                "INITIAL",
-                "CASHPNL",
-                "PERCENTPNL",
-                "TITLE",
-                "RESOLVING",
-                "PRICE",
-            ] = "TOKENS",
-            sort_direction: Literal["ASC", "DESC"] = "DESC",
+        self,
+        user: EthAddress,
+        condition_id: Optional[
+            Union[str, list[str]]
+        ] = None,  # mutually exclusive with event_id
+        event_id: Optional[
+            Union[int, list[int]]
+        ] = None,  # mutually exclusive with condition_id
+        size_threshold: float = 1.0,
+        redeemable: bool = False,
+        mergeable: bool = False,
+        title: Optional[str] = None,
+        limit: int = 100,
+        offset: int = 0,
+        sort_by: Literal[
+            "TOKENS",
+            "CURRENT",
+            "INITIAL",
+            "CASHPNL",
+            "PERCENTPNL",
+            "TITLE",
+            "RESOLVING",
+            "PRICE",
+            "AVGPRICE",
+        ] = "TOKENS",
+        sort_direction: Literal["ASC", "DESC"] = "DESC",
     ) -> list[Position]:
-        params = {
+        params: dict[str, str | list[str] | int | float] = {
             "user": user,
             "sizeThreshold": size_threshold,
             "limit": min(limit, 500),
@@ -56,6 +69,10 @@ class PolymarketDataClient:
             params["market"] = condition_id
         if isinstance(condition_id, list):
             params["market"] = ",".join(condition_id)
+        if isinstance(event_id, str):
+            params["eventId"] = event_id
+        if isinstance(event_id, list):
+            params["eventId"] = [str(i) for i in event_id]
         if redeemable is not None:
             params["redeemable"] = redeemable
         if mergeable is not None:
@@ -72,17 +89,20 @@ class PolymarketDataClient:
         return [Position(**pos) for pos in response.json()]
 
     def get_trades(
-            self,
-            limit: int = 100,
-            offset: int = 0,
-            taker_only: bool = True,
-            filter_type: Optional[Literal["CASH", "TOKENS"]] = None,
-            filter_amount: Optional[float] = None,
-            condition_id: Optional[str] = None,
-            user: Optional[str] = None,
-            side: Optional[Literal["BUY", "SELL"]] = None,
+        self,
+        limit: int = 100,
+        offset: int = 0,
+        taker_only: bool = True,
+        filter_type: Optional[Literal["CASH", "TOKENS"]] = None,
+        filter_amount: Optional[
+            float
+        ] = None,  # must be provided together with filter_type
+        condition_id: Optional[str | list[str]] = None,
+        event_id: Optional[int | list[int]] = None,
+        user: Optional[str] = None,
+        side: Optional[Literal["BUY", "SELL"]] = None,
     ) -> list[Trade]:
-        params = {
+        params: dict[str, int | bool | float | str | list[str]] = {
             "limit": min(limit, 500),
             "offset": offset,
             "takerOnly": taker_only,
@@ -91,8 +111,14 @@ class PolymarketDataClient:
             params["filterType"] = filter_type
         if filter_amount:
             params["filterAmount"] = filter_amount
-        if condition_id:
+        if isinstance(condition_id, str):
             params["market"] = condition_id
+        if isinstance(condition_id, list):
+            params["market"] = ",".join(condition_id)
+        if isinstance(event_id, str):
+            params["eventId"] = event_id
+        if isinstance(event_id, list):
+            params["eventId"] = [str(i) for i in event_id]
         if user:
             params["user"] = user
         if side:
@@ -103,23 +129,39 @@ class PolymarketDataClient:
         return [Trade(**trade) for trade in response.json()]
 
     def get_activity(
-            self,
-            user: str,
-            limit: int = 100,
-            offset: int = 0,
-            condition_id: Optional[Union[str, list[str]]] = None,
-            type: Optional[Union[Literal["TRADE", "SPLIT", "MERGE", "REDEEM", "REWARD", "CONVERSION"], list[Literal["TRADE", "SPLIT", "MERGE", "REDEEM", "REWARD", "CONVERSION"]]]] = None,
-            start: Optional[datetime] = None,
-            end: Optional[datetime] = None,
-            side: Optional[Literal["BUY", "SELL"]] = None,
-            sort_by: Literal["TIMESTAMP", "TOKENS", "CASH"] = "TIMESTAMP",
-            sort_direction: Literal["ASC", "DESC"] = "DESC",
+        self,
+        user: EthAddress,
+        limit: int = 100,
+        offset: int = 0,
+        condition_id: Optional[Union[str, list[str]]] = None,
+        event_id: Optional[Union[int, list[int]]] = None,
+        type: Optional[
+            Union[
+                Literal["TRADE", "SPLIT", "MERGE", "REDEEM", "REWARD", "CONVERSION"],
+                list[
+                    Literal["TRADE", "SPLIT", "MERGE", "REDEEM", "REWARD", "CONVERSION"]
+                ],
+            ]
+        ] = None,
+        start: Optional[datetime] = None,
+        end: Optional[datetime] = None,
+        side: Optional[Literal["BUY", "SELL"]] = None,
+        sort_by: Literal["TIMESTAMP", "TOKENS", "CASH"] = "TIMESTAMP",
+        sort_direction: Literal["ASC", "DESC"] = "DESC",
     ) -> list[Activity]:
-        params = {"user": user, "limit": min(limit, 500), "offset": offset}
+        params: dict[str, str | list[str] | int] = {
+            "user": user,
+            "limit": min(limit, 500),
+            "offset": offset,
+        }
         if isinstance(condition_id, str):
             params["market"] = condition_id
         if isinstance(condition_id, list):
             params["market"] = ",".join(condition_id)
+        if isinstance(event_id, str):
+            params["eventId"] = event_id
+        if isinstance(event_id, list):
+            params["eventId"] = [str(i) for i in event_id]
         if isinstance(type, str):
             params["type"] = type
         if isinstance(type, list):
@@ -140,22 +182,21 @@ class PolymarketDataClient:
         return [Activity(**activity) for activity in response.json()]
 
     def get_holders(
-            self,
-            condition_id: str,
-            limit: int = 20,
+        self,
+        condition_id: str,
+        limit: int = 500,
+        min_balance: int = 1,
     ) -> list[HolderResponse]:
-        """Takes in a condition_id and returns a list of at most 20 top holders for each corresponding token_id."""
-        params = {"market": condition_id, "limit": limit}
+        """Takes in a condition_id and returns top holders for each corresponding token_id."""
+        params = {"market": condition_id, "limit": limit, "min_balance": min_balance}
         response = self.client.get(self._build_url("/holders"), params=params)
         response.raise_for_status()
-        return [
-            HolderResponse(**holder_data) for holder_data in response.json()
-        ]
+        return [HolderResponse(**holder_data) for holder_data in response.json()]
 
     def get_value(
-            self,
-            user: str,
-            condition_ids: Optional[Union[str, list[str]]] = None,
+        self,
+        user: EthAddress,
+        condition_ids: Optional[Union[str, list[str]]] = None,
     ) -> ValueResponse:
         """
         Get the current value of a user's position in a set of markets.
@@ -175,13 +216,67 @@ class PolymarketDataClient:
         response.raise_for_status()
         return ValueResponse(**response.json()[0])
 
+    def get_closed_positions(
+        self,
+        user: EthAddress,
+        condition_ids: Optional[Union[str, list[str]]] = None,
+    ) -> list[Position]:
+        """Get all closed positions."""
+        params = {"user": user}
+        if isinstance(condition_ids, str):
+            params["market"] = condition_ids
+        if isinstance(condition_ids, list):
+            params["market"] = ",".join(condition_ids)
+
+        response = self.client.get(self._build_url("/closed-positions"), params=params)
+        response.raise_for_status()
+        return [Position(**pos) for pos in response.json()]
+
+    def get_total_markets_traded(
+        self,
+        user: EthAddress,
+    ) -> int:
+        """Get the total number of markets a user has traded in."""
+        params = {"user": user}
+
+        response = self.client.get(self._build_url("/traded"), params=params)
+        response.raise_for_status()
+        return response.json()["traded"]
+
+    def get_open_interest(
+        self,
+        condition_ids: Optional[Union[str, list[str]]] = None,
+    ) -> list[MarketValue]:
+        """Get open interest."""
+        params = {}
+
+        if isinstance(condition_ids, str):
+            params["market"] = condition_ids
+        if isinstance(condition_ids, list):
+            params["market"] = ",".join(condition_ids)
+
+        response = self.client.get(self._build_url("/oi"), params=params)
+        response.raise_for_status()
+        return [MarketValue(**oi) for oi in response.json()]
+
+    def get_live_volume(
+        self,
+        event_id: int,
+    ) -> EventLiveVolume:
+        """Get live volume for a given event."""
+        params = {"id": str(event_id)}
+
+        response = self.client.get(self._build_url("/live-volume"), params=params)
+        response.raise_for_status()
+        return EventLiveVolume(**response.json()[0])
+
     # website endpoints
 
     def get_pnl(
-            self,
-            user: EthAddress,
-            period: Literal["all", "1m", "1w", "1d"] = "all",
-            frequency: Literal["1h", "3h", "12h", "1d"] = "1h",
+        self,
+        user: EthAddress,
+        period: Literal["all", "1m", "1w", "1d"] = "all",
+        frequency: Literal["1h", "3h", "12h", "1d"] = "1h",
     ) -> list[TimeseriesPoint]:
         """Get a user's PnL timeseries in the last day, week, month or all with a given frequency."""
         params = {
@@ -190,22 +285,36 @@ class PolymarketDataClient:
             "fidelity": frequency,
         }
 
-        response = self.client.get("https://user-pnl-api.polymarket.com/user-pnl", params=params)
+        response = self.client.get(
+            "https://user-pnl-api.polymarket.com/user-pnl", params=params
+        )
         response.raise_for_status()
         return [TimeseriesPoint(**point) for point in response.json()]
 
-    def get_user_metric(self, user: EthAddress, metric: Literal["profit", "volume"] = "profit", window: Literal["1d", "7d", "30d", "all"] = "all"):
+    def get_user_metric(
+        self,
+        user: EthAddress,
+        metric: Literal["profit", "volume"] = "profit",
+        window: Literal["1d", "7d", "30d", "all"] = "all",
+    ):
         """Get a user's overall profit or volume in the last day, week, month or all."""
         params = {
             "address": user,
             "window": window,
             "limit": 1,
         }
-        response = self.client.get("https://lb-api.polymarket.com/" + metric, params=params)
+        response = self.client.get(
+            "https://lb-api.polymarket.com/" + metric, params=params
+        )
         response.raise_for_status()
         return UserMetric(**response.json()[0])
 
-    def get_leaderboard_user_rank(self, user: EthAddress, metric: Literal["profit", "volume"] = "profit", window: Literal["1d", "7d", "30d", "all"] = "all"):
+    def get_leaderboard_user_rank(
+        self,
+        user: EthAddress,
+        metric: Literal["profit", "volume"] = "profit",
+        window: Literal["1d", "7d", "30d", "all"] = "all",
+    ):
         """Get a user's rank on the leaderboard by profit or volume."""
         params = {
             "address": user,
@@ -216,17 +325,23 @@ class PolymarketDataClient:
         response.raise_for_status()
         return UserRank(**response.json()[0])
 
-    def get_leaderboard_top_users(self, metric: Literal["profit", "volume"] = "profit", window: Literal["1d", "7d", "30d", "all"] = "all", limit: int = 100):
+    def get_leaderboard_top_users(
+        self,
+        metric: Literal["profit", "volume"] = "profit",
+        window: Literal["1d", "7d", "30d", "all"] = "all",
+        limit: int = 100,
+    ):
         """Get the leaderboard of the top at most 100 users by profit or volume."""
         params = {
             "window": window,
             "limit": limit,
         }
-        response = self.client.get("https://lb-api.polymarket.com/" + metric, params=params)
+        response = self.client.get(
+            "https://lb-api.polymarket.com/" + metric, params=params
+        )
         response.raise_for_status()
         return [UserMetric(**user) for user in response.json()]
 
-
     def __enter__(self):
         return self