IDEX SDK Reference

Index

API Clients

OrderBookRealTimeClient RestAuthenticatedClientOptions RestAuthenticatedClient RestPublicClientOptions RestPublicClient WebSocketClient WebSocketClientOptions

Enums - Request Parameters

CandleInterval TimeInForce OrderType OrderSide SelfTradePrevention PayoutProgram OrderBookRealTimeClientEvent SubscriptionNameAuthenticated SubscriptionNamePublic SubscriptionName

Enums - Response Properties

PositionSide FillType FillAction OrderStatus OrderStateChange MarketStatus TriggerType ChainTransactionStatus LiquidityProvider OrderBookLevelType PositionEventStatus MessageEventType

IDEX - Associate Wallet

RestAuthenticatedClient RestRequestAssociateWallet RestResponseAssociateWallet IDEXWallet

IDEX - Authorize Payout

RestAuthenticatedClient PayoutProgram IDEXPayoutDistribution RestRequestAuthorizePayout IDEXPayoutProgramAuthorization RestResponseAuthorizePayout

IDEX - Cancel Order

RestAuthenticatedClient RestRequestCancelOrdersByWallet RestRequestCancelOrdersByOrderIds RestRequestCancelOrdersByMarket RestRequestCancelOrdersByDelegatedKey RestRequestCancelOrders IDEXCanceledOrder RestResponseCancelOrders

IDEX - Create Order

RestAuthenticatedClient TimeInForce OrderType OrderSide SelfTradePrevention RestRequestOrderTypeLimit RestRequestOrderTypeLimitLPP RestRequestOrderTypeMarket RestRequestOrderTypeMarketLPP RestRequestOrderTypeStopLossMarket RestRequestOrderTypeStopLossLimit RestRequestOrderTypeTakeProfitMarket RestRequestOrderTypeTakeProfitLimit RestRequestOrderTypeTrailingStopMarket RestRequestOrder

IDEX - Get Candles

RestPublicClient WebSocketClient CandleInterval RestRequestGetCandles IDEXCandle RestResponseGetCandles IDEXSubscribeCandles IDEXCandleEvent IDEXCandleEventData

IDEX - Get Deposits

RestAuthenticatedClient WebSocketClient RestRequestGetDeposit RestRequestGetDeposits IDEXDeposit RestResponseGetDeposit RestResponseGetDeposits IDEXSubscribeDeposits IDEXDepositEvent IDEXDepositEventData

IDEX - Get Exchange

RestPublicClient IDEXExchange RestResponseGetExchange

IDEX - Get Fills

RestAuthenticatedClient RestRequestGetFill RestRequestGetFills IDEXFill RestResponseGetFill RestResponseGetFills

IDEX - Get Funding Payments

RestAuthenticatedClient WebSocketClient RestRequestGetFundingPayments IDEXFundingPayment RestResponseGetFundingPayments IDEXSubscribeFundingPayments IDEXFundingPaymentEvent

IDEX - Get Funding Rates

RestPublicClient RestRequestGetFundingRates IDEXFundingRate RestResponseGetFundingRates

IDEX - Get Gas Fees

RestPublicClient IDEXGasFees RestResponseGetGasFees

IDEX - Get Historical PnL

RestAuthenticatedClient RestRequestGetHistoricalPnL IDEXHistoricalProfitLoss RestResponseGetHistoricalPnL

IDEX - Get Initial Margin Fraction override

RestRequestGetInitialMarginFractionOverride RestResponseGetInitialMarginFractionOverride

IDEX - Get Liquidations

RestPublicClient WebSocketClient RestRequestGetLiquidations IDEXLiquidation RestResponseGetLiquidations IDEXSubscribeLiquidations IDEXLiquidationEvent IDEXLiquidationEventData

IDEX - Get Market Maker Rewards Epochs

RestAuthenticatedClient RestRequestGetMarketMakerRewardsEpochWithoutWallet RestRequestGetMarketMakerRewardsEpochWithWallet RestRequestGetMarketMakerRewardsEpoch RestRequestGetMarketMakerRewardsEpochs MarketMakerRewardsEpochMarketWithoutWallet MarketMakerRewardsEpochMarketWithWallet MarketMakerRewardsEpochMarket IDEXMarketMakerRewardsEpochSummary MarketMakerRewardsEpochDetailedWithoutWallet MarketMakerRewardsEpochDetailedWithWallet IDEXMarketMakerRewardsEpoch RestResponseGetMarketMakerRewardsEpoch RestResponseGetMarketMakerRewardsEpochs

IDEX - Get Markets

RestPublicClient RestRequestGetMarkets IDEXMarket RestResponseGetMarkets

IDEX - Get OrderBook

RestPublicClient WebSocketClient OrderBookPriceLevel RestRequestGetOrderBookLevel1 RestRequestGetOrderBookLevel2 IDEXOrderBook RestResponseGetOrderBookLevel1 RestResponseGetOrderBookLevel2 IDEXSubscribeOrderBookLevel1 IDEXSubscribeOrderBookLevel2 IDEXOrderBookLevel1Event IDEXOrderBookLevel1EventData IDEXOrderBookLevel2Event IDEXOrderBookLevel2EventData

IDEX - Get Orders

RestAuthenticatedClient WebSocketClient IDEXOrderFill RestRequestGetOrder RestRequestGetOrders IDEXOrder RestResponseGetOrder RestResponseGetOrders IDEXSubscribeOrders IDEXOrderEvent IDEXOrderEventDataSystemFill IDEXOrderEventDataGeneral IDEXOrderEventData IDEXOrderFillEventDataSystem IDEXOrderFillEventDataGeneral IDEXOrderFillEventData

IDEX - Get Payouts

RestAuthenticatedClient PayoutProgram RestRequestGetPayouts IDEXPayoutProgram RestResponseGetPayouts

IDEX - Get Ping

RestPublicClient RestResponseGetPing

IDEX - Get Positions

RestAuthenticatedClient WebSocketClient RestRequestGetPositions IDEXPosition RestResponseGetPositions IDEXSubscribePositions IDEXPositionEvent IDEXPositionEventData

IDEX - Get Tickers

RestPublicClient WebSocketClient RestRequestGetTickers IDEXTicker RestResponseGetTickers IDEXSubscribeTickers IDEXTickerEvent

IDEX - Get Time

RestPublicClient RestResponseGetTime

IDEX - Get Trades

RestPublicClient WebSocketClient RestRequestGetTrades IDEXTrade RestResponseGetTrades IDEXSubscribeTrades IDEXTradeEvent IDEXTradeEventData

IDEX - Get Wallets

RestAuthenticatedClient RestRequestGetWallets IDEXWallet RestResponseGetWallets

IDEX - Get WebSocket Token

RestAuthenticatedClient RestRequestGetAuthenticationToken IDEXWebSocketToken RestResponseGetAuthenticationToken

IDEX - Get Withdrawals

RestAuthenticatedClient WebSocketClient RestRequestGetWithdrawal RestRequestGetWithdrawals IDEXWithdrawal RestResponseGetWithdrawal RestResponseGetWithdrawals IDEXSubscribeWithdrawals IDEXWithdrawalEvent IDEXWithdrawalEventData

IDEX - Withdraw Funds

RestAuthenticatedClient IDEXWithdrawal RestRequestWithdrawFundsSDK RestRequestWithdrawFunds RestRequestWithdrawFundsSigned RestResponseWithdrawFunds

IDEX Interfaces

IDEXCanceledOrder IDEXWebSocketToken IDEXCandle IDEXDeposit IDEXExchange IDEXFill IDEXOrderFill IDEXFundingPayment IDEXFundingRate IDEXGasFees IDEXHistoricalProfitLoss IDEXLiquidation IDEXMarketMakerRewardsEpoch IDEXMarket IDEXOrderBook IDEXOrder IDEXPosition IDEXTicker IDEXTrade IDEXWallet IDEXWithdrawal

Stargate

StargateV2Config

Type - Utilities

Expand

WebSocket - Client Options

WebSocketClientOptionsPublicOnly WebSocketClientOptionsWithAPIKey WebSocketClientOptions

WebSocket - Message Types

IDEXCandleEvent IDEXCandleEventData IDEXDepositEvent IDEXDepositEventData IDEXFundingPaymentEvent IDEXFundingPaymentEventData IDEXLiquidationEvent IDEXLiquidationEventData IDEXOrderBookLevel1Event IDEXOrderBookLevel1EventData IDEXOrderBookLevel2Event IDEXOrderBookLevel2EventData IDEXOrderEvent IDEXOrderEventData IDEXPositionEvent IDEXPositionEventData IDEXTickerEvent IDEXTickerEventData IDEXTradeEvent IDEXTradeEventData IDEXWithdrawalEvent IDEXWithdrawalEventData

WebSocket - Subscribe

SubscriptionNameAuthenticated SubscriptionNamePublic SubscriptionName WebSocketRequestSubscribe WebSocketRequestSubscribeStrictWithTopLevelMarkets WebSocketRequestSubscribeStrictWithoutTopLevelMarkets IDEXSubscribeTickers IDEXSubscribeCandles IDEXSubscribeTrades IDEXSubscribeLiquidations IDEXSubscribeOrderBookLevel1 IDEXSubscribeOrderBookLevel2 IDEXSubscribeOrders IDEXSubscribeDeposits IDEXSubscribeWithdrawals IDEXSubscribePositions IDEXSubscribeFundingPayments IDEXSubscribeType IDEXSubscribeTypeAuthenticated IDEXSubscribeTypePublic

WebSocket - Unsubscribe

WebSocketRequestUnsubscribe WebSocketRequestUnsubscribeShortNames WebSocketRequestUnsubscribeSubscription

Base Types

RestRequestByWalletOptional RestRequestByWallet RestRequestByMarketOptional RestRequestByMarket RestRequestPagination RestRequestPaginationWithFromId RestRequestOrderBase GetOrderBookBase RestRequestWithdrawFundsBase IDEXEventBase IDEXSubscriptionEventBase IDEXSubscribeAuthenticatedBase IDEXSubscribePublicBase IDEXOrderEventDataBase IDEXOrderFillEventDataBase

Other

getStargateV2TargetConfig decodeStargateV2Payload encodeStargateV2Payload getEncodedWithdrawalPayloadForBridgeTarget depositViaStargateV2 estimateStargateV2DepositGasFeeAndQuantityDeliveredInAssetUnits estimateStargateV2WithdrawQuantity OrderBookRealTimeClientOptions WebSocketHandlerConnect WebSocketHandlerDisconnect WebSocketHandlerError WebSocketHandlerMessage PriceAndSize StandingOrder calculateInitialMarginFractionWithOverride convertToPositionBigInt calculateGrossFillQuantities determineMaximumReduceOnlyQuantityAvailableAtPriceLevel aggregateL2OrderBookAtTickSize adjustPriceToTickSize DecodedStargateV2Payload EncodedStargateV2Payload BridgeTarget FillTypeSystem FillTypeOrder ErrorShortCodes BestAvailablePriceLevels L1OrderBook L2OrderBook OrderBookFeesAndMinimums OrderBookLevelL1 OrderBookLevelL2 RestRequestOrderOfType RestRequestGetExchange WebSocketClientAuthOptions WebSocketRequestSubscribeStrict WebSocketRequestSubscriptionsList WebSocketRequest IDEXSubscriptionEvent IDEXErrorEvent IDEXSubscriptionsListEvent IDEXMessageEvent <internal>

Settings

Member Visibility

Theme