Struct PolymarketClient 

pub struct PolymarketClient<A = Public> { /* private fields */ }

Main client for interacting with the Polymarket CLOB API.

The type parameter A tracks the authentication state at compile time:

• PolymarketClient<Public> — can only call public endpoints
• PolymarketClient<Authenticated> — can call all endpoints including trading

Implementations

impl PolymarketClient<Public>

pub fn new_public(host: Option<&str>) -> Result<Self>

Create a public-only client (no authentication, market data only).

Pass None for the host to use the default mainnet URL.

pub fn authenticate( self, creds: ApiCredentials, ) -> PolymarketClient<Authenticated>

Upgrade this client to an authenticated client by providing L2 credentials.

This is a zero-cost state transition — it just adds credentials.

impl PolymarketClient<Authenticated>

pub fn with_l2( host: Option<&str>, chain_id: u64, creds: ApiCredentials, ) -> Result<Self>

Create a client with L2 credentials for trading.

impl<A> PolymarketClient<A>

pub fn builder() -> PolymarketClientBuilder

Builder-style: create a fully configured client.

pub fn chain_id(&self) -> u64

Get the configured chain ID.

pub fn has_credentials(&self) -> bool

Check if L2 credentials are configured.

pub fn set_funder(&mut self, funder: Address)

Set the funder address (for proxy wallets).

pub fn set_signature_type(&mut self, sig_type: SignatureType)

Set the signature type.

pub async fn get_sampling_simplified_markets( &self, next_cursor: Option<&str>, ) -> Result<Vec<SimplifiedMarket>>

Get simplified markets.

pub async fn get_simplified_markets( &self, next_cursor: Option<&str>, ) -> Result<Vec<SimplifiedMarket>>

Get simplified markets (paginated).

pub async fn get_markets( &self, next_cursor: Option<&str>, ) -> Result<Vec<SimplifiedMarket>>

Get markets from the CLOB API.

pub async fn get_market(&self, condition_id: &str) -> Result<SimplifiedMarket>

Get a single market by condition ID.

pub async fn get_order_book(&self, token_id: &str) -> Result<OrderBook>

Get the order book for a token.

pub async fn get_midpoint(&self, token_id: &str) -> Result<PriceResponse>

Get the midpoint price for a token.

pub async fn get_price(&self, token_id: &str) -> Result<PriceResponse>

Get the current price for a token.

pub async fn get_spread(&self, token_id: &str) -> Result<SpreadResponse>

Get the spread for a token.

pub async fn get_last_trade_price( &self, token_id: &str, ) -> Result<LastTradePriceResponse>

Get the last trade price for a token.

pub async fn get_prices_history( &self, token_id: &str, start_ts: Option<i64>, end_ts: Option<i64>, fidelity: Option<u32>, ) -> Result<Vec<PriceHistoryEntry>>

Get price history for a token.

pub async fn get_tick_size(&self, token_id: &str) -> Result<TickSizeInfo>

Get tick size for a token.

pub async fn get_gamma_markets( &self, limit: Option<u32>, offset: Option<u32>, ) -> Result<Vec<GammaMarket>>

Get markets from the Gamma API.

pub async fn get_gamma_market_by_slug( &self, slug: &str, ) -> Result<Vec<GammaMarket>>

Search Gamma markets by slug.

pub async fn get_events( &self, limit: Option<u32>, offset: Option<u32>, ) -> Result<Vec<GammaEvent>>

Get events from the Gamma API.

pub async fn get_event(&self, event_id: &str) -> Result<GammaEvent>

Get a single event by ID.

pub async fn search_markets(&self, query: &str) -> Result<Vec<GammaMarket>>

Search markets by text query.

pub async fn create_or_derive_api_key<S: Signer + Send + Sync>( &self, signer: &S, nonce: Option<u64>, ) -> Result<ApiKeyResponse>

Create or derive API keys using L1 authentication.

pub async fn derive_api_key<S: Signer + Send + Sync>( &self, signer: &S, ) -> Result<ApiKeyResponse>

Derive an existing API key.

pub async fn delete_api_key<S: Signer + Send + Sync>( &self, signer: &S, ) -> Result<Value>

Delete an API key.

impl PolymarketClient<Authenticated>

pub async fn get_orders(&self) -> Result<Vec<OpenOrder>>

Get open orders for the authenticated user.

pub async fn get_order(&self, order_id: &str) -> Result<OpenOrder>

Get a single order by ID.

pub async fn post_order( &self, signed_order: &SignedOrder, ) -> Result<OrderResponse>

Post a pre-signed order to the API.

pub async fn create_and_post_order<S: Signer + Send + Sync>( &self, signer: &S, params: &TradeParams, ) -> Result<OrderResponse>

Build, sign, and post an order in one call.

This is the most convenient way to place an order.

pub async fn cancel_order(&self, order_id: &str) -> Result<CancelResponse>

Cancel an order by ID.

pub async fn cancel_orders(&self, order_ids: &[&str]) -> Result<CancelResponse>

Cancel multiple orders.

pub async fn cancel_all_orders(&self) -> Result<CancelResponse>

Cancel all open orders.

Trait Implementations

impl<A: Debug> Debug for PolymarketClient<A>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.