HTTP API

Accounts

account = indexer_client.account()

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.

Method Declaration

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

Parameters

Response

List Positions

Retrieves perpetual positions for a specific subaccount. Both open and closed/historical positions can be queried.

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

Examples: Guide - List Positions

Get Asset Positions

Retrieves asset positions and respective details of a specific subaccount.

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.

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

Get Transfers Between

Fetch information regarding a transfer between two subaccounts.

Method Declaration

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

Examples: Guide - List Orders

Get Order

Retrieves detailed information about a specific order based on its unique identifier (the order ID). To get the order ID, see how to create it or fetch the order history.

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. A fill represents a trade that has been executed.

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.

Examples: Guide - Get Fills

Get Historical PNL

Retrieves historical profit and loss (PNL) data for a specific subaccount on the exchange. 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

Get Parent Subaccount

Query for the parent subaccount, its child subaccounts, equity, collateral and margin. See more information on parent subaccounts here.

Method Declaration

pub async fn get_parent_subaccount(
    &self,
    subaccount: &ParentSubaccount,
) -> Result<ParentSubaccountResponseObject, Error>

Parameters

Response

List Parent Positions

List all positions of a parent subaccount.

Method Declaration

Parameters

Response

Get Parent Asset Positions

Query for asset positions (size, buy/sell etc) for a parent subaccount.

Method Declaration

Parameters

Response

Get Parent Transfers

Query for transfers between subaccounts associated with a parent subaccount.

Method Declaration

Parameters

Response

List Parent Orders

Query for orders filtered by order params of a parent subaccount.

Method Declaration

Parameters

Response

Get Parent Fills

Query for fills (i.e. filled orders data) for a parent subaccount.

Method Declaration

Parameters

Response

Get Parent Historical Pnl

Query for profit and loss report for the specified time/block range of a parent subaccount.

Method Declaration

Parameters

Response

Markets

TODO: How to access to the accounts space.

market = 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 the Indexer.

Method Declaration

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

Parameters

Response

Get Height

Current block height and block time (UTC) parsed by the 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

Get Compliance Screen

Screen an address to see if it is restricted.

Method Declaration

Parameters

Response

Vaults

TODO: How to access to the vaults space.

let vaults = indexer_client.vaults();

Get MegaVault Historical Pnl

MegaVault historical PnL.

Method Declaration

Parameters

Response

Get Vaults Historical Pnl

Vaults historical PnL.

Method Declaration

Parameters

Response

Get MegaVaults Positions

MegaVault positions.

Method Declaration

Parameters

Response