Struct Client 

pub struct Client { /* private fields */ }

HTTP client for the Polymarket Data API.

Provides methods for querying user positions, trades, activity, market holders, open interest, volume data, and leaderboards.

API Base URL

The default API endpoint is https://data-api.polymarket.com.

Example

use polymarket_client_sdk::data::Client;

// Create client with default endpoint
let client = Client::default();

// Or with a custom endpoint
let client = Client::new("https://custom-api.example.com").unwrap();

Implementations

impl Client

pub fn new(host: &str) -> Result<Client>

Creates a new Data API client with a custom host URL.

Arguments

• host - The base URL for the Data API (e.g., https://data-api.polymarket.com).

Errors

Returns an error if the URL is invalid or the HTTP client cannot be created.

pub fn host(&self) -> &Url

Returns the base URL of the API.

pub async fn health(&self) -> Result<Health>

Performs a health check on the API.

Returns “OK” when the API is healthy and operational.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn positions(&self, req: &PositionsRequest) -> Result<Vec<Position>>

Fetches current (open) positions for a user.

Positions represent holdings of outcome tokens in prediction markets.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn trades(&self, req: &TradesRequest) -> Result<Vec<Trade>>

Fetches trade history for a user or markets.

Trades represent executed orders where outcome tokens were bought or sold.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn activity(&self, req: &ActivityRequest) -> Result<Vec<Activity>>

Fetches on-chain activity for a user.

Returns various on-chain operations including trades, splits, merges, redemptions, rewards, and conversions.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn holders(&self, req: &HoldersRequest) -> Result<Vec<MetaHolder>>

Fetches top token holders for specified markets.

Returns holders grouped by token (outcome) for each market.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn value(&self, req: &ValueRequest) -> Result<Vec<Value>>

Fetches the total value of a user’s positions.

Optionally filtered by specific markets.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn closed_positions( &self, req: &ClosedPositionsRequest, ) -> Result<Vec<ClosedPosition>>

Fetches closed (historical) positions for a user.

These are positions that have been fully sold or redeemed.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn leaderboard( &self, req: &TraderLeaderboardRequest, ) -> Result<Vec<TraderLeaderboardEntry>>

Fetches trader leaderboard rankings.

Returns trader rankings filtered by category, time period, and ordering.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn traded(&self, req: &TradedRequest) -> Result<Traded>

Fetches the total count of unique markets a user has traded.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn open_interest( &self, req: &OpenInterestRequest, ) -> Result<Vec<OpenInterest>>

Fetches open interest for markets.

Open interest represents the total value of outstanding positions in a market.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn live_volume( &self, req: &LiveVolumeRequest, ) -> Result<Vec<LiveVolume>>

Fetches live trading volume for an event.

Includes total volume and per-market breakdown.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn builder_leaderboard( &self, req: &BuilderLeaderboardRequest, ) -> Result<Vec<BuilderLeaderboardEntry>>

Fetches aggregated builder leaderboard rankings.

Builders are third-party applications that integrate with Polymarket. Returns one entry per builder with aggregated totals for the specified time period.

Errors

Returns an error if the request fails or the API returns an error response.

pub async fn builder_volume( &self, req: &BuilderVolumeRequest, ) -> Result<Vec<BuilderVolumeEntry>>

Fetches daily time-series volume data for builders.

Returns multiple entries per builder (one per day), each including a timestamp.

Errors

Returns an error if the request fails or the API returns an error response.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.