Class RestPublicClient

The RestPublicClient is used to make public requests to the IDEX API. It does not require any special options to access.

• An apiKey can be provided to increase rate limits.
• Optionally, a sandbox option can be set to true in order to point to the IDEX Sandbox API.

Example

import { RestPublicClient } from '@idexio/idex-sdk';

// works without any options
// const publicClient = new RestPublicClient();

const publicClient = new RestPublicClient({
  sandbox: true,
  // Optionally provide an API key to increase rate limits
  apiKey: '1f7c4f52-4af7-4e1b-aa94-94fac8d931aa',
});

const tickers = await publicClient.getTickers('ETH-USD');
console.log('Tickers: ', tickers);
Copy

See

• typedoc Reference Documentation
• options RestPublicClientOptions

Returns basic information about the exchange.

• Some of the returned parmeters can be used to configure contract calls required for other methods.

Endpoint Parameters

• HTTP Request: GET /v4/exchange
• Endpoint Security: Public
• API Key Scope: None

See

• typedoc Reference Documentation
• response RestResponseGetExchange

Returns estimated gas fees by bridge and target chain

Endpoint Parameters

• HTTP Request: GET /v4/gasFees
• Endpoint Security: Public
• API Key Scope: None

See

• typedoc Reference Documentation
• response RestResponseGetGasFees
• type IDEXGasFees

Returns information about the currently listed markets

• Optionally filter for a specific market by providing a market request parameter.

Endpoint Parameters

• HTTP Request: GET /v4/markets
• Endpoint Security: Public
• API Key Scope: None

See

• typedoc Reference Documentation
• request RestRequestGetMarkets
• response RestResponseGetMarkets
• type IDEXMarket

Returns market statistics for the trailing 24-hour period

• TIP: Automatic ticker updates are avilable via the WebSocket API tickers subscription, which is both faster and more efficient than polling this endpoint!

Endpoint Parameters

• HTTP Request: GET /v4/tickers
• Endpoint Security: Public
• API Key Scope: None

See

• typedoc Reference Documentation
• request RestRequestGetTickers
• response RestResponseGetTickers
• type IDEXTicker

Returns candle (OHLCV) data for a market

• For autocompletion and inline documentation, use the CandleInterval enum when specifying the interval property (see example)
• TIP: Automatic candle updates are avilable via the WebSocket API candles subscription, which is both faster and more efficient than polling this endpoint!

Endpoint Parameters

• HTTP Request: GET /v4/candles
• Endpoint Security: Public
• API Key Scope: None
• Pagination: start, end, limit

Example

import { RestPublicClient, CandleInterval } from '@idexio/idex-sdk';

const client = new RestPublicClient();

const candles = await client.getCandles({
 market: 'ETH-USD',
 interval: CandleInterval.ONE_MINUTE
})
Copy

See

• typedoc Reference Documentation
• request RestRequestGetCandles
• response RestResponseGetCandles
• type IDEXCandle

Returns trade data for a market. In this documentation, "trades" refers to public information about trades, whereas "fills" refers to detailed non-public information about trades resulting from orders placed by the API account.

• TIP: Automatic trades updates are available via the WebSocket API trades subscription, which is both faster and more efficient than polling this endpoint!
• TIP: There is also a call on the authenticated client RestAuthenticatedClient.getFills which includes the IDEXFill properties, if required.

Endpoint Parameters

• HTTP Request: GET /v4/trades
• Endpoint Security: Public
• API Key Scope: None
• Pagination: start, end, limit, fromId

See

• typedoc Reference Documentation
• request RestRequestGetTrades
• response RestResponseGetTrades
• type IDEXTrade
• related RestAuthenticatedClient.getFills

Returns a level-1 order book of a market.

Endpoint Parameters

• HTTP Request: GET /v4/orderbook
• Endpoint Security: Public
• API Key Scope: None
• Pagination: limit,

See

• typedoc Reference Documentation
• request RestRequestGetOrderBookLevel1
• response RestResponseGetOrderBookLevel1
• related client.getOrderBookLevel2

Get current order book price levels for a market

Endpoint Parameters

• HTTP Request: GET /v4/orderbook
• Endpoint Security: Public
• API Key Scope: None
• Pagination: limit,

See

• typedoc Reference Documentation
• request RestRequestGetOrderBookLevel2
• response RestResponseGetOrderBookLevel2
• related client.getOrderBookLevel1

Get liquidations for a market

Endpoint Parameters

• HTTP Request: GET /v4/liquidations
• Endpoint Security: Public
• API Key Scope: None
• Pagination: start, end, limit, fromId

See

• typedoc Reference Documentation
• request RestRequestGetLiquidations
• response RestResponseGetLiquidations
• type IDEXLiquidation

Get Funding Rates

Endpoint Parameters

• HTTP Request: GET /v4/fundingRates
• Endpoint Security: Public
• API Key Scope: None
• Pagination: start, end, limit

See

• typedoc Reference Documentation
• request RestRequestGetFundingRates
• response RestResponseGetFundingRates
• type IDEXFundingRate

Tests connectivity to the REST API

Endpoint Parameters

• HTTP Request: GET /v4/ping
• Endpoint Security: Public
• API Key Scope: None

See

• typedoc Reference Documentation
• response RestResponseGetPing

Returns the current server time

Endpoint Parameters

• HTTP Request: GET /v4/time
• Endpoint Security: Public
• API Key Scope: None

See

• typedoc Reference Documentation
• response RestResponseGetTime