Class MarketAPI

Readonlycontext

placeOrder

• placeOrder(params: PlaceOrderParams): Promise<EnginePlaceOrderResult>

  Places an order through the engine

  Parameters

  • params: PlaceOrderParams

  Returns Promise<EnginePlaceOrderResult>

placeIsolatedOrder

• placeIsolatedOrder(
      params: PlaceIsolatedOrderParams,
  ): Promise<EnginePlaceIsolatedOrderResult>

  Places an isolated order through the engine

  Parameters

  • params: PlaceIsolatedOrderParams

  Returns Promise<EnginePlaceIsolatedOrderResult>

cancelOrders

• cancelOrders(
      params: CancelOrdersParams,
  ): Promise<EngineServerExecuteSuccessResult<"cancel_orders">>

  Cancels orders through the engine

  Parameters

  • params: CancelOrdersParams

  Returns Promise<EngineServerExecuteSuccessResult<"cancel_orders">>

cancelAndPlace

• cancelAndPlace(
      params: CancelAndPlaceOrderParams,
  ): Promise<EngineServerExecuteSuccessResult<"cancel_and_place">>

  Cancels orders through the engine and places a new one

  Parameters

  • params: CancelAndPlaceOrderParams

  Returns Promise<EngineServerExecuteSuccessResult<"cancel_and_place">>

cancelProductOrders

• cancelProductOrders(
      params: CancelProductOrdersParams,
  ): Promise<EngineServerExecuteSuccessResult<"cancel_product_orders">>

  Cancels all orders for provided products through the engine.

  Parameters

  • params: CancelProductOrdersParams

  Returns Promise<EngineServerExecuteSuccessResult<"cancel_product_orders">>

placeTriggerOrder

• placeTriggerOrder(
      params: PlaceTriggerOrderParams,
  ): Promise<TriggerServerExecuteSuccessResult<"place_order">>

  Places a trigger order through the trigger service

  Parameters

  • params: PlaceTriggerOrderParams

  Returns Promise<TriggerServerExecuteSuccessResult<"place_order">>

cancelTriggerOrders

• cancelTriggerOrders(
      params: CancelTriggerOrdersParams,
  ): Promise<TriggerServerExecuteSuccessResult<"cancel_orders">>

  Cancels all trigger orders for provided digests through the trigger service.

  Parameters

  • params: CancelTriggerOrdersParams

  Returns Promise<TriggerServerExecuteSuccessResult<"cancel_orders">>

cancelTriggerProductOrders

• cancelTriggerProductOrders(
      params: CancelTriggerProductOrdersParams,
  ): Promise<TriggerServerExecuteSuccessResult<"cancel_product_orders">>

  Cancels all trigger orders for provided products through the trigger service.

  Parameters

  • params: CancelTriggerProductOrdersParams

  Returns Promise<TriggerServerExecuteSuccessResult<"cancel_product_orders">>

getAllMarkets

• getAllMarkets(): Promise<GetAllMarketsResponse>

  Retrieves all market states from the on-chain contracts

  Returns Promise<GetAllMarketsResponse>

getAllEngineMarkets

• getAllEngineMarkets(): Promise<GetAllMarketsResponse>

  Retrieves all market states from the offchain engine

  Returns Promise<GetAllMarketsResponse>

getEdgeAllEngineMarkets

• getEdgeAllEngineMarkets(): Promise<Record<number, GetAllMarketsResponse>>

  Get all edge engine markets

  Returns Promise<Record<number, GetAllMarketsResponse>>

getHealthGroups

• getHealthGroups(): Promise<GetEngineHealthGroupsResponse>

  Retrieves all spread health groups

  Returns Promise<GetEngineHealthGroupsResponse>

validateOrderParams

• validateOrderParams(
      params: ValidateEngineOrderParams,
  ): Promise<ValidateEngineOrderResponse>

  Queries engine to determine if the order can be submitted within health requirements

  Parameters

  • params: ValidateEngineOrderParams

  Returns Promise<ValidateEngineOrderResponse>

getOpenSubaccountOrders

• getOpenSubaccountOrders(
      params: GetEngineSubaccountOrdersParams,
  ): Promise<EngineSubaccountOrders>

  Queries the offchain engine to retrieve status of any open orders for the given subaccount

  Parameters

  • params: GetEngineSubaccountOrdersParams

  Returns Promise<EngineSubaccountOrders>

getOpenSubaccountMultiProductOrders

• getOpenSubaccountMultiProductOrders(
      params: GetEngineSubaccountProductOrdersParams,
  ): Promise<GetEngineSubaccountProductOrdersResponse>

  Queries the offchain engine to retrieve status of any open orders for the given subaccount for multiple products

  Parameters

  • params: GetEngineSubaccountProductOrdersParams

  Returns Promise<GetEngineSubaccountProductOrdersResponse>

getTriggerOrders

• getTriggerOrders(
      params: GetTriggerOrdersParams,
  ): Promise<TriggerListOrdersResponse>

  Queries the offchain trigger service to list trigger orders. Requires a signature

  Parameters

  • params: GetTriggerOrdersParams

  Returns Promise<TriggerListOrdersResponse>

getHistoricalOrders

• getHistoricalOrders(
      params: GetIndexerOrdersParams,
  ): Promise<GetIndexerOrdersResponse>

  Queries indexer to fetch historical orders

  Parameters

  • params: GetIndexerOrdersParams

  Returns Promise<GetIndexerOrdersResponse>

getMaxOrderSize

• getMaxOrderSize(params: GetEngineMaxOrderSizeParams): Promise<BigNumber>

  Queries engine to determine maximum order size

  Parameters

  • params: GetEngineMaxOrderSizeParams

  Returns Promise<BigNumber>

getMarketLiquidity

• getMarketLiquidity(
      params: GetEngineMarketLiquidityParams,
  ): Promise<GetEngineMarketLiquidityResponse>

  Retrieves liquidity per price tick from the engine. The engine will skip price levels that have no liquidity, so it is not guaranteed that the bids/asks are evenly spaced

  Parameters

  • params: GetEngineMarketLiquidityParams

  Returns Promise<GetEngineMarketLiquidityResponse>

getCandlesticks

• getCandlesticks(
      params: GetIndexerCandlesticksParams,
  ): Promise<GetIndexerCandlesticksResponse>

  Historical candlesticks from the indexer, use getLatestMarketPrice for the latest orderbook prices

  Parameters

  • params: GetIndexerCandlesticksParams

  Returns Promise<GetIndexerCandlesticksResponse>

getEdgeCandlesticks

• getEdgeCandlesticks(
      params: GetIndexerCandlesticksParams,
  ): Promise<GetIndexerCandlesticksResponse>

  Historical candlesticks from Edge, use getLatestMarketPrice for the latest orderbook prices

  Parameters

  • params: GetIndexerCandlesticksParams

  Returns Promise<GetIndexerCandlesticksResponse>

getLatestMarketPrice

• getLatestMarketPrice(
      params: GetEngineMarketPriceParams,
  ): Promise<EngineMarketPrice>

  Retrieves the latest off-chain orderbook price from the engine

  Parameters

  • params: GetEngineMarketPriceParams

  Returns Promise<EngineMarketPrice>

getLatestMarketPrices

• getLatestMarketPrices(
      params: GetEngineMarketPricesParams,
  ): Promise<GetEngineMarketPricesResponse>

  Retrieves the latest off-chain orderbook price from the engine for multiple markets

  Parameters

  • params: GetEngineMarketPricesParams

  Returns Promise<GetEngineMarketPricesResponse>

getFundingRate

• getFundingRate(params: GetIndexerFundingRateParams): Promise<IndexerFundingRate>

  Retrieves the latest funding rate for a perp product

  Parameters

  • params: GetIndexerFundingRateParams

  Returns Promise<IndexerFundingRate>

getMultiProductFundingRates

• getMultiProductFundingRates(
      params: GetIndexerMultiProductFundingRatesParams,
  ): Promise<GetIndexerMultiProductFundingRatesResponse>

  Retrieves the latest funding rate for multiple perp products

  Parameters

  • params: GetIndexerMultiProductFundingRatesParams

  Returns Promise<GetIndexerMultiProductFundingRatesResponse>

getProductSnapshots

• getProductSnapshots(
      params: GetIndexerProductSnapshotsParams,
  ): Promise<GetIndexerProductSnapshotsResponse>

  Retrieves the historical snapshots for a product from the indexer

  Parameters

  • params: GetIndexerProductSnapshotsParams

  Returns Promise<GetIndexerProductSnapshotsResponse>

getMarketSnapshots

• getMarketSnapshots(
      params: GetIndexerMarketSnapshotsParams,
  ): Promise<GetIndexerMarketSnapshotsResponse>

  Retrieves the historical snapshots for a market from the indexer

  Parameters

  • params: GetIndexerMarketSnapshotsParams

  Returns Promise<GetIndexerMarketSnapshotsResponse>

getEdgeMarketSnapshots

• getEdgeMarketSnapshots(
      params: IndexerSnapshotsIntervalParams,
  ): Promise<GetIndexerEdgeMarketSnapshotResponse>

  Retrieves the historical snapshots for a market from Edge

  Parameters

  • params: IndexerSnapshotsIntervalParams

  Returns Promise<GetIndexerEdgeMarketSnapshotResponse>

getMultiProductSnapshots

• getMultiProductSnapshots(
      params: GetIndexerMultiProductSnapshotsParams,
  ): Promise<GetIndexerMultiProductSnapshotsResponse>

  Retrieves the historical snapshots for multiple products from the indexer

  Parameters

  • params: GetIndexerMultiProductSnapshotsParams

  Returns Promise<GetIndexerMultiProductSnapshotsResponse>