Class MarketQueryAPI

Hierarchy (View Summary)

BaseNadoAPI
- MarketQueryAPI

Constructors

constructor

new MarketQueryAPI(context: NadoClientContext): MarketQueryAPI
Parameters
- context: NadoClientContext
Returns MarketQueryAPI
Inherited from BaseNadoAPI.constructor
- Defined in apis/base.ts:8

Properties

`Readonly`context

context: NadoClientContext

Methods

getAllMarkets

getAllMarkets(): Promise<GetEngineAllMarketsResponse>
Retrieves all market states from the offchain engine

Returns Promise<GetEngineAllMarketsResponse>
- Defined in apis/market/MarketQueryAPI.ts:30

getEdgeAllMarkets

getEdgeAllMarkets(): Promise<Record<number, GetEngineAllMarketsResponse>>
Get all edge engine markets

Returns Promise<Record<number, GetEngineAllMarketsResponse>>
- Defined in apis/market/MarketQueryAPI.ts:37

getHealthGroups

getHealthGroups(): Promise<GetEngineHealthGroupsResponse>
Retrieves all spread health groups

Returns Promise<GetEngineHealthGroupsResponse>
- Defined in apis/market/MarketQueryAPI.ts:46

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>
- Defined in apis/market/MarketQueryAPI.ts:53

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>
- Defined in apis/market/MarketQueryAPI.ts:61

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>
- Defined in apis/market/MarketQueryAPI.ts:69

getTriggerOrders

getTriggerOrders(
params: GetTriggerOrdersParams,
): Promise<TriggerListOrdersResponse>
Queries the offchain trigger service to list trigger orders. Requires a signature
Parameters
- params: GetTriggerOrdersParams
Returns Promise<TriggerListOrdersResponse>
- Defined in apis/market/MarketQueryAPI.ts:79

getHistoricalOrders

getHistoricalOrders(
params: GetIndexerOrdersParams,
): Promise<GetIndexerOrdersResponse>
Queries indexer to fetch historical orders
Parameters
- params: GetIndexerOrdersParams
Returns Promise<GetIndexerOrdersResponse>
- Defined in apis/market/MarketQueryAPI.ts:92

getMaxOrderSize

getMaxOrderSize(params: GetEngineMaxOrderSizeParams): Promise<BigNumber>
Queries engine to determine maximum order size
Parameters
- params: GetEngineMaxOrderSizeParams
Returns Promise<BigNumber>
- Defined in apis/market/MarketQueryAPI.ts:102

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>
- Defined in apis/market/MarketQueryAPI.ts:110

getCandlesticks

getCandlesticks(
params: GetIndexerCandlesticksParams,
): Promise<GetIndexerCandlesticksResponse>
Historical candlesticks from the indexer, use getLatestMarketPrice for the latest orderbook prices
Parameters
- params: GetIndexerCandlesticksParams
Returns Promise<GetIndexerCandlesticksResponse>
- Defined in apis/market/MarketQueryAPI.ts:119

getEdgeCandlesticks

getEdgeCandlesticks(
params: GetIndexerCandlesticksParams,
): Promise<GetIndexerCandlesticksResponse>
Historical candlesticks from Edge, use getLatestMarketPrice for the latest orderbook prices
Parameters
- params: GetIndexerCandlesticksParams
Returns Promise<GetIndexerCandlesticksResponse>
- Defined in apis/market/MarketQueryAPI.ts:128

getLatestMarketPrice

getLatestMarketPrice(
params: GetEngineMarketPriceParams,
): Promise<EngineMarketPrice>
Retrieves the latest off-chain orderbook price from the engine
Parameters
- params: GetEngineMarketPriceParams
Returns Promise<EngineMarketPrice>
- Defined in apis/market/MarketQueryAPI.ts:137

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>
- Defined in apis/market/MarketQueryAPI.ts:146

getFundingRate

getFundingRate(params: GetIndexerFundingRateParams): Promise<IndexerFundingRate>
Retrieves the latest funding rate for a perp product
Parameters
- params: GetIndexerFundingRateParams
Returns Promise<IndexerFundingRate>
- Defined in apis/market/MarketQueryAPI.ts:155

getMultiProductFundingRates

getMultiProductFundingRates(
params: GetIndexerMultiProductFundingRatesParams,
): Promise<GetIndexerMultiProductFundingRatesResponse>
Retrieves the latest funding rate for multiple perp products
Parameters
- params: GetIndexerMultiProductFundingRatesParams
Returns Promise<GetIndexerMultiProductFundingRatesResponse>
- Defined in apis/market/MarketQueryAPI.ts:164

getProductSnapshots

getProductSnapshots(
params: GetIndexerProductSnapshotsParams,
): Promise<GetIndexerProductSnapshotsResponse>
Retrieves the historical snapshots for a product from the indexer
Parameters
- params: GetIndexerProductSnapshotsParams
Returns Promise<GetIndexerProductSnapshotsResponse>
- Defined in apis/market/MarketQueryAPI.ts:175

getMarketSnapshots

getMarketSnapshots(
params: GetIndexerMarketSnapshotsParams,
): Promise<GetIndexerMarketSnapshotsResponse>
Retrieves the historical snapshots for a market from the indexer
Parameters
- params: GetIndexerMarketSnapshotsParams
Returns Promise<GetIndexerMarketSnapshotsResponse>
- Defined in apis/market/MarketQueryAPI.ts:184

getEdgeMarketSnapshots

getEdgeMarketSnapshots(
params: IndexerSnapshotsIntervalParams,
): Promise<GetIndexerEdgeMarketSnapshotResponse>
Retrieves the historical snapshots for a market from Edge
Parameters
- params: IndexerSnapshotsIntervalParams
Returns Promise<GetIndexerEdgeMarketSnapshotResponse>
- Defined in apis/market/MarketQueryAPI.ts:193

getMultiProductSnapshots

getMultiProductSnapshots(
params: GetIndexerMultiProductSnapshotsParams,
): Promise<GetIndexerMultiProductSnapshotsResponse>
Retrieves the historical snapshots for multiple products from the indexer
Parameters
- params: GetIndexerMultiProductSnapshotsParams
Returns Promise<GetIndexerMultiProductSnapshotsResponse>
- Defined in apis/market/MarketQueryAPI.ts:202