Skip to content

switch-keys/rs-clob-client

 
 

Polymarket

Polymarket Rust Client

Crates.io CI codecov

An ergonomic Rust client for interacting with Polymarket services, primarily the Central Limit Order Book (CLOB). This crate provides strongly typed request builders, authenticated endpoints, alloy support and more.

Table of Contents

Overview

  • Typed CLOB requests (orders, trades, markets, balances, and more)
  • Dual authentication flows
    • Normal authenticated flow
    • Builder authentication flow
  • Type-level state machine
    • Prevents using authenticated endpoints before authenticating
    • Compile-time enforcement of correct transitions
  • Signer support via alloy::signers::Signer
    • Including remote signers, e.g. AWS KMS
  • Zero-cost abstractions — no dynamic dispatch in hot paths
  • Order builders for easy construction & signing
  • Full serde support
  • Async-first design with reqwest

Getting started

Add the crate to your Cargo.toml:

[dependencies]
polymarket-client-sdk = "0.3"

or

cargo add polymarket-client-sdk

Then run any of the examples

cargo run --example unauthenticated

Feature Flags

The crate is modular with optional features for different Polymarket APIs:

Feature Description
(default) Core CLOB client for order placement, market data, and authentication
tracing Structured logging via tracing for HTTP requests, auth flows, and caching
ws WebSocket client for real-time orderbook, price, and user event streaming
rtds Real-time data streams for crypto prices (Binance, Chainlink) and comments
data Data API client for positions, trades, leaderboards, and analytics
gamma Gamma API client for market/event discovery, search, and metadata
bridge Bridge API client for cross-chain deposits (EVM, Solana, Bitcoin)

Enable features in your Cargo.toml:

[dependencies]
polymarket-client-sdk = { version = "0.3", features = ["ws", "data"] }

Re-exported Types

This SDK re-exports commonly used types from external crates so you don't need to add them to your Cargo.toml:

From types module

use polymarket_client_sdk::types::{
    Address, ChainId, Signature, address,  // from alloy::primitives
    DateTime, NaiveDate, Utc,              // from chrono
    Decimal, dec,                          // from rust_decimal + rust_decimal_macros
};

From auth module

use polymarket_client_sdk::auth::{
    LocalSigner, Signer,          // from alloy::signers (LocalSigner + trait)
    Uuid, ApiKey,                 // from uuid (ApiKey = Uuid)
    SecretString, ExposeSecret,   // from secrecy
    builder::Url,                 // from url (for remote builder config)
};

From error module

use polymarket_client_sdk::error::{
    StatusCode, Method,           // from reqwest (for error inspection)
};

This allows you to work with the SDK without managing version compatibility for these common dependencies.

Examples

See examples/ for the complete set. Below are hand-picked examples for common use cases.

CLOB Client

Unauthenticated client (read-only)

use polymarket_client_sdk::clob::Client;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::default();

    let ok = client.ok().await?;
    println!("Ok: {ok}");

    Ok(())
}

Authenticated client

Set POLYMARKET_PRIVATE_KEY as an environment variable with your private key.

EOA wallets

If using MetaMask or hardware wallet, you must first set token allowances. See Token Allowances section below.

use std::str::FromStr as _;

use alloy::signers::Signer as _;
use alloy::signers::local::LocalSigner;
use polymarket_client_sdk::{POLYGON, PRIVATE_KEY_VAR};
use polymarket_client_sdk::clob::{Client, Config};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let private_key = std::env::var(PRIVATE_KEY_VAR).expect("Need a private key");
    let signer = LocalSigner::from_str(&private_key)?.with_chain_id(Some(POLYGON));
    let client = Client::new("https://clob.polymarket.com", Config::default())?
        .authentication_builder(&signer)
        .authenticate()
        .await?;

    let ok = client.ok().await?;
    println!("Ok: {ok}");

    let api_keys = client.api_keys().await?;
    println!("API keys: {api_keys:?}");

    Ok(())
}
Proxy/Safe wallets

For proxy/Safe wallets, create your client as such:

let client = Client::new("https://clob.polymarket.com", Config::default())?
    .authentication_builder(&signer)
    .funder(address!("<your-address>"))
    .signature_type(SignatureType::Proxy)
    .authenticate()
    .await?;
Funder Address

The funder address is the actual address that holds your funds on Polymarket. When using proxy wallets (email wallets like Magic or browser extension wallets), the signing key differs from the address holding the funds. The funder address ensures orders are properly attributed to your funded account.

Signature Types

The signature_type parameter tells the system how to verify your signatures:

  • signature_type=0 (default): Standard EOA (Externally Owned Account) signatures - includes MetaMask, hardware wallets, and any wallet where you control the private key directly
  • signature_type=1: Email/Magic wallet signatures (delegated signing)
  • signature_type=2: Browser wallet proxy signatures (when using a proxy contract, not direct wallet connections)

See SignatureType for more information.

Place a market order
use std::str::FromStr as _;

use alloy::signers::Signer as _;
use alloy::signers::local::LocalSigner;
use polymarket_client_sdk::{POLYGON, PRIVATE_KEY_VAR};
use polymarket_client_sdk::clob::{Client, Config};
use polymarket_client_sdk::clob::types::{Amount, OrderType, Side};
use polymarket_client_sdk::types::Decimal;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let private_key = std::env::var(PRIVATE_KEY_VAR).expect("Need a private key");
    let signer = LocalSigner::from_str(&private_key)?.with_chain_id(Some(POLYGON));
    let client = Client::new("https://clob.polymarket.com", Config::default())?
        .authentication_builder(&signer)
        .authenticate()
        .await?;

    let order = client
        .market_order()
        .token_id("<token-id>")
        .amount(Amount::usdc(Decimal::ONE_HUNDRED)?)
        .side(Side::Buy)
        .order_type(OrderType::FOK)
        .build()
        .await?;
    let signed_order = client.sign(&signer, order).await?;
    let response = client.post_order(signed_order).await?;
    println!("Order response: {:?}", response);

    Ok(())
}
Place a limit order
use std::str::FromStr as _;

use alloy::signers::Signer as _;
use alloy::signers::local::LocalSigner;
use polymarket_client_sdk::{POLYGON, PRIVATE_KEY_VAR};
use polymarket_client_sdk::clob::{Client, Config};
use polymarket_client_sdk::clob::types::Side;
use polymarket_client_sdk::types::Decimal;
use rust_decimal_macros::dec;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let private_key = std::env::var(PRIVATE_KEY_VAR).expect("Need a private key");
    let signer = LocalSigner::from_str(&private_key)?.with_chain_id(Some(POLYGON));
    let client = Client::new("https://clob.polymarket.com", Config::default())?
        .authentication_builder(&signer)
        .authenticate()
        .await?;

    let order = client
        .limit_order()
        .token_id("<token-id>")
        .size(Decimal::ONE_HUNDRED)
        .price(dec!(0.1))
        .side(Side::Buy)
        .build()
        .await?;
    let signed_order = client.sign(&signer, order).await?;
    let response = client.post_order(signed_order).await?;
    println!("Order response: {:?}", response);

    Ok(())
}

Builder-authenticated client

For institutional/third-party app integrations with remote signing:

use std::str::FromStr as _;

use alloy::signers::Signer as _;
use alloy::signers::local::LocalSigner;
use polymarket_client_sdk::auth::builder::Config as BuilderConfig;
use polymarket_client_sdk::{POLYGON, PRIVATE_KEY_VAR};
use polymarket_client_sdk::types::address;
use polymarket_client_sdk::clob::{Client, Config};
use polymarket_client_sdk::clob::types::SignatureType;
use polymarket_client_sdk::clob::types::request::TradesRequest;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let private_key = std::env::var(PRIVATE_KEY_VAR).expect("Need a private key");
    let signer = LocalSigner::from_str(&private_key)?.with_chain_id(Some(POLYGON));
    let builder_config = BuilderConfig::remote("http://localhost:3000/sign", None)?; // Or your signing server
    let funder = address!("0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"); // Use your funder address

    let client = Client::new("https://clob.polymarket.com", Config::default())?
        .authentication_builder(&signer)
        .funder(funder)
        .signature_type(SignatureType::Proxy)
        .authenticate()
        .await?;

    let client = client.promote_to_builder(builder_config)?;

    let ok = client.ok().await?;
    println!("Ok: {ok}");

    let api_keys = client.api_keys().await?;
    println!("API keys: {api_keys:?}");

    let builder_trades = client.builder_trades(&TradesRequest::default(), None).await?;
    println!("Builder trades: {builder_trades:?}");

    Ok(())
}

WebSocket Streaming

Real-time orderbook and user event streaming. Requires the ws feature.

polymarket-client-sdk = { version = "0.3", features = ["ws"] }
use futures::StreamExt as _;
use polymarket_client_sdk::clob::ws::Client;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::default();

    // Subscribe to orderbook updates for specific assets
    let asset_ids = vec!["<asset-id>".to_owned()];
    let stream = client.subscribe_orderbook(asset_ids)?;
    let mut stream = Box::pin(stream);

    while let Some(book_result) = stream.next().await {
        let book = book_result?;
        println!("Orderbook update for {}: {} bids, {} asks",
            book.asset_id, book.bids.len(), book.asks.len());
    }
    Ok(())
}

Available streams:

  • subscribe_orderbook() - Bid/ask levels for assets
  • subscribe_prices() - Price change events
  • subscribe_midpoints() - Calculated midpoint prices
  • subscribe_orders() - User order updates (authenticated)
  • subscribe_trades() - User trade executions (authenticated)

See examples/clob/ws/ for more WebSocket examples including authenticated user streams.

Optional APIs

Data API

Trading analytics, positions, and leaderboards. Requires the data feature.

use polymarket_client_sdk::data::Client;
use polymarket_client_sdk::data::types::request::PositionsRequest;
use polymarket_client_sdk::types::address;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::default();
    let user = address!("0x0000000000000000000000000000000000000000"); // Your address

    let request = PositionsRequest::builder().user(user).limit(10)?.build();
    let positions = client.positions(&request).await?;
    println!("Open positions: {:?}", positions);
    Ok(())
}

See examples/data.rs for trades, leaderboards, activity, and more.

Gamma API

Market and event discovery. Requires the gamma feature.

use polymarket_client_sdk::gamma::Client;
use polymarket_client_sdk::gamma::types::request::{EventsRequest, SearchRequest};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::default();

    // Find active events
    let request = EventsRequest::builder().active(true).limit(5).build();
    let events = client.events(&request).await?;
    println!("Found {} events", events.len());

    // Search for markets
    let search = SearchRequest::builder().q("bitcoin").build();
    let results = client.search(&search).await?;
    println!("Search results: {:?}", results);
    Ok(())
}

See examples/gamma.rs for tags, series, comments, and sports endpoints.

Bridge API

Cross-chain deposits from EVM chains, Solana, and Bitcoin. Requires the bridge feature.

use polymarket_client_sdk::bridge::Client;
use polymarket_client_sdk::bridge::types::DepositRequest;
use polymarket_client_sdk::types::address;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::default();

    // Get deposit addresses for your wallet
    let request = DepositRequest::builder()
        .address(address!("0x0000000000000000000000000000000000000000")) // Your address
        .build();
    let response = client.deposit(&request).await?;

    println!("EVM: {}", response.address.evm);
    println!("Solana: {}", response.address.svm);
    println!("Bitcoin: {}", response.address.btc);
    Ok(())
}

See examples/bridge.rs for supported assets and minimum deposits.

Additional CLOB Capabilities

Beyond basic order placement, the CLOB client supports:

  • Rewards & Earnings - Query maker rewards, daily earnings, and reward percentages
  • Streaming Pagination - stream_data() for iterating through large result sets
  • Batch Operations - post_orders() and cancel_orders() for multiple orders at once
  • Order Scoring - Check if orders qualify for maker rewards
  • Notifications - Manage trading notifications
  • Balance Management - Query and refresh balance/allowance caches
  • Geoblock Detection - Check if trading is available in your region

See examples/clob/authenticated.rs for comprehensive usage.

Token Allowances

Do I need to set allowances?

MetaMask and EOA users must set token allowances. If you are using a proxy or Safe-type wallet, then you do not.

What are allowances?

Think of allowances as permissions. Before Polymarket can move your funds to execute trades, you need to give the exchange contracts permission to access your USDC and conditional tokens.

Quick Setup

You need to approve two types of tokens:

  1. USDC (for deposits and trading)
  2. Conditional Tokens (the outcome tokens you trade)

Each needs approval for the exchange contracts to work properly.

Setting Allowances

Use examples/approvals.rs to approve the right contracts. Run once to approve USDC. Then change the TOKEN_TO_APPROVE and run for each conditional token.

Pro tip: You only need to set these once per wallet. After that, you can trade freely.

Minimum Supported Rust Version (MSRV)

MSRV: Rust 1.88

Older versions may compile, but are not supported.

This project aims to maintain compatibility with a Rust version that is at least six months old.

Version updates may occur more frequently than the policy guideline states if external forces require it. For example, a CVE in a downstream dependency requiring an MSRV bump would be considered an acceptable reason to violate the six-month guideline.

Contributing

We encourage contributions from the community. Check out our contributing guidelines for instructions on how to contribute to this SDK.

About Polymarket

Polymarket is the world’s largest prediction market, allowing you to stay informed and profit from your knowledge by betting on future events across various topics. Studies show prediction markets are often more accurate than pundits because they combine news, polls, and expert opinions into a single value that represents the market’s view of an event’s odds. Our markets reflect accurate, unbiased, and real-time probabilities for the events that matter most to you. Markets seek truth.

About

Polymarket Rust CLOB Client

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Rust 100.0%