1.0.1 • Published 5 months ago

mix-api v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

MixAPI

MixAPI — это библиотека для Node.js, которая позволяет удобно работать с API сервиса Mix. Она предоставляет методы для получения баланса, перевода средств и просмотра истории транзакций.

Установка

Установите библиотеку с помощью npm:

npm install mix-api

Пример использования

const MixAPI = require('mix-api');

(async () => {
    const token = "your_api_token_here";
    const userId = 12345;
    const api = new MixAPI(token);

    try {
        // Получить баланс пользователя
        const balance = await api.getBalance(userId);
        console.log("Баланс:", balance);

        // Перевести средства другому пользователю
        const transferResult = await api.transfer(67890, 100);
        console.log("Результат перевода:", transferResult);

        // Получить историю транзакций
        const transactions = await api.getTransactions(1);
        console.log("История транзакций:", transactions);
    } catch (error) {
        console.error("Ошибка:", error.message);
    }
})();

Методы

getBalance(userId)

Получает баланс указанного пользователя.

Аргументы:

  • userId (number): ID пользователя, чей баланс нужно получить.

Возвращает:

  • Промис, который разрешается в объект с информацией о балансе.

transfer(toId, amount)

Переводит MIX средства другому пользователю.

Аргументы:

  • toId (number): ID получателя.
  • amount (number): Количество MIX для перевода.

Возвращает:

  • Промис, который разрешается в объект с результатом операции.

getTransactions(type)

Получает историю транзакций.

Аргументы:

  • type (number, optional): Тип транзакций. Возможные значения:
    • 1: Входящие транзакции (по умолчанию).
    • 2: Исходящие транзакции.

Возвращает:

  • Промис, который разрешается в объект со списком транзакций.

Примечания

  • Убедитесь, что вы используете валидный token для взаимодействия с API.
  • Для работы требуется библиотека axios. Она автоматически устанавливается с mix-api.
1.0.1

5 months ago