polymarket-apis 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

polymarket_apis/types/websockets_types.py

@@ -1,43 +1,66 @@
 from datetime import datetime
-from typing import Literal
+from typing import Literal, Optional
 
-from pydantic import BaseModel, Field, field_validator
-
-from ..types.clob_types import MakerOrder, OrderBookSummary, PriceLevel, TickSize
-from ..types.common import EthAddress, Keccak256
+from pydantic import AliasChoices, BaseModel, Field, field_validator
 
+from ..types.clob_types import MakerOrder, OrderBookSummary, TickSize
+from ..types.common import EthAddress, Keccak256, TimeseriesPoint
 
 # wss://ws-subscriptions-clob.polymarket.com/ws/market types
-class OrderBookSummaryEvent(OrderBookSummary):
-    event_type: Literal["book"]
 
-class PriceChangeEvent(BaseModel):
-    token_id: str = Field(alias="asset_id")
-    changes: list[PriceLevel]
-    hash: str
-    market: str
-    timestamp: datetime # time of event
-    event_type: Literal["price_change"]
+class PriceChange(BaseModel):
+    best_ask: float = Field(validation_alias=AliasChoices("ba", "best_ask"))
+    best_bid: float = Field(validation_alias=AliasChoices("bb", "best_bid"))
+    price: float = Field(validation_alias=AliasChoices("p", "price"))
+    size: float = Field(validation_alias=AliasChoices("s", "size"))
+    side: Literal["BUY", "SELL"] = Field(validation_alias=AliasChoices("si", "side"))
+    token_id: str = Field(validation_alias=AliasChoices("a", "asset_id"))
+    hash: str = Field(validation_alias=AliasChoices("h", "hash"))
+
+class PriceChanges(BaseModel):
+    condition_id: Keccak256 = Field(validation_alias=AliasChoices("m", "market"))
+    price_changes: list[PriceChange] = Field(validation_alias=AliasChoices("pc", "price_changes"))
+    timestamp: datetime = Field(validation_alias=AliasChoices("t", "timestamp"))
 
-class TickSizeChangeEvent(BaseModel):
+class TickSizeChange(BaseModel):
     token_id: str = Field(alias="asset_id")
     condition_id: Keccak256 = Field(alias="market")
     old_tick_size: TickSize
     new_tick_size: TickSize
+
+class LastTradePrice(BaseModel):
+    price: float
+    size: float
     side: Literal["BUY", "SELL"]
-    timestamp: datetime # time of event
+    token_id: str = Field(alias="asset_id")
+    condition_id: Keccak256 = Field(alias="market")
+    fee_rate_bps: float
+
+class OrderBookSummaryEvent(OrderBookSummary):
+    event_type: Literal["book"]
+
+class PriceChangeEvent(PriceChanges):
+    event_type: Literal["price_change"]
+
+class TickSizeChangeEvent(TickSizeChange):
+    side: Literal["BUY", "SELL"]
+    timestamp: datetime
     event_type: Literal["tick_size_change"]
 
+class LastTradePriceEvent(LastTradePrice):
+    timestamp: datetime
+    event_type: Literal["last_trade_price"]
+
 # wss://ws-subscriptions-clob.polymarket.com/ws/user types
+
 class OrderEvent(BaseModel):
     token_id: str = Field(alias="asset_id")
     condition_id: Keccak256 = Field(alias="market")
     order_id: Keccak256 = Field(alias="id")
-    associated_trades: list[str] | None = None # list of trade ids which
+    associated_trades: Optional[list[str]] = None # list of trade ids which
     maker_address: EthAddress
-    order_owner: str # api key of order owner
-    event_owner: str = Field(alias="owner") # api key of event owner
-
+    order_owner: str = Field(alias="owner") # api key of order owner
+    event_owner: Optional[str] = Field(None, alias="owner") # api key of event owner
 
     price: float
     side: Literal["BUY", "SELL"]
@@ -47,11 +70,11 @@ class OrderEvent(BaseModel):
     order_type: Literal["GTC", "FOK", "GTD"]
 
     created_at: datetime
-    expiration: datetime | None = None
-    timestamp: datetime # time of event
+    expiration: Optional[datetime] = None
+    timestamp: Optional[datetime] = None # time of event
 
-    event_type: Literal["order"]
-    type: Literal["PLACEMENT", "UPDATE" , "CANCELLATION"]
+    event_type: Optional[Literal["order"]] = None
+    type: Literal["PLACEMENT", "UPDATE", "CANCELLATION"]
 
     status: Literal["LIVE", "CANCELED", "MATCHED"]
 
@@ -67,7 +90,7 @@ class TradeEvent(BaseModel):
     taker_order_id: Keccak256
     maker_orders: list[MakerOrder]
     trade_id: str = Field(alias="id")
-    trade_owner: str # api key of trade owner
+    trade_owner: Optional[str] = Field(None, alias="owner") # api key of trade owner
     event_owner: str = Field(alias="owner") # api key of event owner
 
     price: float
@@ -76,16 +99,18 @@ class TradeEvent(BaseModel):
     outcome: str
 
     last_update: datetime # time of last update to trade
-    matchtime: datetime | None = None # time trade was matched
-    timestamp: datetime # time of event
+    matchtime: Optional[datetime] = None # time trade was matched
+    timestamp: Optional[datetime] = None # time of event
 
-    event_type: Literal["trade"]
-    type: Literal["TRADE"]
+    event_type: Optional[Literal["trade"]] = None
+    type: Optional[Literal["TRADE"]] = None
 
     status: Literal["MATCHED", "MINED", "CONFIRMED", "RETRYING", "FAILED"]
 
 # wss://ws-live-data.polymarket.com types
-class LiveDataTrade(BaseModel):
+
+# Payload models
+class ActivityTrade(BaseModel):
     token_id: str = Field(alias="asset") # ERC1155 token ID of conditional token being traded
     condition_id: str = Field(alias="conditionId")  # Id of market which is also the CTF condition ID
     event_slug: str = Field(alias="eventSlug")  # Slug of the event
@@ -104,25 +129,24 @@ class LiveDataTrade(BaseModel):
     bio: str  # Bio of the user of the trade
     pseudonym: str  # Pseudonym of the user
     profile_image: str = Field(alias="profileImage")  # URL to the user profile image
-    profile_image_optimized: str | None = Field(None, alias="profileImageOptimized")
-
+    profile_image_optimized: Optional[str] = Field(None, alias="profileImageOptimized")
 
 class Comment(BaseModel):
     id: str  # Unique identifier of comment
     body: str  # Content of the comment
     parent_entity_type: str = Field(alias="parentEntityType")  # Type of the parent entity (Event or Series)
     parent_entity_id: int = Field(alias="parentEntityID")  # ID of the parent entity
-    parent_comment_id: str | None = Field(None, alias="parentCommentID")  # ID of the parent comment
+    parent_comment_id: Optional[str] = Field(None, alias="parentCommentID")  # ID of the parent comment
     user_address: str = Field(alias="userAddress")  # Address of the user
-    reply_address: str | None = Field(None, alias="replyAddress")  # Address of the reply user
+    reply_address: Optional[str] = Field(None, alias="replyAddress")  # Address of the reply user
     created_at: datetime = Field(alias="createdAt")  # Creation timestamp
-    updated_at: datetime | None = Field(None, alias="updatedAt")  # Last update timestamp
+    updated_at: Optional[datetime] = Field(None, alias="updatedAt")  # Last update timestamp
 
 class Reaction(BaseModel):
     id: str  # Unique identifier of reaction
     comment_id: int = Field(alias="commentID")  # ID of the comment
     reaction_type: str = Field(alias="reactionType")  # Type of the reaction
-    icon: str | None = None  # Icon representing the reaction
+    icon: Optional[str] = None  # Icon representing the reaction
     user_address: str = Field(alias="userAddress")  # Address of the user
     created_at: datetime = Field(alias="createdAt")  # Creation timestamp
 
@@ -138,7 +162,7 @@ class Request(BaseModel):
     price: float  # Price from in/out sizes
     size_in: float = Field(alias="sizeIn")  # Input size of the request
     size_out: float = Field(alias="sizeOut")  # Output size of the request
-    expiry: datetime | None = None
+    expiry: Optional[datetime] = None
 
 class Quote(BaseModel):
     quote_id: str = Field(alias="quoteId")  # Unique identifier for the quote
@@ -152,16 +176,37 @@ class Quote(BaseModel):
     side: Literal["BUY", "SELL"]  # Indicates buy or sell side
     size_in: float = Field(alias="sizeIn")  # Input size of the quote
     size_out: float = Field(alias="sizeOut")  # Output size of the quote
-    expiry: datetime | None = None
+    expiry: Optional[datetime] = None
 
-class LiveDataTradeEvent(BaseModel):
-    payload: LiveDataTrade
+class CryptoPriceSubscribe(BaseModel):
+    data: list[TimeseriesPoint]
+    symbol: str
+
+class CryptoPriceUpdate(TimeseriesPoint):
+    symbol: str
+    full_accuracy_value: str
+
+class AggOrderBookSummary(OrderBookSummary):
+    min_order_size: float
+    tick_size: TickSize
+    neg_risk: bool
+
+class LiveDataClobMarket(BaseModel):
+    token_ids: list[str] = Field(alias="asset_ids")
+    condition_id: Keccak256 = Field(alias="market")
+    min_order_size: float
+    tick_size: TickSize
+    neg_risk: bool
+
+# Event models
+class ActivityTradeEvent(BaseModel):
+    payload: ActivityTrade
     timestamp: datetime
     type: Literal["trades"]
     topic: Literal["activity"]
 
-class LiveDataOrderMatchEvent(BaseModel):
-    payload: LiveDataTrade
+class ActivityOrderMatchEvent(BaseModel):
+    payload: ActivityTrade
     timestamp: datetime
     type: Literal["orders_matched"]
     topic: Literal["activity"]
@@ -189,3 +234,72 @@ class QuoteEvent(BaseModel):
     timestamp: datetime
     type: Literal["quote_created", "quote_edited", "quote_canceled", "quote_expired"]
     topic: Literal["rfq"]
+
+class CryptoPriceUpdateEvent(BaseModel):
+    payload: CryptoPriceUpdate
+    timestamp: datetime
+    connection_id: str
+    type: Literal["update"]
+    topic: Literal["crypto_prices", "crypto_prices_chainlink"]
+
+class CryptoPriceSubscribeEvent(BaseModel):
+    payload: CryptoPriceSubscribe
+    timestamp: datetime
+    type: Literal["subscribe"]
+    topic: Literal["crypto_prices", "crypto_prices_chainlink"]
+
+class LiveDataOrderBookSummaryEvent(BaseModel):
+    payload: list[AggOrderBookSummary] | AggOrderBookSummary
+    timestamp: datetime
+    connection_id: str
+    type: Literal["agg_orderbook"]
+    topic: Literal["clob_market"]
+
+class LiveDataPriceChangeEvent(BaseModel):
+    payload: PriceChanges
+    timestamp: datetime
+    connection_id: str
+    type: Literal["price_change"]
+    topic: Literal["clob_market"]
+
+class LiveDataLastTradePriceEvent(BaseModel):
+    payload: LastTradePrice
+    timestamp: datetime
+    connection_id: str
+    type: Literal["last_trade_price"]
+    topic: Literal["clob_market"]
+
+class LiveDataTickSizeChangeEvent(BaseModel):
+    payload: TickSizeChange
+    timestamp: datetime
+    connection_id: str
+    type: Literal["tick_size_change"]
+    topic: Literal["clob_market"]
+
+class MarketStatusChangeEvent(BaseModel):
+    payload: LiveDataClobMarket
+    timestamp: datetime
+    connection_id: str
+    type: Literal["market_created", "market_resolved"]
+    topic: Literal["clob_market"]
+
+class LiveDataOrderEvent(BaseModel):
+    connection_id: str
+    payload: OrderEvent
+    timestamp: datetime
+    type: Literal["order"]
+    topic: Literal["clob_user"]
+
+class LiveDataTradeEvent(BaseModel):
+    connection_id: str
+    payload: TradeEvent
+    timestamp: datetime
+    type: Literal["trade"]
+    topic: Literal["clob_user"]
+
+class ErrorEvent(BaseModel):
+    message: str
+    connection_id: str = Field(alias="connectionId")
+    request_id: str = Field(alias="requestId")
+
+

polymarket_apis/utilities/config.py

@@ -34,3 +34,15 @@ def get_contract_config(chain_id: int, neg_risk: bool = False) -> ContractConfig
         raise ValueError(msg)
 
     return config
+
+
+GRAPHQL_ENDPOINTS = {
+    "activity_subgraph": "https://api.goldsky.com/api/public/project_cl6mb8i9h0003e201j6li0diw/subgraphs/activity-subgraph/0.0.4/gn",
+    "fpmm_subgraph": "https://api.goldsky.com/api/public/project_cl6mb8i9h0003e201j6li0diw/subgraphs/fpmm-subgraph/0.0.1/gn",
+    "open_interest_subgraph": "https://api.goldsky.com/api/public/project_cl6mb8i9h0003e201j6li0diw/subgraphs/oi-subgraph/0.0.6/gn",
+    "orderbook_subgraph": "https://api.goldsky.com/api/public/project_cl6mb8i9h0003e201j6li0diw/subgraphs/orderbook-subgraph/0.0.1/gn",
+    "pnl_subgraph": "https://api.goldsky.com/api/public/project_cl6mb8i9h0003e201j6li0diw/subgraphs/pnl-subgraph/0.0.14/gn",
+    "positions_subgraph": "https://api.goldsky.com/api/public/project_cl6mb8i9h0003e201j6li0diw/subgraphs/positions-subgraph/0.0.7/gn",
+    "sports_oracle_subgraph": "https://api.goldsky.com/api/public/project_cl6mb8i9h0003e201j6li0diw/subgraphs/sports-oracle-subgraph/0.0.1/gn",
+    "wallet_subgraph": "https://api.goldsky.com/api/public/project_cl6mb8i9h0003e201j6li0diw/subgraphs/wallet-subgraph/0.0.4/gn",
+}

polymarket_apis/utilities/endpoints.py

@@ -29,6 +29,7 @@ IS_ORDER_SCORING = "/order-scoring"
 ARE_ORDERS_SCORING = "/orders-scoring"
 GET_TICK_SIZE = "/tick-size"
 GET_NEG_RISK = "/neg-risk"
+GET_FEE_RATE = "/fee-rate"
 GET_SAMPLING_SIMPLIFIED_MARKETS = "/sampling-simplified-markets"
 GET_SAMPLING_MARKETS = "/sampling-markets"
 GET_SIMPLIFIED_MARKETS = "/simplified-markets"

polymarket_apis/utilities/exceptions.py

@@ -4,8 +4,14 @@ class InvalidPriceError(Exception):
 class InvalidTickSizeError(Exception):
     pass
 
+class InvalidFeeRateError(Exception):
+    pass
+
 class LiquidityError(Exception):
     pass
 
 class MissingOrderbookError(Exception):
     pass
+
+class AuthenticationRequiredError(ValueError):
+    """Raised when authentication credentials are required but not provided."""

polymarket_apis/utilities/headers.py

@@ -49,6 +49,6 @@ def create_level_2_headers(signer: Signer, creds: ApiCreds, request_args: Reques
         POLY_ADDRESS: signer.address(),
         POLY_SIGNATURE: hmac_sig,
         POLY_TIMESTAMP: timestamp,
-        POLY_API_KEY: creds.api_key,
+        POLY_API_KEY: creds.key,
         POLY_PASSPHRASE: creds.passphrase,
     }

{polymarket_apis-0.2.2.dist-info → polymarket_apis-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polymarket-apis
-Version: 0.2.2
+Version: 0.2.4
 Summary: Unified Polymarket APIs - clob, gamma, data, web3, websockets
 Author-email: Razvan Gheorghe <razvan@gheorghe.me>
 Requires-Python: >=3.12

{polymarket_apis-0.2.2.dist-info → polymarket_apis-0.2.4.dist-info}/RECORD

@@ -1,22 +1,23 @@
 polymarket_apis/__init__.py,sha256=8a6dT19YqnOcLEmprl8vavi97JpaRrcDWBTllGsrmbE,61
 polymarket_apis/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-polymarket_apis/clients/clob_client.py,sha256=2Mgh-WRPJ3CqlcuBMrXAgKQRzWr-dNthynZf2Q0jsiY,29549
+polymarket_apis/clients/clob_client.py,sha256=pE-q-4hAUyKIUHN5tbBxX4o4uzMGiMcTNQ2dIJLQkDY,31025
 polymarket_apis/clients/data_client.py,sha256=sAJqesjKT8cRNr-j4OsXj-xYHEOzt0WWCvXcvejX7uI,8641
-polymarket_apis/clients/gamma_client.py,sha256=y-qBzU21qKXpluO3-mWPY_h9N6KSbiq4cpvR-X8Awqo,11972
-polymarket_apis/clients/web3_client.py,sha256=lIE-xXYmlk0sO0OFy2OQ9ylJPIL39gMnSg2bAjD6HmQ,11215
-polymarket_apis/clients/websockets_client.py,sha256=Spdp_8L_RzNJEZ867Vk9BMTW3J-lMAwyx3P0R98x_j4,4646
+polymarket_apis/clients/gamma_client.py,sha256=yGi7l0vceBgrwMlqLFZYyQ_Lj13hNaDwaBtLSDoTAnM,12190
+polymarket_apis/clients/graphql_client.py,sha256=Jgrz107EVpHRSAXvY45hRUKuPndl9-41_EaqIYbb5mo,6907
+polymarket_apis/clients/web3_client.py,sha256=0SX25LMP59FWzfsoshxt-_XNPcPXnmvwmCaHu3K4K2E,11222
+polymarket_apis/clients/websockets_client.py,sha256=wueJ54ZgJgeiJmKi5EEIB8_YwkdD3y2Dr4t9WjFMXuU,7581
 polymarket_apis/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-polymarket_apis/types/clob_types.py,sha256=TlbSH6P3BpDz1xX9hhcHjH6Y5HogZVnhjL-wTE9hF2Q,11703
-polymarket_apis/types/common.py,sha256=eqgTPYQaRe_kl4XpixLgQlVlP0iB1jd3ThiJs_xwHx0,1568
+polymarket_apis/types/clob_types.py,sha256=O7_6x5gtLjjkcVhcUMv7aIyFhdk2LRfRObPibRwdC44,11699
+polymarket_apis/types/common.py,sha256=eTY2kjOArzrZRVSmEJvxEyxGJeMx045R073EMZMzCKM,1629
 polymarket_apis/types/data_types.py,sha256=K-bE5g1owFozvznmQZ0MicxGccqVSuEibuVzXFAoa4E,4408
-polymarket_apis/types/gamma_types.py,sha256=zREASm8jrQokxNC-VYvghYtorhdHebvxww803iRadSU,10377
-polymarket_apis/types/websockets_types.py,sha256=o55PkBksDgy4yxAWEM_qB3JifxuP70ev5IyQuj9Krfk,8278
+polymarket_apis/types/gamma_types.py,sha256=CfjuQbkNaM-PcZoezSZvMk4ru7a4AzXh64Clbf13MHc,12518
+polymarket_apis/types/websockets_types.py,sha256=96xQl6xQ4ReL-b4a-UYNittPvXJBXuzX1RBxlJHJg-s,11993
 polymarket_apis/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-polymarket_apis/utilities/config.py,sha256=t1cN9nLy949nL-kO8-m3ODS9g-rcYVduxJ2J1LNUqdc,1358
+polymarket_apis/utilities/config.py,sha256=IfIBJa6rSi-e-9_HjeI8j4cD3MXtzRjoLzgcgn5tHbc,2448
 polymarket_apis/utilities/constants.py,sha256=OdxaAsyYzAK1RXty5VtvidMgan8YW-JfHS3Rdxp6n_U,580
-polymarket_apis/utilities/endpoints.py,sha256=OX6KBeS7XHC8t50s0QpBw8KMg7IS279Jq6xIk8I05Kc,1208
-polymarket_apis/utilities/exceptions.py,sha256=agbe5OZD9kRoQVTGJvBK3mbnZgLTXI4FJNESM0zsKqM,187
-polymarket_apis/utilities/headers.py,sha256=dl3ONZU56nsrGkAishwYtALT-Qn8P3Ts_z58-XgPARg,1514
+polymarket_apis/utilities/endpoints.py,sha256=bxZyrJBPbVauWc-eR0RMh6KDqU-SmO_3LfQwVMNJ6vE,1235
+polymarket_apis/utilities/exceptions.py,sha256=58vuiLuZxX6d05qa29jgEOC4ZYBv368JaO8DAFMD0Dc,363
+polymarket_apis/utilities/headers.py,sha256=Cc5WEnIBLYAgfwvmCXRBwA2zUYME8fDy4PbwlwlB6Oo,1510
 polymarket_apis/utilities/order_builder/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 polymarket_apis/utilities/order_builder/builder.py,sha256=-eQ092J6Wkproy2SY6USFGWAniS5ZMBg85Ij_cnqqPs,8332
 polymarket_apis/utilities/order_builder/helpers.py,sha256=QN39noGcWrGAy89dJc8DvEGJwiX0fMVc62R-pkclAu4,1714
@@ -35,6 +36,6 @@ polymarket_apis/utilities/web3/abis/ProxyWalletFactory.json,sha256=5KjBHUWdkc_kd
 polymarket_apis/utilities/web3/abis/UChildERC20Proxy.json,sha256=ZyQC38U0uxInlmnW2VXDVD3TJfTIRmSNMkTxQsaG7oA,27396
 polymarket_apis/utilities/web3/abis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 polymarket_apis/utilities/web3/abis/custom_contract_errors.py,sha256=ZCeJPK5tobPAR9vaNxw_pQZwKyZc_R0GdggfWaeXvOs,1176
-polymarket_apis-0.2.2.dist-info/METADATA,sha256=Ghid2hQzHlSGgv4BzxuQHy6GgkBLUDgvx6XVytm6UQM,558
-polymarket_apis-0.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-polymarket_apis-0.2.2.dist-info/RECORD,,
+polymarket_apis-0.2.4.dist-info/METADATA,sha256=QU7aW8ETv0ihWuLccK9WVsPP-lwIrhStoIfjN0apFj4,558
+polymarket_apis-0.2.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+polymarket_apis-0.2.4.dist-info/RECORD,,