xt-open-api

XT Open API JavaScript SDK

Introduction

The XT Open API JavaScript SDK provides access to various endpoints for interacting with the XT platform. This SDK includes modules for user management, spot trading, leveraged trading, and futures trading. Additionally, it offers WebSocket connections for real-time data updates.

Installation

To use the XT Open API JavaScript SDK, follow these steps:

1. Create accessKey and secretKey on xt.com / Account Center / API Management
2. Create a .config.json file in your project's root directory.
3. Add your access key and secret key to the .config.json file as follows.

{
  "accessKey": "YOUR_ACCESS_KEY",
  "secretKey": "YOUR_SECRET_KEY"
}

Usage demonstration

For specific interface parameter usage, please refer to https://doc.xt.com/

You can refer to the test cases in the tests directory in this package

const xt = require("xt-open-api");

// The contents of the sdk export object
console.log(xt);

// Show api list and its parameters
xt.showApis();

// Example usage:
xt.user.getAccounts().then(r => console.log(r.result));

const orderParameters = {
  clientOrderId: "bot_no_1",
  symbol: "xt_usdt",
  side: "BUY",
  type: "LIMIT",
  timeInForce: "GTC",
  bizType: "SPOT",
  price: 999,
  quantity: 0.01
};
xt.spot.createOrder(orderParameters).then(r => console.log(r.result));

xt.spotWss.subscribe(["ticker@btc_usdt"], (...args) => {
  console.log(...args);
  xt.spotWss.unsubscribe({ id: args[0] });
});

/**
 * xt.spotWss and xt.futureWss are used to obtain data 
 * through sockets. They each export subscribe, 
 * unsubscribe, subscribePrivate, and unsubscribePrivate,
 * which are used to subscribe/unsubscribe public 
 * information and personal information respectively.
 */