IndexerGrpcSpotApi | API Reference | Injective - Powering the future of decentralized finance.

Hierarchy

IndexerGrpcSpotApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IndexerGrpcSpotApi(endpoint: string): IndexerGrpcSpotApi

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:25
Parameters
- endpoint: string
Returns IndexerGrpcSpotApi

Properties

Protected client

client: InjectiveSpotExchangeRPCClientImpl

Protected module

module: string = IndexerModule.Spot

Methods

fetchMarket

fetchMarket(marketId: string): internal.Promise<SpotMarket>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:71
Parameters
- marketId: string
Returns internal.Promise<SpotMarket>

fetchMarkets

fetchMarkets(params?: { baseDenom?: string; marketStatus?: string; quoteDenom?: string }): internal.Promise<SpotMarket[]>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:32
Parameters
- Optional params: { baseDenom?: string; marketStatus?: string; quoteDenom?: string }
  - Optional baseDenom?: string
  - Optional marketStatus?: string
  - Optional quoteDenom?: string
Returns internal.Promise<SpotMarket[]>

fetchOrderHistory

fetchOrderHistory(params?: { direction?: TradeDirection; executionTypes?: TradeExecutionType[]; isConditional?: boolean; marketId?: string; marketIds?: string[]; orderTypes?: OrderSide[]; pagination?: PaginationOption; state?: OrderState; subaccountId?: string }): internal.Promise<{ orderHistory: SpotOrderHistory[]; pagination: ExchangePagination }>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:187
Parameters
- Optional params: { direction?: TradeDirection; executionTypes?: TradeExecutionType[]; isConditional?: boolean; marketId?: string; marketIds?: string[]; orderTypes?: OrderSide[]; pagination?: PaginationOption; state?: OrderState; subaccountId?: string }
  - Optional direction?: TradeDirection
  - Optional executionTypes?: TradeExecutionType[]
  - Optional isConditional?: boolean
  - Optional marketId?: string
  - Optional marketIds?: string[]
  - Optional orderTypes?: OrderSide[]
  - Optional pagination?: PaginationOption
  - Optional state?: OrderState
  - Optional subaccountId?: string
Returns internal.Promise<{ orderHistory: SpotOrderHistory[]; pagination: ExchangePagination }>

fetchOrderbook

fetchOrderbook(marketId: string): internal.Promise<Orderbook>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:96
deprecated
- use fetchOrderbookV2
Parameters
- marketId: string
Returns internal.Promise<Orderbook>

fetchOrderbookV2

fetchOrderbookV2(marketId: string): internal.Promise<OrderbookWithSequence>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:529
Parameters
- marketId: string
Returns internal.Promise<OrderbookWithSequence>

fetchOrderbooks

fetchOrderbooks(marketIds: string[]): internal.Promise<{ marketId: string; orderbook: Orderbook }[]>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:478
deprecated
- use fetchOrderbooksV2
Parameters
- marketIds: string[]
Returns internal.Promise<{ marketId: string; orderbook: Orderbook }[]>

fetchOrderbooksV2

fetchOrderbooksV2(marketIds: string[]): internal.Promise<{ marketId: string; orderbook: OrderbookWithSequence }[]>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:504
Parameters
- marketIds: string[]
Returns internal.Promise<{ marketId: string; orderbook: OrderbookWithSequence }[]>

fetchOrders

fetchOrders(params?: { isConditional?: boolean; marketId?: string; marketIds?: string[]; orderSide?: OrderSide; pagination?: PaginationOption; subaccountId?: string }): internal.Promise<{ orders: SpotLimitOrder[]; pagination: ExchangePagination }>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:120
Parameters
- Optional params: { isConditional?: boolean; marketId?: string; marketIds?: string[]; orderSide?: OrderSide; pagination?: PaginationOption; subaccountId?: string }
  - Optional isConditional?: boolean
  - Optional marketId?: string
  - Optional marketIds?: string[]
  - Optional orderSide?: OrderSide
  - Optional pagination?: PaginationOption
  - Optional subaccountId?: string
Returns internal.Promise<{ orders: SpotLimitOrder[]; pagination: ExchangePagination }>

fetchSubaccountOrdersList

fetchSubaccountOrdersList(params?: { marketId?: string; pagination?: PaginationOption; subaccountId?: string }): internal.Promise<{ orders: SpotLimitOrder[]; pagination: ExchangePagination }>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:372
Parameters
- Optional params: { marketId?: string; pagination?: PaginationOption; subaccountId?: string }
  - Optional marketId?: string
  - Optional pagination?: PaginationOption
  - Optional subaccountId?: string
Returns internal.Promise<{ orders: SpotLimitOrder[]; pagination: ExchangePagination }>

fetchSubaccountTradesList

fetchSubaccountTradesList(params?: { direction?: TradeDirection; executionType?: TradeExecutionType; marketId?: string; pagination?: PaginationOption; subaccountId?: string }): internal.Promise<SpotTrade[]>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:418
Parameters
- Optional params: { direction?: TradeDirection; executionType?: TradeExecutionType; marketId?: string; pagination?: PaginationOption; subaccountId?: string }
  - Optional direction?: TradeDirection
  - Optional executionType?: TradeExecutionType
  - Optional marketId?: string
  - Optional pagination?: PaginationOption
  - Optional subaccountId?: string
Returns internal.Promise<SpotTrade[]>

fetchTrades

fetchTrades(params?: { direction?: TradeDirection; endTime?: number; executionSide?: TradeExecutionSide; executionTypes?: TradeExecutionType[]; marketId?: string; marketIds?: string[]; pagination?: PaginationOption; startTime?: number; subaccountId?: string }): internal.Promise<{ pagination: ExchangePagination; trades: SpotTrade[] }>

- Defined in packages/sdk-ts/src/client/indexer/grpc/IndexerGrpcSpotApi.ts:280
Parameters
- Optional params: { direction?: TradeDirection; endTime?: number; executionSide?: TradeExecutionSide; executionTypes?: TradeExecutionType[]; marketId?: string; marketIds?: string[]; pagination?: PaginationOption; startTime?: number; subaccountId?: string }
  - Optional direction?: TradeDirection
  - Optional endTime?: number
  - Optional executionSide?: TradeExecutionSide
  - Optional executionTypes?: TradeExecutionType[]
  - Optional marketId?: string
  - Optional marketIds?: string[]
  - Optional pagination?: PaginationOption
  - Optional startTime?: number
  - Optional subaccountId?: string
Returns internal.Promise<{ pagination: ExchangePagination; trades: SpotTrade[] }>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

endpoint: string

Returns IndexerGrpcSpotApi

Properties

Protected client

Protected module

Methods

fetchMarket

Parameters

marketId: string

Returns internal.Promise<SpotMarket>

fetchMarkets

Parameters

Optional params: { baseDenom?: string; marketStatus?: string; quoteDenom?: string }

Optional baseDenom?: string

Optional marketStatus?: string

Optional quoteDenom?: string

Returns internal.Promise<SpotMarket[]>

fetchOrderHistory

Parameters

Optional params: { direction?: TradeDirection; executionTypes?: TradeExecutionType[]; isConditional?: boolean; marketId?: string; marketIds?: string[]; orderTypes?: OrderSide[]; pagination?: PaginationOption; state?: OrderState; subaccountId?: string }

Optional direction?: TradeDirection

Optional executionTypes?: TradeExecutionType[]

Optional isConditional?: boolean

Optional marketId?: string

Optional marketIds?: string[]

Optional orderTypes?: OrderSide[]

Optional pagination?: PaginationOption

Optional state?: OrderState

Optional subaccountId?: string

Returns internal.Promise<{ orderHistory: SpotOrderHistory[]; pagination: ExchangePagination }>

fetchOrderbook

Parameters

marketId: string

Returns internal.Promise<Orderbook>

fetchOrderbookV2

Parameters

marketId: string

Returns internal.Promise<OrderbookWithSequence>

fetchOrderbooks

Parameters

marketIds: string[]

Returns internal.Promise<{ marketId: string; orderbook: Orderbook }[]>

fetchOrderbooksV2

Parameters

marketIds: string[]

Returns internal.Promise<{ marketId: string; orderbook: OrderbookWithSequence }[]>

fetchOrders

Parameters

Optional params: { isConditional?: boolean; marketId?: string; marketIds?: string[]; orderSide?: OrderSide; pagination?: PaginationOption; subaccountId?: string }

Optional isConditional?: boolean

Optional marketId?: string

Optional marketIds?: string[]

Optional orderSide?: OrderSide

Optional pagination?: PaginationOption

Optional subaccountId?: string

Returns internal.Promise<{ orders: SpotLimitOrder[]; pagination: ExchangePagination }>

fetchSubaccountOrdersList

Parameters

Optional params: { marketId?: string; pagination?: PaginationOption; subaccountId?: string }

Optional marketId?: string

Optional pagination?: PaginationOption

Optional subaccountId?: string

Returns internal.Promise<{ orders: SpotLimitOrder[]; pagination: ExchangePagination }>

fetchSubaccountTradesList

Parameters

Optional params: { direction?: TradeDirection; executionType?: TradeExecutionType; marketId?: string; pagination?: PaginationOption; subaccountId?: string }

Optional direction?: TradeDirection

Optional executionType?: TradeExecutionType

Optional marketId?: string

Optional pagination?: PaginationOption

Optional subaccountId?: string

Returns internal.Promise<SpotTrade[]>