Struct ClobClient 

pub struct ClobClient { /* private fields */ }

CLOB REST API client

Implementations

impl ClobClient

pub fn new() -> Self

Create a new CLOB client without authentication (for public endpoints)

pub fn with_auth( api_key: String, api_secret: String, passphrase: String, address: String, ) -> Self

Create a new CLOB client with authentication

pub fn from_env() -> Self

Create a new CLOB client from environment variables Requires: api_key, secret, passphrase, address (or poly_address)

pub fn has_auth(&self) -> bool

Check if the client has authentication credentials

pub async fn get_orderbook(&self, condition_id: &str) -> Result<Orderbook>

Get orderbook for a specific market (condition ID)

pub async fn get_trades( &self, condition_id: &str, limit: Option<usize>, ) -> Result<Vec<Trade>>

Get recent trades for a specific market (condition ID)

pub async fn get_orderbook_by_asset(&self, token_id: &str) -> Result<Orderbook>

Get orderbook for a specific token ID (clob_token_id from Gamma API)

pub async fn get_trades_by_asset( &self, asset_id: &str, limit: Option<usize>, ) -> Result<Vec<Trade>>

Get recent trades for a specific asset ID

pub async fn get_trades_authenticated( &self, market: &str, limit: Option<usize>, ) -> Result<Vec<Trade>>

Get recent trades for a specific market with authentication Returns trade count if authenticated, otherwise returns an error

pub async fn get_trade_count(&self, market: &str) -> Result<usize>

Get trade count for a market (uses authenticated endpoint if credentials available)

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

Get user’s orders (requires authentication)

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

Get a specific order by ID (requires authentication)

pub async fn place_order( &self, _market: &str, _side: Side, _order_type: OrderType, _size: &str, _price: Option<&str>, ) -> Result<Order>

Place a new order (requires authentication)

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

Cancel an order (requires authentication)

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

Get market price for a specific token and side

Arguments

• token_id - The unique identifier for the token
• side - The side of the market (BUY or SELL)

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

Get midpoint price for a specific token

The midpoint is the middle point between the current best bid and ask prices.

Arguments

• token_id - The unique identifier for the token

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

Get historical price data for a token

Arguments

• token_id - The CLOB token ID for which to fetch price history
• start_ts - Optional start time as Unix timestamp in UTC
• end_ts - Optional end time as Unix timestamp in UTC
• interval - Optional interval string (mutually exclusive with start_ts/end_ts)
• fidelity - Optional resolution of the data in minutes

pub async fn get_spreads( &self, requests: Vec<SpreadRequest>, ) -> Result<HashMap<String, String>>

Get bid-ask spreads for multiple tokens

Arguments

• requests - Array of spread requests (max 500)

pub async fn get_orderbooks( &self, requests: Vec<BatchTokenRequest>, ) -> Result<Vec<Orderbook>>

Get multiple orderbooks at once

Arguments

• requests - Array of batch token requests (max 500)

pub async fn get_prices_batch( &self, requests: Vec<BatchTokenRequest>, ) -> Result<HashMap<String, TokenPrices>>

Get multiple market prices at once (batch)

Arguments

• requests - Array of batch token requests (max 500)

Returns

HashMap mapping token_id to TokenPrices (buy/sell prices)

Trait Implementations

impl Default for ClobClient

fn default() -> Self

Returns the “default value” for a type.