@idexio/idex-sdk v2.3.0

API

Table of Contents

• Clients
  • PublicClient
    • Parameters
    • ping
    • getServerTime
    • getExchangeInfo
    • getAssets
    • getMarkets
      • Parameters
    • getOrderBookLevel1
      • Parameters
    • getOrderBookLevel2
      • Parameters
    • getTickers
      • Parameters
    • getCandles
      • Parameters
    • getTrades
      • Parameters
  • AuthenticatedClient
    • Parameters
    • cancelOrder
      • Parameters
    • cancelOrders
      • Parameters
    • getBalances
      • Parameters
    • getDeposit
      • Parameters
    • getDeposits
      • Parameters
    • getFill
      • Parameters
    • getFills
      • Parameters
    • getOrder
      • Parameters
    • getOrders
      • Parameters
    • getUser
      • Parameters
    • getWallets
      • Parameters
    • getWithdrawal
      • Parameters
    • getWithdrawals
      • Parameters
    • placeOrder
      • Parameters
    • placeTestOrder
      • Parameters
    • withdraw
      • Parameters
    • getWsToken
      • Parameters
• Enums
  • CandleInterval
    • 1m
    • 5m
    • 15m
    • 30m
    • 1h
    • 6h
    • 1d
  • EthTransactionStatus
    • pending
    • mined
    • failed
  • Liquidity
    • maker
    • taker
  • MarketStatus
    • inactive
    • cancelsOnly
    • active
  • OrderSelfTradePrevention
    • dc
    • co
    • cn
    • cb
  • OrderSide
    • buy
    • sell
  • OrderStateChange
    • new
    • activated
    • fill
    • cancelled
    • expired
  • OrderStatus
    • active
    • open
    • partiallyFilled
    • filled
    • cancelled
    • rejected
    • expired
    • testOnlyAccepted
    • testOnlyRejected
  • OrderTimeInForce
    • gtc
    • gtt
    • ioc
    • fok
  • OrderType
    • market
    • limit
    • limitMaker
    • stopLoss
    • stopLossLimit
    • takeProfit
    • takeProfitLimit
• Requests
  • request.CancelOrders
    • Properties
  • request.FindCandles
    • Properties
  • request.FindDeposit
    • Properties
  • request.FindDeposits
    • Properties
  • request.FindFill
    • Properties
  • request.FindFills
    • Properties
  • request.FindOrder
    • Properties
  • request.FindOrders
    • Properties
  • request.FindTrades
    • Properties
  • request.FindWithdrawal
    • Properties
  • request.FindWithdrawals
    • Properties
  • request.Order
    • Properties
  • request.Withdrawal
    • Properties
• Responses
  • response.Asset
    • Properties
  • response.Balance
    • Properties
  • response.Candle
    • Properties
  • response.Deposit
    • Properties
  • response.ExchangeInfo
    • Properties
  • response.Fill
    • Properties
  • response.Market
    • Properties
  • response.Order
    • Properties
  • response.OrderBookLevel1
    • Properties
  • response.OrderBookLevel2
    • Properties
  • response.OrderBookPriceLevel
  • response.OrderFill
    • Properties
  • response.Ping
  • response.Ticker
    • Properties
  • response.Time
    • Properties
  • response.Trade
    • Properties
  • response.User
    • Properties
  • response.Wallet
    • Properties
  • response.WebSocketToken
    • Properties
  • response.Withdrawal
    • Properties
• WebSocket Responses
  • webSocketResponse.Error
    • Properties
• WebsocketTokenManager
  • Parameters
• ConnectListener
• request.FindBalances
  • Properties
• constructor
  • Parameters
• subscribeAuthenticated
  • Parameters
• subscribeUnauthenticated
  • Parameters
• request.FindMarkets
  • Properties
• webSocketResponse.Subscriptions
  • Properties
• RawResponseMessage
• OrderBookPrice
• OrderBookSize
• OrderBookNumOrders
• autoDispatchEnabled

Clients

PublicClient

Public API client

import * as idex from '@idexio/idex-node';

// Edit the values below for your environment
const config = {
  baseURL: 'https://api-sandbox.idex.io/v1',
  apiKey:
    'MTQxMA==.MQ==.TlRnM01qSmtPVEF0TmpJNFpDMHhNV1ZoTFRrMU5HVXROMlJrTWpRMVpEUmlNRFU0',
};

const publicClient = new idex.PublicClient(config.baseURL);

// Optionally provide an API key to increase rate limits
const publicClientWithApiKey = new idex.PublicClient(
  config.baseURL,
  config.apiKey,
);

Parameters

• baseURL string
• apiKey string? Increases rate limits if provided
• baseUrl string

ping

Test connectivity to the REST API

Returns Promise<{: never}>

getServerTime

Get the current server time

Returns Promise<number> Milliseconds since UNIX epoch

getExchangeInfo

Get basic exchange info

Returns Promise<response.ExchangeInfo>

getAssets

Get comprehensive list of assets

Returns Promise<Array<response.Asset>>

getMarkets

Get currently listed markets

Parameters

• findMarkets FindMarkets

Returns Promise<Array<response.Market>>

getOrderBookLevel1

Get current top bid/ask price levels of order book for a market

Parameters

• market string Base-quote pair e.g. 'IDEX-ETH'

Returns Promise<response.OrderBookLevel1>

getOrderBookLevel2

Get current order book price levels for a market

Parameters

• market string Base-quote pair e.g. 'IDEX-ETH'
• limit number Number of bids and asks to return. Default is 50, 0 returns the entire book (optional, default 50)

Returns Promise<response.OrderBookLevel2>

getTickers

Get currently listed markets

Parameters

• market string? Base-quote pair e.g. 'IDEX-ETH', if provided limits ticker data to a single market

Returns Promise<Array<response.Ticker>>

getCandles

Get candle (OHLCV) data for a market

Parameters

• findCandles FindCandles

Returns Promise<Array<response.Candle>>

getTrades

Get public trade history for a market

Parameters

• findTrades request.FindTrades

Returns Promise<Array<response.Trade>>

AuthenticatedClient

Authenticated API client

import * as idex from '@idexio/idex-node';

// Edit the values below for your environment
const config = {
  baseURL: 'https://api-sandbox.idex.io/v1',
  apiKey:
    'MTQxMA==.MQ==.TlRnM01qSmtPVEF0TmpJNFpDMHhNV1ZoTFRrMU5HVXROMlJrTWpRMVpEUmlNRFU0',
  apiSecret: 'axuh3ywgg854aq7m73oy6gnnpj5ar9a67szuw5lclbz77zqu0j',
  walletPrivateKey: '0x3141592653589793238462643383279502884197169399375105820974944592'
};

const authenticatedClient = new idex.AuthenticatedClient(
  config.baseURL,
  config.apiKey,
  config.apiSecret,
);

Parameters

• baseURL string
• apiKey string
• apiSecret string

cancelOrder

Cancel a single order

Parameters

• cancelOrder request.CancelOrder
• sign function (hash: string): Promise<string>
• order string

Returns Promise<response.Order>

cancelOrders

Cancel multiple orders

Parameters

• cancelOrders request.CancelOrders
• sign function (hash: string): Promise<string>
• order string

Returns Promise<Array<response.Order>>

getBalances

Get asset quantity data (positions) held by a wallet on the exchange

Parameters

• nonce string UUIDv1
• wallet string Ethereum wallet address
• asset string?

Returns Promise<Array<response.Balance>>

getDeposit

Get a deposit

Parameters

• findDeposit request.FindDeposit

Returns Promise<response.Deposit>

getDeposits

Get multiple deposits

Parameters

• findDeposits request.FindDeposits

Returns Promise<Array<response.Deposit>>

getFill

Get a fill

Parameters

• findFill request.FindFill

Returns Promise<response.Fill>

getFills

Get multiple fills

Parameters

• findFills request.FindFills

Returns Promise<Array<response.Fill>>

getOrder

Get an order

Parameters

• findOrder request.FindOrder

Returns Promise<response.Order>

getOrders

Get multiple orders

Parameters

• findOrders request.FindOrders

Returns Promise<Array<response.Order>>

getUser

Get account details for the API key’s user

Parameters

• nonce string UUIDv1

Returns Promise<response.User>

getWallets

Get account details for the API key’s user

Parameters

• nonce string UUIDv1

Returns Promise<Array<response.Wallet>>

getWithdrawal

Get a withdrawal

Parameters

• findWithdrawal request.FindWithdrawal

Returns Promise<response.Withdrawal>

getWithdrawals

Get multiple withdrawals

Parameters

• findWithdrawals request.FindWithdrawals

Returns Promise<Array<response.Withdrawal>>

placeOrder

Place a new order

Example:

 await authenticatedClient.placeOrder(
  orderObject, // See type
  sign: idex.getPrivateKeySigner(config.walletPrivateKey),
);

Parameters

• order request.Order
• sign function Sign hash function implementation. Possbile to use built-in getPrivateKeySigner('YourPrivateKey')

Returns Promise<response.Order>

placeTestOrder

Test new order creation, validation, and trading engine acceptance, but no order is placed or executed

Example:

 await authenticatedClient.placeTestOrder(
  orderObject, // See type
  sign: idex.getPrivateKeySigner(config.walletPrivateKey),
);

Parameters

• order request.Order
• sign function Sign hash function implementation. Possbile to use built-in getPrivateKeySigner('YourPrivateKey')

Returns Promise<response.Order>

withdraw

Create a new withdrawal

Example:

 await authenticatedClient.withdraw(
  withdrawalObject, // See type
  sign: idex.getPrivateKeySigner(config.walletPrivateKey),
);

Parameters

• withdrawal request.Withdrawal
• sign function Sign hash function implementation. Possbile to use built-in getPrivateKeySigner('YourPrivateKey')

Returns Promise<response.Withdrawal>

getWsToken

Obtain a WebSocket API token

Parameters

• nonce string UUIDv1
• wallet string Ethereum wallet address

Returns Promise<string>

Enums

Sets of named constants used as field types for several requests and responses

CandleInterval

Type: string

1m

Type: string

5m

Type: string

15m

Type: string

30m

Type: string

1h

Type: string

6h

Type: string

1d

Type: string

EthTransactionStatus

Type: string

pending

Either not yet submitted or not yet mined

Type: string

mined

Mined, no need for any block confirmation delay

Type: string

failed

Transaction reverted

Type: string

Liquidity

Type: string

maker

Maker provides liquidity

Type: string

taker

Taker removes liquidity

Type: string

MarketStatus

Type: string

inactive

No orders or cancels accepted

Type: string

cancelsOnly

Cancels accepted but not trades

Type: string

active

Trades and cancels accepted

Type: string

OrderSelfTradePrevention

Type: string

dc

Decrement And Cancel (DC) - When two orders from the same user cross, the smaller order will be canceled and the larger order size will be decremented by the smaller order size. If the two orders are the same size, both will be canceled.

Type: string

co

Cancel Oldest (CO) - Cancel the older (maker) order in full

Type: string

cn

Cancel Newest (CN) - Cancel the newer, taker order and leave the older, resting order on the order book. This is the only valid option when time-in-force is set to fill or kill

Type: string

cb

Cancel Both (CB) - Cancel both orders

Type: string

OrderSide

Type: string

buy

Type: string

sell

Type: string

OrderStateChange

Type: string

new

An order without a stop has been accepted into the trading engine. Will not be sent as a discrete change event if the order matches on execution.

Type: string

activated

A stop order has accepted into the trading engine, once triggered, will go through other normal events starting with new

Type: string

fill

An order has generated a fill, both on maker and taker sides. Will be the first change event sent if an order matches on execution.

Type: string

cancelled

An order is cancelled by the user.

Type: string

expired

LIMIT FOK orders with no fill, LIMIT IOC or MARKET orders that partially fill, GTT orders past time.

Type: string

OrderStatus

Type: string

active

Stop order exists on the order book

Type: string

open

Limit order exists on the order book

Type: string

partiallyFilled

Limit order has completed fills but has remaining open quantity

Type: string

filled

Limit order is completely filled and is no longer on the book; market order was filled

Type: string

cancelled

Limit order was cancelled prior to execution completion but may be partially filled

Type: string

rejected

Order was rejected by the trading engine

Type: string

expired

GTT limit order expired prior to execution completion but may be partially filled

Type: string

testOnlyAccepted

Order submitted to the test endpoint and accepted by the trading engine, not executed

Type: string

testOnlyRejected

Order submitted to the test endpoint and rejected by validation or the trading engine, not executed

Type: string

OrderTimeInForce

Type: string

gtc

Good until cancelled (default)

Type: string

gtt

Good until time

Type: string

ioc

Immediate or cancel

Type: string

fok

Fill or kill

Type: string

OrderType

Type: string

market

Type: string

limit

Type: string

limitMaker

Type: string

stopLoss

Type: string

stopLossLimit

Type: string

takeProfit

Type: string

takeProfitLimit

Type: string

Requests

request.CancelOrders

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• orderId string? Single orderId or clientOrderId to cancel; prefix client-provided ids with client:
• market string? Base-quote pair e.g. 'IDEX-ETH'

request.FindCandles

Type: Object

Properties

• market string Base-quote pair e.g. 'IDEX-ETH'
• interval CandleInterval Time interval for data
• start number? Starting timestamp (inclusive)
• end number? Ending timestamp (inclusive)
• limit number? Max results to return from 1-1000

request.FindDeposit

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• depositId string

request.FindDeposits

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• asset string? Asset by symbol
• start number? Starting timestamp (inclusive)
• end number? Ending timestamp (inclusive)
• limit number? Max results to return from 1-1000
• fromId string? Fills created at the same timestamp or after fillId

request.FindFill

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• fillId string

request.FindFills

Type: Object

Properties

• nonce string UUIDv1
• wallet string Ethereum wallet address
• market string Base-quote pair e.g. 'IDEX-ETH'
• start number? Starting timestamp (inclusive)
• end number? Ending timestamp (inclusive)
• limit number? Max results to return from 1-1000
• fromId string? Fills created at the same timestamp or after fillId

request.FindOrder

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• orderId string Single orderId or clientOrderId to cancel; prefix client-provided ids with client:

request.FindOrders

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• market string? Base-quote pair e.g. 'IDEX-ETH'
• closed boolean? false only returns active orders on the order book; true only returns orders that are no longer on the order book and resulted in at least one fill; only applies if orderId is absent
• start number? Starting timestamp (inclusive)
• end number? Ending timestamp (inclusive)
• limit number? Max results to return from 1-1000
• fromId string? orderId of the earliest (oldest) order, only applies if orderId is absent

request.FindTrades

Type: Object

Properties

• market string Base-quote pair e.g. 'IDEX-ETH'
• start number? Starting timestamp (inclusive)
• end number? Ending timestamp (inclusive)
• limit number? Max results to return from 1-1000
• fromId string? Trades created at the same timestamp or after fromId

request.FindWithdrawal

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• withdrawalId string

request.FindWithdrawals

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• asset string? Asset by symbol
• assetContractAddress string? Asset by contract address
• start number? Starting timestamp (inclusive)
• end number? Ending timestamp (inclusive)
• limit number? Max results to return from 1-1000
• fromId string? Withdrawals created after the fromId

request.Order

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• market string Base-quote pair e.g. 'IDEX-ETH'
• type OrderType
• side OrderSide
• timeInForce OrderTimeInForce? Defaults to good until canceled
• quantity string? Order quantity in base terms, exclusive with quoteOrderQuantity
• quoteOrderQuantity string? Order quantity in quote terms, exclusive with quantity
• price string? Price in quote terms, optional for market orders
• clientOrderId ustring? Client-supplied order id
• stopPrice string? Stop loss or take profit price, only if stop or take order
• selfTradePrevention OrderSelfTradePrevention? Defaults to decrease and cancel
• cancelAfter number? Timestamp after which a standing limit order will be automatically cancelled; gtt tif only

request.Withdrawal

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• asset string? Asset by symbol
• assetContractAddress string? Asset by contract address
• quantity string Withdrawal amount in asset terms, fees are taken from this value

Responses

response.Asset

Asset

Type: Object

Properties

• id number Internal id of the asset
• name string
• symbol string
• contractAddress string
• decimals string
• depositMinimum string
• tradeMinimum string
• withdrawalMinimum string

response.Balance

Balance

Type: Object

Properties

• asset string Asset symbol
• quantity string Total quantity of the asset held by the wallet on the exchange
• availableForTrade string Quantity of the asset available for trading; quantity - locked
• locked string Quantity of the asset held in trades on the order book
• usdValue string Total value of the asset held by the wallet on the exchange in USD

response.Candle

Candle (OHLCV) data points aggregated by time interval

Type: Object

Properties

• start number Time of the start of the interval
• open string Price of the first fill of the interval in quote terms
• high string Price of the highest fill of the interval in quote terms
• low string Price of the lowest fill of the interval in quote terms
• close string Price of the last fill of the interval in quote terms
• volume string Total volume of the period in base terms
• sequence number Fill sequence number of the last trade in the interval

response.Deposit

Asset deposits into smart contract

Type: Object

Properties

• depositId string IDEX-issued deposit identifier
• asset string Asset by symbol
• quantity string Deposit amount in asset terms
• txId string Ethereum transaction hash
• txTime number Timestamp of the Ethereum deposit tx
• confirmationTime number Timestamp of credit on IDEX including block confirmations

response.ExchangeInfo

Basic exchange info

Type: Object

Properties

• timeZone string Server time zone, always UTC
• serverTime number Current server time
• ethereumDepositContractAddress string Ethereum address of the exchange custody contract for deposits
• ethUsdPrice string Current price of ETH in USD
• gasPrice number Current gas price used by the exchange for trade settlement and withdrawal transactions in Gwei
• volume24hUsd string Total exchange trading volume for the trailing 24 hours in USD
• makerFeeRate string Maker trade fee rate
• takerFeeRate string Taker trade fee rate
• makerTradeMinimum string Minimum size of an order that can rest on the order book in ETH, applies to both ETH and tokens
• takerTradeMinimum string Minimum order size that is accepted by the matching engine for execution in ETH, applies to both ETH and tokens
• withdrawMinimum string Minimum withdrawal amount in ETH, applies to both ETH and tokens

response.Fill

Fill

Type: Object

Properties

• fillId string Internal ID of fill
• orderId string Internal ID of order
• clientOrderId string? Client-provided ID of order
• market string Base-quote pair e.g. 'IDEX-ETH'
• price string Executed price of fill in quote terms
• quantity string Executed quantity of fill in base terms
• quoteQuantity string Executed quantity of trade in quote terms
• makerSide OrderSide Which side of the order the liquidity maker was on
• fee string Fee amount on fill
• feeAsset string Which token the fee was taken in
• gas string
• side OrderSide
• liquidity Liquidity
• time string Fill timestamp
• sequence string Last trade sequence number for the market
• txId string? Ethereum transaction id, if available
• txStatus string Eth Tx Status

response.Market

Market

Type: Object

Properties

• market string Base-quote pair e.g. 'IDEX-ETH'
• status MarketStatus
• baseAsset string e.g. 'IDEX'
• baseAssetPrecision number
• quoteAsset string e.g. 'ETH'
• quoteAssetPrecision number
• makerFeeRate string
• takerFeeRate string
• orderTypes Array<OrderType>
• tradeMinimum string Minimum quantity in base terms

response.Order

Order

Type: Object

Properties

• market string Market symbol as base-quote pair e.g. 'IDEX-ETH'
• orderId string Exchange-assigned order identifier
• clientOrderId string? Client-specified order identifier
• wallet string Ethereum address of placing wallet
• time string Time of initial order processing by the matching engine
• status OrderStatus Current order status
• errorCode string? Error short code explaining order error or failed batch cancel
• errorMessage string? Error description explaining order error or failed batch cancel
• type OrderType Order type
• side OrderSide Order side
• originalQuantity string? Original quantity specified by the order in base terms, omitted for market orders specified in quote terms
• originalQuoteQuantity string? Original quantity specified by the order in quote terms, only present for market orders specified in quote terms
• executedQuantity string Quantity that has been executed in base terms
• cumulativeQuoteQuantity string Cumulative quantity that has been spent (buy orders) or received (sell orders) in quote terms, omitted if unavailable for historical orders
• avgExecutionPrice string? Weighted average price of fills associated with the order; only present with fills
• price string? Original price specified by the order in quote terms, omitted for all market orders
• stopPrice string? Stop loss or take profit price, only present for stopLoss, stopLossLimit, takeProfit, and takeProfitLimit orders
• timeInForce OrderTimeInForce? Time in force policy, see values, only present for all limit orders specifying a non-default (gtc) policy
• selfTradePrevention OrderSelfTradePrevention? Self-trade prevention policy, see values, only present for orders specifying a non-default (dc) policy
• null-null Array<response.OrderFill> Array of order fill objects

response.OrderBookLevel1

OrderBookLevel1

Type: Object

Properties

• bids [response.OrderBookPriceLevel]
• asks [response.OrderBookPriceLevel]

response.OrderBookLevel2

OrderBookLevel2

Type: Object

Properties

• bids Array<response.OrderBookPriceLevel>
• asks Array<response.OrderBookPriceLevel>

response.OrderBookPriceLevel

OrderBookPriceLevel

Type: [OrderBookPrice, OrderBookSize, OrderBookNumOrders]

response.OrderFill

OrderFill

Type: Object

Properties

• fillId string Internal ID of fill
• price string Executed price of fill in quote terms
• quantity string Executed quantity of fill in base terms
• quoteQuantity string Executed quantity of trade in quote terms
• makerSide OrderSide Which side of the order the liquidity maker was on
• fee string Fee amount on fill
• feeAsset string Which token the fee was taken in
• gas string?
• liquidity Liquidity
• time string Fill timestamp
• sequence number Last trade sequence number for the market
• txId string? Ethereum transaction id, if available
• txStatus string Eth Tx Status

response.Ping

Ping

Type: Object

response.Ticker

Ticker

Type: Object

Properties

• market string Base-quote pair e.g. 'IDEX-ETH'
• percentChange string % change from open to close
• baseVolume string 24h volume in base terms
• quoteVolume string 24h volume in quote terms
• low string? Lowest traded price in the period in quote terms
• high string? Highest traded price in the period in quote terms
• bid string? Best bid price on the order book
• ask string? Best ask price on the order book
• open string? Price of the first trade for the period in quote terms
• close string? Same as last
• closeQuantity string? Quantity of the last period in base terms
• time number Time when data was calculated, open and change is assumed to be trailing 24h
• numTrades number Number of fills for the market in the period
• sequence number? Last trade sequence number for the market

response.Time

Time

Type: Object

Properties

• time number Current server time

response.Trade

Trade

Type: Object

Properties

• fillId string Internal ID of fill
• price string Executed price of trade in quote terms
• quantity string Executed quantity of trade in base terms
• quoteQuantity string Executed quantity of trade in quote terms
• time number Fill timestamp
• makerSide OrderSide Which side of the order the liquidity maker was on
• sequence number Last trade sequence number for the market

response.User

User

Type: Object

Properties

• depositEnabled boolean Deposits are enabled for the user account
• orderEnabled boolean Placing orders is enabled for the user account
• cancelEnabled boolean Cancelling orders is enabled for the user account
• withdrawEnabled boolean Withdrawals are enabled for the user account
• kycTier number Approved KYC tier; 0, 1, 2
• totalPortfolioValueUsd string Total value of all holdings deposited on the exchange, for all wallets associated with the user account, in USD
• withdrawalLimit string 24-hour withdrawal limit in USD, or unlimited, determined by KYC tier
• withdrawalRemaining string Currently withdrawable amount in USD, or unlimited, based on trailing 24 hour withdrawals and KYC tier
• makerFeeRate string User-specific maker trade fee rate
• takerFeeRate string User-specific taker trade fee rate

response.Wallet

Type: Object

Properties

• address string Ethereum address of the wallet
• totalPortfolioValueUsd string Total value of all holdings deposited on the exchange for the wallet in USD
• time number Timestamp of association of the wallet with the user account

response.WebSocketToken

Type: Object

Properties

• token string WebSocket subscription authentication token

response.Withdrawal

Type: Object

Properties

• withdrawalId string Exchange-assigned withdrawal identifier
• asset string? Symbol of the withdrawn asset, exclusive with assetContractAddress
• assetContractAddress string? Token contract address of withdrawn asset, exclusive with asset
• quantity string Quantity of the withdrawal
• time number Timestamp of withdrawal API request
• fee string Amount deducted from withdrawal to cover IDEX-paid gas
• txId string? Ethereum id of the withdrawal transaction
• txStatus string Status of the withdrawal settlement transaction

WebSocket Responses

webSocketResponse.Error

Error Response

Type: Object

Properties

• cid string?
• type string error
• data Object
  • data.code string error short code
  • data.message string human readable error message

WebsocketTokenManager

https://docs.idex.io/#websocket-authentication-endpoints

const wsTokenStore = new WebsocketTokenManager(wallet => client.getWsToken(uuidv1(), wallet))
const token = await wsTokenStore.getToken("0x123abc...");
wsClient.subscribe([{ name: 'balance', wallet: '0x0'}], token);

Parameters

• websocketAuthTokenFetch WebsocketTokenFetch

ConnectListener

WebSocket API client

import * as idex from '@idexio/idex-node';

const config = {
  baseURL: 'wss://ws.idex.io',
  shouldReconnectAutomatically: true,
}
const webSocketClient = new idex.WebSocketClient(
  config.baseURL,
  // Optional, but required for authenticated wallet subscriptions
  wallet => authenticatedClient.getWsToken(uuidv1(), wallet),
  config.shouldReconnectAutomatically,
);
await webSocketClient.connect();

Type: function (): any

request.FindBalances

Type: Object

Properties

• nonce string UUIDv1
• wallet string
• asset[] string? Asset symbols

constructor

Create a WebSocket client

Parameters

• baseURL string Base URL of websocket API
• websocketAuthTokenFetch function Authenticated Rest API client fetch token call (/wsToken) SDK Websocket client will then automatically handle Websocket token generation and refresh. You can omit this when using only public websocket subscription. Example wallet => authenticatedClient.getWsToken(uuidv1(), wallet) See API specification
• shouldReconnectAutomatically (optional, default false)

subscribeAuthenticated

Strictly typed subscribe which only can be used on authenticated subscriptions.

For this methods you need to pass websocketAuthTokenFetch to the websocket constructor. Library will automatically refresh user's wallet auth tokens for you.

See API specification

Parameters

• subscriptions Array<types.webSocket.AuthenticatedSubscription>

Returns void

subscribeUnauthenticated

Subscribe which only can be used on non-authenticated subscriptions

Parameters

• subscriptions Array<types.webSocket.UnauthenticatedSubscription>

Returns void

request.FindMarkets

Type: Object

Properties

• market string Target market, all markets are returned if omitted
• regionOnly boolean? true only returns markets available in the geographic region of the request
• depositId string

webSocketResponse.Subscriptions

Subscriptions Response

Type: Object

Properties

• cid string?
• method string subscriptions
• subscriptions Array<Subscription>

RawResponseMessage

Response message without transformation to human readable form

Type: webSocketSubscriptionMessages.SubscriptionMessageShort

OrderBookPrice

OrderBookPrice

Type: string

OrderBookSize

OrderBookSize

Type: string

OrderBookNumOrders

OrderBookNumOrders

Type: string

autoDispatchEnabled

Currently has no effect

Type: boolean

Contracts

View the provided contract for a corresponding Solidity implementation of order signature verification.