Установка и использование платформы

REST API: информация об участниках сети

https://img.shields.io/badge/auth-required-orange.svg

Для получения информации об участниках сети предусмотрено три группы методов:

  • addresses - методы, предназначенные для получения информации об адресах участников сети;

  • alias - получение адреса участника по установленному для него псевдониму или псевдонима по адресу участника;

  • leasing - запрос GET /leasing/active/{address}, выводящий список транзакций лизинга, в которых адрес принимал участие как отправитель или получатель.

Группа addresses:

GET /addresses

Получение всех адресов участников, ключевые пары которых хранятся в keystore ноды.

Пример ответа:

GET /addresses/seq/{from}/{to}

Получение адресов участников, которые хранятся в keystore ноды в заданном диапазоне: от адреса {from} до адреса {to}.

Формат ответа метода идентичен формату GET /addresses.

GET /addresses/balance/{address}

Получение баланса для адреса {address}.

Пример ответа:

POST /addresses/balance/details

Получение подробной информации о балансе для списка адресов, который указывается в виде массива в поле addresses при запросе.

Параметры, возвращаемые в ответе метода:

  • regular — сумма токенов, принадлежащих непосредственно участнику (R);

  • available — общий баланс участника, за исключением средств, переданных участником в лизинг (A = R - L);

  • effective — общий баланс участника, включая средства, переданные участнику в лизинг, и за вычетом средств, которые участник сам передал в лизинг (E = R + F - L);

  • generating — генерирующий баланс участника, включая средства переденные в лизинг, за последние 1000 блоков.

Переменные в скобках: L - средства, переданные участником в лизинг другим участникам, F - средства, полученные участником в лизинг.

Пример ответа для одного адреса:

GET /addresses/balance/details/{address}

Получение подробной информации о балансе для отдельного адреса. Информация в ответе идентичина методу POST /addresses/balance/details.

Пример ответа:

GET /addresses/effectiveBalance/{address}

Получение общего баланса адреса, включая средства, переданные в лизинг.

Пример ответа:

GET /addresses/effectiveBalance/{address}/{confirmations}

Получение баланса для адреса {address} после количества подтверждений >= {confirmations}. Возвращается общий баланс участника, включая средства, переданные участнику в лизинг.

Пример ответа для количества подтверждений >= 1:

GET /addresses​/generatingBalance​/{address}​/at​/{height}

Получение генерирующего баланса адреса на указанной высоте блокчейна {height}.

Пример ответа:

GET /addresses/scriptInfo/{address}

Получение данных о скрипте, установленном на адресе.

Параметры, возвращаемые в ответе метода:

  • address - адрес в формате base58;

  • script - тело скрипта в формате base64;

  • scriptText - исходный код скрипта;

  • complexity - сложность скрипта;

  • extraFee - комиссия за исходящие транзакции, установленные скриптом.

Сложность скрипта - число от 1 до 100, отражающее количество вычислительных ресурсов, требуемое для исполнения скрипта.

Пример ответа:

GET /addresses/publicKey/{publicKey}

Метод возвращает адрес участника на основании его публичного ключа.

Пример ответа:

GET /addresses/data/{address}

Метод возвращает данные, записанные на указанном адресе при помощи транзакций 12.

Пример ответа:

GET /addresses/data/{address}/{key}

Метод возвращает данные, записанные на указанном адресе с ключом {key}. Этот ключ указывается в транзакции 12 в поле data.key.

Пример ответа:

Группа alias:

GET /alias/by-alias/{alias}

Получение адреса участника по его псевдониму {alias}.

Пример ответа:

GET /alias/by-address/{address}

Получение псевдонима участника по его адресу {address}.

Пример ответа:

Метод GET /leasing/active/{address}:

Метод возвращает список транзакций создания лизинга, в которых адрес принимал участие как отправитель или получатель.

Пример ответа с одной транзакцией: