@idexio/idex-sdk

IDEX SDK for Javascript in the browser and Node.js

Usage no npm install needed!

<script type="module">
  import idexioIdexSdk from 'https://cdn.skypack.dev/@idexio/idex-sdk';
</script>

README

JavaScript SDK

Discord GitHub npm GitHub issues

The official library for IDEX v3's REST and WebSocket APIs.

Written in TypeScript with full typings for all requests and responses
Supports both Node.js and browser environments
Implements a real time order book including support for hybrid liquidity

Complete documentation for the IDEX v3 API is available at https://api-docs-v3.idex.io.

Installation

yarn add @idexio/idex-sdk@beta
// or
npm install --save @idexio/idex-sdk@beta

Getting Started

Get IDEX v3 sandbox API keys.

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

const publicClient = new idex.RestPublicClient({
  sandbox: true,
});
console.log(await publicClient.getServerTime());

In-depth usage documentation by endpoint is available here.

Contract ABIs

Included in the contracts/ directory contains the ABIs necessary for interacting with IDEX v3's smart contracts.

The Exchange ABI can be used to query contract state, deposit funds, add liquidity, remove liquidity or exit wallets.
The FaucetToken ABI is implemented by the API sandbox testnet tokens and features a faucet function for dispensing tokens.

License

The IDEX JavaScript SDK is released under the MIT License.