Skip to main content

Overview

The IndexerClient provides read-only access to market data, orderbooks, and account information through the Indexer API. Access via CompositeClient:

Markets API

getPerpetualMarkets()

Get all perpetual markets and their data.
Returns: Promise<MarketsResponse>

getPerpetualMarketOrderbook()

Get orderbook for a specific market.
string
required
Market identifier (e.g., “ETH-USD”)
Returns: Promise<{ bids: OrderbookLevel[], asks: OrderbookLevel[] }>

Account API

getParentSubaccount()

Get subaccount balances and positions.
string
required
Wallet address
number
required
Parent subaccount number (usually 0)
Returns: Promise<SubaccountResponse>

getOrder()

Get details of a specific order.
string
required
Order ID to query
Returns: Promise<Order>

get()

Generic GET request to Indexer API.
string
required
API endpoint path
object
Query parameters
Returns: Promise<any>

Markets Guide

Query market data

Balances Guide

Monitor balances and positions

CompositeClient

Main client interface