Struct LimitlessClient 

pub struct LimitlessClient { /* private fields */ }

The primary entry point for all Limitless Exchange API operations.

Every REST endpoint and convenience method is available directly on this struct. The internal manager types (Markets, Trader, Portfolio, Navigation, Stream) are still available through accessor methods when you need them, but for the common case you never have to think about them.

Authentication

Credentials are read automatically from environment variables LIMITLESS_API_KEY and LIMITLESS_API_SECRET when not explicitly set on the builder.

Implementations

impl LimitlessClient

pub fn builder() -> LimitlessClientBuilder

Create a new LimitlessClientBuilder.

pub fn raw_client(&self) -> &Client

Access the underlying HTTP client for custom / advanced requests.

pub fn set_credentials( &mut self, api_key: Option<String>, secret_key: Option<String>, )

Update credentials at runtime.

pub fn retry_config(&self) -> &RetryConfig

The current retry configuration.

pub fn base_url(&self) -> &str

The current REST API base URL.

pub fn markets(&self) -> Markets

Access the raw Markets manager.

pub fn trader(&self) -> Trader

Access the raw Trader manager.

pub fn portfolio(&self) -> Portfolio

Access the raw Portfolio manager.

pub fn navigation(&self) -> Navigation

Access the raw Navigation manager.

pub fn stream(&self) -> Stream

Access the raw Stream manager for WebSocket subscriptions.

pub async fn browse_active( &self, category_id: Option<u64>, page: Option<u64>, limit: Option<u64>, sort_by: Option<String>, trade_type: Option<String>, automation_type: Option<String>, ) -> Result<ActiveMarketsResponse, LimitlessError>

Browse all active (unresolved) markets with optional filters.

pub async fn get_category_counts( &self, ) -> Result<CategoryCountResponse, LimitlessError>

Get the count of active markets per category.

pub async fn get_active_slugs(&self) -> Result<Vec<ActiveSlug>, LimitlessError>

Get all active market slugs with metadata.

pub async fn get_market( &self, address_or_slug: &str, ) -> Result<MarketDetail, LimitlessError>

Get detailed market information by address or slug.

pub async fn get_oracle_candles( &self, address_or_slug: &str, interval: Option<&str>, from: Option<u64>, to: Option<u64>, ) -> Result<OracleCandlesResponse, LimitlessError>

Get Chainlink oracle candlestick data for a market.

pub async fn get_feed_events( &self, slug: &str, page: Option<u64>, limit: Option<u64>, ) -> Result<FeedEventsResponse, LimitlessError>

Get feed events (trades, orders, liquidity) for a market.

pub async fn search_markets( &self, query: &str, limit: Option<u64>, page: Option<u64>, similarity_threshold: Option<f64>, ) -> Result<SearchResponse, LimitlessError>

Semantic search for markets using natural language queries.

pub async fn create_order( &self, order_request: &str, ) -> Result<CreateOrderResponse, LimitlessError>

Create a new order from a raw JSON body.

pub async fn order_status_batch( &self, request_body: &str, ) -> Result<OrderStatusBatchResponse, LimitlessError>

Fetch statuses for multiple orders in batch.

pub async fn cancel_combined( &self, request_body: &str, ) -> Result<CancelOrderResponse, LimitlessError>

Cancel a single order by orderId or clientOrderId.

pub async fn cancel_batch( &self, request_body: &str, ) -> Result<CancelBatchResponse, LimitlessError>

Cancel multiple orders by internal orderIds.

pub async fn cancel_order_by_id( &self, order_id: &str, ) -> Result<CancelOrderResponse, LimitlessError>

Cancel a single order by internal orderId.

pub async fn cancel_all_in_market( &self, slug: &str, ) -> Result<CancelAllResponse, LimitlessError>

Cancel all orders for the authenticated user in a specific market.

pub async fn get_orderbook( &self, slug: &str, ) -> Result<OrderbookResponse, LimitlessError>

Get the current orderbook for a market.

pub async fn get_historical_prices( &self, slug: &str, interval: Option<&str>, ) -> Result<Vec<HistoricalPriceData>, LimitlessError>

Get historical price data for a market.

pub async fn get_locked_balance( &self, slug: &str, ) -> Result<LockedBalanceResponse, LimitlessError>

Get the amount of funds locked in open orders.

pub async fn get_user_orders( &self, slug: &str, statuses: Option<&[&str]>, limit: Option<u64>, ) -> Result<UserOrdersResponse, LimitlessError>

Get all orders placed by the authenticated user in a market.

pub async fn get_market_events( &self, slug: &str, page: Option<u64>, limit: Option<u64>, ) -> Result<MarketEventsResponse, LimitlessError>

Get recent market events (trades, orders, liquidity changes).

pub async fn buy_gtc( &self, private_key: &str, market_slug: &str, token_id: &str, price: f64, size: f64, owner_id: u64, ) -> Result<CreateOrderResponse, LimitlessError>

Place a GTC buy limit order — one call does it all.

Automatically fetches the venue contract, builds, signs, and submits.

pub async fn sell_gtc( &self, private_key: &str, market_slug: &str, token_id: &str, price: f64, size: f64, owner_id: u64, ) -> Result<CreateOrderResponse, LimitlessError>

Place a GTC sell limit order — one call does it all.

pub async fn buy_fok( &self, private_key: &str, market_slug: &str, token_id: &str, usdc_amount: f64, owner_id: u64, ) -> Result<CreateOrderResponse, LimitlessError>

Place a FOK buy market order — one call does it all.

pub async fn sell_fok( &self, private_key: &str, market_slug: &str, token_id: &str, share_amount: f64, owner_id: u64, ) -> Result<CreateOrderResponse, LimitlessError>

Place a FOK sell market order — one call does it all.

pub async fn cancel_all( &self, slug: &str, ) -> Result<CancelAllResponse, LimitlessError>

Cancel all open orders in a market (convenience alias).

pub async fn get_profile( &self, account: &str, ) -> Result<ProfileResponse, LimitlessError>

Get your own profile by wallet address.

pub async fn get_trades(&self) -> Result<Vec<TradeEntry>, LimitlessError>

Retrieve all AMM trades for the authenticated user.

pub async fn get_positions(&self) -> Result<PositionsResponse, LimitlessError>

Retrieve all active positions with P&L and market values.

pub async fn get_pnl_chart( &self, timeframe: Option<&str>, ) -> Result<PnlChartResponse, LimitlessError>

Get PnL chart data.

pub async fn get_points(&self) -> Result<PointsResponse, LimitlessError>

Get points breakdown for the authenticated user.

pub async fn get_history( &self, cursor: Option<&str>, limit: Option<u64>, ) -> Result<HistoryResponse, LimitlessError>

Get cursor-paginated portfolio history.

pub async fn get_allowance( &self, allowance_type: &str, spender: Option<&str>, ) -> Result<AllowanceResponse, LimitlessError>

Check USDC allowance for CLOB or NegRisk trading.

pub async fn get_navigation_tree( &self, ) -> Result<Vec<NavigationNode>, LimitlessError>

Get the full hierarchical navigation tree.

pub async fn get_page_by_path( &self, path: &str, ) -> Result<MarketPage, LimitlessError>

Resolve a URL path to a market page configuration.

pub async fn list_page_markets( &self, page_id: &str, cursor: Option<&str>, page: Option<u64>, limit: Option<u64>, sort_by: Option<&str>, filters: Option<&BTreeMap<String, String>>, ) -> Result<PageMarketsResponse, LimitlessError>

List markets belonging to a specific market page.

pub async fn list_property_keys( &self, ) -> Result<Vec<PropertyKey>, LimitlessError>

List all property keys with their options.

pub async fn get_property_key( &self, key_id: &str, ) -> Result<PropertyKey, LimitlessError>

Get a specific property key by ID.

pub async fn list_property_options( &self, key_id: &str, parent_id: Option<&str>, ) -> Result<Vec<PropertyOption>, LimitlessError>

List options for a specific property key.

pub async fn ws_ping(&self) -> Result<(), LimitlessError>

Test WebSocket connectivity with a ping/pong.

pub async fn ws_subscribe<F>(&self, handler: F) -> Result<(), LimitlessError>

where F: FnMut(Value) -> Result<(), LimitlessError> + 'static + Send,

Subscribe to WebSocket events with a handler callback.

pub async fn ws_subscribe_with_commands<F>( &self, cmd_receiver: UnboundedReceiver<String>, handler: F, ) -> Result<(), LimitlessError>

where F: FnMut(Value) -> Result<(), LimitlessError> + 'static + Send,

Subscribe to WebSocket events with dynamic command support.

pub async fn ws_subscribe_authenticated_with_commands<F>( &self, cmd_receiver: UnboundedReceiver<String>, handler: F, ) -> Result<(), LimitlessError>

where F: FnMut(Value) -> Result<(), LimitlessError> + 'static + Send,

Subscribe to WebSocket events with dynamic command support and authentication.

Enables private channels: subscribe_positions, subscribe_order_events.

pub async fn ws_subscribe_authenticated_events<F>( &self, handler: F, ) -> Result<(), LimitlessError>

where F: FnMut(WsEventKind) -> Result<(), LimitlessError> + 'static + Send,

Subscribe to typed WebSocket events with authentication.

Enables private channels: positions, orderEvent.

Trait Implementations

impl Clone for LimitlessClient

fn clone(&self) -> LimitlessClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for LimitlessClient

fn default() -> Self

Returns the “default value” for a type.

impl Limitless for LimitlessClient

fn new(api_key: Option<String>, secret: Option<String>) -> Self

Create a new manager instance with optional API key and secret.

fn new_with_config( config: &Config, api_key: Option<String>, secret: Option<String>, ) -> Self

Create a new manager instance with a custom Config.