Indexer Client

TODO: How to create a client instance

let indexer_client = IndexerClient::new(config);

Accounts

let accounts = indexer_client.accounts();

Get Subaccounts

Retrieves a list of subaccounts associated with a given address. Subaccounts are related addresses that fall under the authority or ownership of the primary address.

Method Declaration

async def get_subaccounts(
    self,
    address: str,
    limit: Optional[int] = None,
) -> Any

Parameters

Response

Get Subaccount

Retrieves a specific subaccount associated with a given address and subaccount number. This method allows you to access detailed information about a single subaccount rather than retrieving all subaccounts for an address.

Method Declaration

async def get_subaccount(
    self,
    address: str,
    subaccount_number: int,
) -> Any

Parameters

Response

List Positions

Retrieves perpetual positions for a specific subaccount. This method allows you to query and filter the active or historical perpetual positions associated with a particular subaccount.

Method Declaration

async def get_subaccount_perpetual_positions(
    self,
    address: str,
    subaccount_number: int,
    status: Optional[PositionStatus] = None,
    limit: Optional[int] = None,
    created_before_or_at_height: Optional[int] = None,
    created_before_or_at: Optional[str] = None,
) -> Any

Parameters

Response

Get Asset Positions

Retrieves asset positions for a specific subaccount on the dYdX exchange.

This function queries the dYdX indexer API to fetch asset positions (including size, side, and other details) associated with a particular subaccount.

The endpoint being called is /v4/assetPositions.

Method Declaration

async def get_subaccount_asset_positions(
    self,
    address: str,
    subaccount_number: int,
    status: Optional[PositionStatus] = None,
    limit: Optional[int] = None,
    created_before_or_at_height: Optional[int] = None,
    created_before_or_at: Optional[str] = None,
) -> Any

Parameters

Response

A data structure containing the requested asset positions. Typically includes details such as asset ID, size, side (buy/sell), entry price, realized PnL, and other position-specific information.

Get Transfers

Retrieves the transfer history for a specific subaccount.

This method allows you to query and filter the transfer transactions associated with a particular subaccount.

Method Declaration

async def get_subaccount_transfers(
    self,
    address: str,
    subaccount_number: int,
    limit: Optional[int] = None,
    created_before_or_at_height: Optional[int] = None,
    created_before_or_at: Optional[str] = None,
) -> Any

Parameters

Response

List Orders

Retrieves orders for a specific subaccount, with various filtering options to narrow down the results based on order characteristics.

Method Declaration

async def get_subaccount_orders(
    self,
    address: str,
    subaccount_number: int,
    ticker: Optional[str] = None,
    ticker_type: TickerType = TickerType.PERPETUAL,
    side: Optional[OrderSide] = None,
    status: Optional[OrderStatus] = None,
    type: Optional[OrderType] = None,
    limit: Optional[int] = None,
    good_til_block_before_or_at: Optional[int] = None,
    good_til_block_time_before_or_at: Optional[str] = None,
    return_latest_orders: Optional[bool] = None,
) -> Any

Parameters

Response

Get Order

Retrieves detailed information about a specific order based on its unique identifier.

This method allows clients to fetch the details of a particular order from the exchange by providing its order ID.

The method sends a GET request to the /v4/orders/{orderId} endpoint and returns the order data.

Method Declaration

async def get_order(
    self,
    order_id: str,
) -> Any

Parameters

Response

Get Fills

Retrieves fill records for a specific subaccount on the exchange.

This function queries the dYdX indexer API to fetch fill data (executed orders) associated with a particular subaccount. The endpoint being called is /v4/fills.

A fill represents a trade that has been executed on the exchange.

Method Declaration

async def get_subaccount_fills(
    self,
    address: str,
    subaccount_number: int,
    ticker: Optional[str] = None,
    ticker_type: TickerType = TickerType.PERPETUAL,
    limit: Optional[int] = None,
    created_before_or_at_height: Optional[int] = None,
    created_before_or_at: Optional[str] = None,
) -> Any

Parameters

Response

A promise that resolves to fill data containing details such as order ID, market, side (buy/sell), size, price, execution time, and other fill-specific information.

Get Historical Pnl

Retrieves historical profit and loss (PNL) data for a specific subaccount on the exchange.

This function queries the dYdX indexer API to fetch historical PNL records associated with a particular subaccount. The endpoint being called is '/v4/historical-pnl'.

These records provide insights into the trading performance over time.

Method Declaration

async def get_subaccount_historical_pnls(
    self,
    address: str,
    subaccount_number: int,
    effective_before_or_at: Optional[str] = None,
    effective_at_or_after: Optional[str] = None,
) -> Any

Parameters

Response

Get Rewards

Retrieves historical block trading rewards for the specified address.

Method Declaration

async def get_historical_block_trading_rewards(
    self,
    address: str,
    limit: Optional[int] = None,
) -> Any

Parameters

Response

Get Rewards Aggregated

Retrieves aggregated historical trading rewards for the specified address.

Method Declaration

async def get_historical_trading_rewards_aggregated(
    self,
    address: str,
    period: TradingRewardAggregationPeriod = TradingRewardAggregationPeriod.DAILY,
    limit: Optional[int] = None,
    starting_before_or_at: Optional[str] = None,
    starting_before_or_at_height: Optional[int] = None,
) -> Any

Parameters

Response

Markets

TODO: How to access to the accounts space.

let markets = indexer_client.markets();

Get Perpetual Markets

Retrieves perpetual markets.

Method Declaration

def get_perpetual_markets(self, market: str = None) -> Response

Parameters

Response

Get Perpetual Market Orderbook

Retrieves the orderbook for a specific perpetual market.

Method Declaration

async def get_perpetual_market_orderbook(
    self,
    market: str,
) -> dict

Parameters

Response

Get Trades

Retrieves trades for a specific perpetual market.

Method Declaration

async def get_perpetual_market_trades(
    self,
    market: str,
    starting_before_or_at_height: Optional[int] = None,
    limit: Optional[int] = None,
) -> dict

Parameters

Response

Get Candles

Retrieves candle data for a specific perpetual market.

Method Declaration

async def get_perpetual_market_candles(
    self,
    market: str,
    resolution: str,
    from_iso: Optional[str] = None,
    to_iso: Optional[str] = None,
    limit: Optional[int] = None,
) -> dict

Parameters

Response

Get Historical Funding

Retrieves historical funding rates for a specific perpetual market.

Method Declaration

async def get_perpetual_market_historical_funding(
    self,
    market: str,
    effective_before_or_at: Optional[str] = None,
    effective_before_or_at_height: Optional[int] = None,
    limit: Optional[int] = None,
) -> dict

Parameters

Response

Get Sparklines

Retrieves sparkline data for perpetual markets.

Method Declaration

async def get_perpetual_market_sparklines(
    self,
    period: str = TimePeriod.ONE_DAY
) -> dict

Parameters

Response

Utility

// TODO: Add description

Method Declaration

Get Time

Get current server time of Indexer

Method Declaration

async def get_time(self) -> Dict[str, str]

Parameters

Response

Get Height

Current block height and block time (UTC) parsed by Indexer.

Method Declaration

async def get_height(self) -> Dict[str, str]

Parameters

Response

Get Screen

Query for screening results (compliance) of the address.

Method Declaration

async def screen(self, address: str) -> Dict[str, bool]:

Parameters

Response