3x-ui-panel-client

3X-UI client

init client

(async () => {
  const panelClient = new Client({
    username: process.env.PANEL_USER,
    password: process.env.PANEL_PASSWORD,
    host: process.env.PANEL_HOST,
    port: process.env.PANEL_PORT,
    scheme: process.env.PANEL_SCHEME, // http/https
  });

  // call login once before other calls
  await panelClient.login();
})();

list clients

const inbounds = await panelClient.getInbounds();
// find vless inbound
const inbound = inbounds.find((inbound) => inbound.protocol === "vless");
console.log(inbound.id);
const { clientStats, settings } = inbound;
clientStats.forEach((clientStat) =>
  console.log(
    clientStat.id,
    clientStat.enable,
    clientStat.email,
    (clientStat.up + clientStat.down) / 1024 / 1024 / 1024
  )
);
const settingsObj = JSON.parse(settings);
console.log(settingsObj.clients);

create clients

const inboundId = 1;

await panelClient.addClient({
  inboundId,
  email: "test1",
  totalGB: 0, // no traffic limit
});
await panelClient.addClient({
  inboundId,
  email: "test2",
  totalGB: 107374182400, // 100Gb traffic limit
});

delete client

const client = settingsObj.clients.find((client) => client.email === "test1");
await panelClient.delClient({ inboundId, clientId: client.id });

update client (enable, disable, update totalGB)

const client = settingsObj.clients.find((client) => client.email === "test1");
await panelClient.updateClient({
  inboundId,
  clientSettings: {
    ...client,
    enable: false,
    // totalGB: 0,
  },
});

reset client traffic

const client = settingsObj.clients.find((client) => client.email === "test1");
await panelClient.resetClientTraffic({ inboundId, email: client.email });