Nxt API

From Nxt Wiki
Jump to: navigation, search
This page is a translated version of the page Nxt API and the translation is 70% complete.

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎español • ‎français • ‎italiano • ‎português do Brasil • ‎русский • ‎українська • ‎中文(简体)‎

1 Описание

API Nxt позволяет взаимодействовать с узлами Nxt, используя HTTP запросы к порту 7876. Большинство запросов HTTP может использовать методы GET или POST, но некоторые вызовы API принимают только метод POST из соображений безопасности. Результат выполнения запроса (ответ) возвращается как объект JSON.

Каждый вызов API описан ниже, с описанием передаваемых параметров HTTP запроса и полей JSON ответа, сопровождаемых примером:

  • Каждое поле JSON ответа помечается одним из символов S для строк, A для массива, O для объекта, N для числа или B для булевой (логической) переменной.
  • В примерах, узел Nxt представлен как localhost и запросы, и ответы отформатированы для легкого восприятия; разрывы строки и пробелы фактически не используются кроме некоторых значений параметров. Все запросы приводятся в URL формате, который подразумевает использование HTTP GET метода. Когда используется метод GET, URL может быть введен в поле URL браузера, но требуется специальное кодирование URL (например, пробелы в значении параметра должны быть заменены на + или %20). Иначе, URL должен использоваться в качестве подготовки запроса POST HTTP используя например cURL.

Все вызовы API могут быть предварительно просмотрены и протестированы по ссылке http://localhost:7876/test, при условии что узел локального сервера работает. Для специфических вызовов API используйте ссылку http://localhost:7876/test?requestType=specificRequestType.

Этот документ актуален для Nxt Software Version 1.4.8, с работающей с блока 330.000 Monetary System

2 Содержание

Contents

3 Общие примечания

3.1 Генезисный блок

Многие API запросы ссылаются на Генезисный Блок. К вашему сведению, ID Генезисного Блока является 2680262203532249785. Отправка сообщений, продажа псевдонимов и передача в аренду баланса Генезисному Аккаунту больше не допускается, начиная с блока Monetary System.

3.2 Гибкие идентификаторы учетных записей

Все запросы API, которые требуют идентификатор аккаунта, принимают или номер аккаунта или соответствующий Reed-Solomon адрес.

3.3 Количественные Единицы измерения NXT, NQT и QNT

Система Nxt использует валюту NXT для указания количественных значений в системе. Как все валюты, NXT циркулирует в системе, двигаясь от одного пользователя к другому через платежи и покупки. Кроме того, небольшая комиссия взимается за каждую транзакцию, в том числе такие, в которых не передаются сами NXT, например при передаче простых сообщений. Эта комиссия идет владельцу узла, который форжит (генерирует) новый блок, содержащий транзакцию, которая принимается в blockchain.

Один миллиард NXT был создан в Генезисном блоке, и больше никогда новые NXT не будут создаваться. По состоянию на блок 134000, NXT стал представляться с восемью знаками после запятой. Тем не менее, внутри системы валюта по-прежнему сохраняется в целочисленной форме, в единицах NQT или NxtQuant, где 1 NXT=108 NQT. Все параметры и поля в API связанные с количественным исчислением NXT выражены в единицах NQT, например, feeNQT . Единственным исключением является поле effectiveBalanceNXT, которое используется в расчете форжинга.

Система Nxt может считаться активом, принадлежащая всем кто владеет NXT. В этом смысле NXT определяет количество владения этого актива или доли в системе. Совладельцы этого актива (или Stakeholder-ы, или держатели NXT) имеют возможность форжить блоки и получать комиссию за обработку транзакций, пропорционально сумме NXT которой они обладают.

Другие активы могут быть созданы внутри NXT с помощью Выпуск Актива. Эмитент должен указать количество знаков после запятой для использования в указании количества актива, а стоимость актива указать в универсальных единицах QNT или Quant, отличных от NQT. Количество актива хранятся в виде целых чисел в единицах QNT, а оцениваются активы в NQT за QNT.

Например, актив mgwBTC (мультишлюз Bitcoin) делится на восемь знаков после запятой, как в оригинальном Bitcoin (BTC). Поэтому QNT из mgwBTC эквивалентно Satoshi (10 -8 BTC). Чтобы разместить ордер на продажу 25000000 QNT актива mgwBTC по цене 20000 NQT за QNT, используйте API вызов Разместить заказ с requestType=placeAskOrder, quantityQNT = 25000000 и priceNQT = 20000. Если весь объем актива будет продан на бирже, продавец получит 500000000000 NQT (quantityQNT * priceNQT) от покупателя(ей). Эта сделка соответствует продажи 0,25 mgwBTC за 5000 NXT, при торговле с использованием биржи активов в NRS клиенте. В этом случае, цена 20 000 в NQT за QNT, соответствует цене в NXT за mgwBTC, так как mgwBTC и NXT делятся на восемь знаков после запятой.

Валюты в Nxt Monetary System представляют собой особый вид активов со свойствами и методами обмена, свойственных для валюты. Что касается количества, курсов обмена и знаков после запятой, Monetary System API используют NXT, NQT и QNT точно так же, как и активы.

3.4 Создание не подписанных транзакций

Все API запросы которые создают новую транзакцию могут принимать параметр secretPhrase или publicKey:

  • Если доступен параметр secretPhrase, транзакция будет создана, подписана на сервере, и передана серверу как обычно.
  • Если доступен только параметр publicKey как 64-значная (32-байта) hex строка, транзакция будет подготовлена на сервере и возвращена в JSON ответе как unsignedtransactionBytes (неподписанные байты транзакции). Эта hex строка вместе с secretPhrase может передаваться для Подписывания Транзакции и полученные в результате подписанные transactionBytes могут быть переданы для Публикации Транзакции.

3.5 Операции условного депонирования

Все запросы API, которые создают новую транзакцию могут принимать необязательный параметр referencedTransactionFullHash, который создает связанные транзакции, это означает, что новая транзакция не может быть подтверждена, если связанная транзакция не подтверждена. Эта функция позволяет реализовать простой способ условного депонирования транзакции:

  • Алиса подготавливает и подписывает транзакцию A, но не передает её, установив параметр broadcast в false. Она посылает Бобу unsignedTransactionBytes , fullHash транзакции, и signatureHash. Все те, которые включены в JSON, возвращаемого API запроса. (Внимание: убедитесь, что вы сами не отправляете подписанные transactionBytes или signature ,иначе Боб будет иметь возможность самостоятельно опубликовать транзакцию).
  • Боб подготавливает, подписывает и публикует транзакцию B, установив параметр referencedTransactionFullHash в fullHash переданные ему Элис. Он может проверить, что этот хэш действительно относится к транзакции которую он ожидает от Алисы, с помощью функции Рассчитать Полный Хэш, которая принимает параметры unsignedTransactionBytes и signatureHash (эти оба параметра Алиса также отправляла Бобу). Он может также использовать функцию Парсинг транзакции, чтобы декодировать байты без подписи и просмотреть все поля транзакции.
  • Транзакция B принимается в пул неподтвержденных транзакций, и пока там отсутствует A, B не будет подтверждена, то есть не будут включена в blockchain. Если A никогда не будет подписана, срок ожидания B в конечном счете истечет - Боб должен убедиться, что установил достаточно длинный срок дедлайна транзакции, например, максимальный срок 1440 минут.
  • После того, как В попала в пул неподтвержденных транзакций, Боб не имеет возможности отменить/вернуть эту транзакцию. Так что теперь Алиса может безопасно подписать свою транзакцию A, просто опубликовав signedTransactionBytes которые она получила на первом этапе. Транзакция A будет включена в blockchain первой, и в следующем блоке также будут включена транзакция B Боба.

Обратите внимание, что в то время как эта схема является достаточно хорошим решение для реализации условного депонирования, blockchain не гарантирует, что если транзакция А включена в blockchain, то и транзакция B также будут включена. Это может произойти из-за вилки или реорганизации blockchain, что в итоге может привести к тому что транзакция B никогда не получит шанс быть включенной в blockchain и истечет срок её подтверждения, в то время как транзакция A будет находиться в blockchain. Тем не менее, практически не возможно, чтобы Боб преднамеренно вызвал такую цепь событий, которая бы привела к отмене подтверждения транзакции B.

3.6 Prunable Data

Функционал Pruning (удаляемые) данных реализован для тестирования в версии version 1.5.1e (использовался только в Testnet сети), в основной сети функционал доступен с блока 445.000 и версии version 1.5.10.

Prunable данные могут быть удалены из blockchain, при этом не влияя на целостность blockchain. Когда создается транзакция содержащая prunable данные, только 32 байта хеш-а sha256 prunable данных будут включены в transactionBytes, а не сами prunable данные. Не prunable подписанные transactionBytes используются, чтобы проверить подпись и сгенерировать fullHash и ID транзакции; когда prunable часть транзакции будет удалена в будущем, ни одна из этих операций не будет затронута.

У Prunable данных есть предопределенное минимальное время жизни, которое составляет две недели (24 часа в сети Testnet) от момента времени создания транзакции. Транзакции и блоки, полученные от узлов сети, не принимаются, если prunable данные в них отсутствуют, прежде чем время жизни данных завершилось. После того, как это время завершается, prunable данные больше не включаются в транзакции и не включаются в блоки обмена данными между узлами,а также больше не включаются в JSON транзакции, возвращаемый вызовами API общего назначения, такими как Get Transaction; единственный способ получить эти данные, если они еще доступны, это вызов API специального назначения, такого как Get Prunable Message.

Prunable данные с истекшим сроком продолжают храниться в blockchain, пока не будут удалены в процессе обрезания таблиц, который происходит автоматически каждые 1000 блоков (по умолчанию). Используйте Trim Derived Tables, чтобы сразу удалить истекшие prunable данные.

Prunable данные могут храниться на узле и больше минимального времени жизни, для этого установите параметру nxt.maxPrunableLifetime большее значение чем две недели или в -1 для того чтобы хранить постоянно. Чтобы заставить узел включать такие сохраненные prunable данные, когда транзакции и блоки будут передаваться при взаимодействии с узлами, установите параметр nxt.includeExpiredPrunables в false, таким образом делая его архивным узлом.

В настоящее время в системе Nxt есть два типа prunable данных: prunable [[[Nxt_API#Arbitrary_Message_System_Operations|Arbitrary Messages]] и [[[Nxt_API#Tagged_Data_Operations|Tagged Data]]. В обоих случаях максимальная длина prunable данных составляет 42 килобайта.

3.7 Properties Files

The behavior of some API calls is affected by property settings loaded from files in the nxt/conf directory during Nxt server intialization. This directory contains the nxt-default.properties and logging-default.properties files, both of which contain default property settings along with documentation. A few of the property settings can be obtained while the server is running through the Get Blockchain Status and Get State calls.

Рекомендуется не изменить вышеуказанные файлы свойств по умолчанию, потому что они могут быть перезаписаны во время обновлений программного обеспечения. Вместо этого свойства по умолчанию заданные в файлах, могут быть переопределены включением их в дополнительных файлах nxt.properties и logging.properties в том же каталоге. Например, nxt.properties файл может быть создан с содержанием:

nxt.isTestnet=true

В этом примере, настройки заставят сервер Nxt соединяться с Testnet вместо основной сети.

4 Создание Транзакции

Следующие API вызовы создают NXT транзакции с использованием HTTP POST запросов. Последующие ссылки на примеры и параметры запросов HTTP POST, характерны для каждого вызова. Обратитесь к разделам ниже параметры запроса HTTP POST и поля JSON ответа, общие для всех вызовов, которые создают транзакции.

4.1 Создание запроса Транзакции

Следующие параметры HTTP POST являются общими для всех вызовов API создающих транзакции:

  • secretPhrase это секретная фраза вашего аккаунта (опционально, но если не задавать - транзакция не будет подписана и не будет опубликована)
  • publicKey это публичный ключ вашего аккаунта (опционально, если secretPhrase предусматривается)
  • feeNQT это комиссия (в NQT, минимум 100000000000 для issueAsset, 100000000 остальных) за транзакцию
  • deadline это время дедлайна (в минутах) в течении которого транзакция должна быть подтверждена
  • referencedTransactionFullHash при создании связанных транзакций, это означает, что текущая транзакция не может быть подтверждена, если зависимая транзакция не подтверждена (опционально)
  • broadcast если установить в false публикация транзакции в сеть произведена не будет (опционально)

Примечание: Опционально, произвольное сообщение может быть присоединено к любой транзакции, путем добавления сообщения-параметра аналогично как это делается при Отправке Сообщений.

4.2 Результаты выполнения запросов

Следующие поля ответа JSON, являются общими для всех вызовов API, которые создают транзакции:

  • signatureHash (S) SHA-256 хэш подписи транзакции
  • unsignedTransactionBytes (S) байты транзакции без подписи
  • transactionJSON (O) объект с писанием транзакции (подробнее смотри в разделе Получить транзакцию)
  • broadcasted (B) может принимать значение true, если транзакция была опубликована, false в противном случае
  • requestProcessingTime (N) время обработки запроса API (в мсек)
  • transactionBytes (S) подписанные байты транзакции
  • fullHash (S) полным хеш подписанной транзакции
  • transaction (S) ID (идентификатор) вновь созданной транзакции

5 Операции с Аккаунтами

5.1 Get Account

Получить информацию аккаунта с заданным ID.

Запрос:

  • requestType - getAccount
  • account это ID аккаунта
  • includeLessors установите false чтобы ответ не включал lessors и lessorsRS (опционально)
  • includeAssets установите false чтобы ответ не включал assetBalances и unconfirmedAssetBalances (опционально)
  • includeCurrencies установите false чтобы ответ не включал accountCurrencies (опционально)

Ответ:

  • unconfirmedBalanceNQT (S) это balanceNQT без неподтвержденных исходящих транзакций, этот баланс отображается в клиенте
  • effectiveBalanceNXT (N) это баланс аккаунта (в NXT) который может принимать участие в форжиге: состоит из не сданного в аренду guaranteedBalance этого аккаунта плюс полученный в аренду guaranteedBalance всех арендодателей этого аккаунта
  • lessors (A) массив из ID аккаунтов арендодателей
  • currentLessee (S) номер аккаунта арендатора, если применимо
  • currentLeasingHeightTo (N) высота блока при котором аренда будет завершена, если применимо
  • forgedBalanceNQT (S) баланс аккаунта (в NQT) который был сфоржен
  • balanceNQT (S) базовый баланс аккаунта (в NQT) который имеет хотя бы 1 подтверждение.
  • publicKey (S) публичный ключ аккаунта
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • assetBalances (A) массив объектов актива включающий поля данных balanceQNT (S) и asset (S) ID
  • guaranteedBalanceNQT (S) баланс аккаунта (в NQT) имеющий более 1440 подтверждений
  • unconfirmedAssetBalances (A) массив объектов актива включающий поля данных unconfirmedBalanceQNT (S) и asset (S) ID
  • currentLesseeRS (S) адрес аккаунта арендатора в формате Reed-Solomon
  • accountRS (S) адрес аккаунта в формате Reed-Solomon
  • lessorsRS (A) массив адресов аккаунтов арендодателей в формате Reed-Solomon
  • accountCurrencies (A) массив объектов валют (подробнее смотри в разделе Get Account Currencies)
  • name (S) имя/название ассоциированное с аккаунтом, если применимо
  • description (S) описание аккаунта, если применимо
  • account (S) номер аккаунта
  • currentLeasingHeightFrom (N) высота блока, с которого началась аренда, если применимо

5.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccount&
    account=NXT-4VNQ-RWZC-4WWQ-GVM8S

Ответ:

{
    "unconfirmedBalanceNQT": "2501162882344",
    "effectiveBalanceNXT": 13983,
    "currentLessee": "7114946486381367146",
    "currentLeasingHeightTo": 281179,
    "forgedBalanceNQT": "0",
    "balanceNQT": "2501162882344",
    "publicKey": "73080c6a224062660184f10ebb7fb431d4593...",
    "requestProcessingTime": 2,
    "assetBalances": [
        {
            "balanceQNT": "96651298",
            "asset": "4551058913252105307"
        }
    ],
    "guaranteedBalanceNQT": "1398383666344",
    "unconfirmedAssetBalances": [
        {
            "unconfirmedBalanceQNT": "96651298",
            "asset": "4551058913252105307"
        }
    ],
    "currentLesseeRS": "NXT-TMVC-69YC-SJB4-8YCH7",
    "accountRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
    "name": "mystical",
    "account": "17013046603665206934",
    "currentLeasingHeightFrom": 279739
}

Verified 13-Dec-14

5.2 Get Account Block Count

Возвращает количество блоков сфорженых аккаунтом.

Запрос:

  • requestType это getAccountBlockCount
  • account это идентификатор аккаунта (ID)

Ответ:

  • numberOfBlocks (N) количество блоков сфорженых аккаунтом
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountBlockCount&
    account=7114946486381367146

Ответ:

{
    "numberOfBlocks": 460,
    "requestProcessingTime": 70
}

Verified 13-Dec-14

5.3 Get Account Block IDs

Возвращает ID (идентификаторы) всех блоков, сфорженых (сгенерированных) указанным аккаунтом, в порядке обратном высоте блока.

Запрос:

  • requestType это getAccountBlockIds
  • account ID аккаунта
  • timestamp метка времени (в секундах от времени создания генезисного блока) начиная с которой будут получаться блоки (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого значения ID блока (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения ID блока (опционально)

Ответ:

  • blockIds (A) массив ID (идентификаторов) блоков
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountBlockIds&
    account=7114946486381367146&
    lastIndex=5

Ответ:

{
    "blockIds": [
        "6021945980475236545",
        "11040962152457477526",
        "1157648883168692101",
        "9322994768555364845",
        "12862636636638339558",
        "11535040705139271493"
    ],
    "requestProcessingTime": 3
}

Verified 13-Dec-14

5.4 Get Account Blocks

Возвращает все блоки сфорженные (сгенерированные) аккаунтом, в порядке обратном высоте блока.

Запрос:

  • requestType это getAccountBlocks
  • account ID аккаунта
  • timestamp метка времени (в секундах от времени создания генезисного блока) начиная с которой будут получаться блоки (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого значения ID блока (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения ID блока (опционально)
  • includeTransactions устанавливается в true чтобы получить подробную информацию о транзакции, в противном случае будут получены только ID транзакций (опционально)

Ответ:

  • blocks (A) массив из блоков (подробнее смотри в разделе Get Block)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountBlockIds&
    account=7114946486381367146&
    lastIndex=0

Ответ:

{
    "blocks": [
        {
            "previousBlockHash": "bd8948556e968f1d532cd286a5dd8fde0159d7950467f1ed8fbf26a31d663e99",
            "payloadLength": 386,
            "totalAmountNQT": "0",
            "generationSignature": "74138446cacdb30075492670f7e24fb839434818cb877bba174e37361fc899a1",
            "generator": "7114946486381367146",
            "generatorPublicKey": "dbc809e8237914f25add0d349ea16b2ac05cae6882d0a1782d23605af264d97a",
            "baseTarget": "325377698",
            "payloadHash": "32df67383f63b74f1331bbdb6f1be424c87a1e6423fc7091d81683481eb6c4ca",
            "generatorRS": "NXT-TMVC-69YC-SJB4-8YCH7",
            "nextBlock": "3553212706398858282",
            "numberOfTransactions": 2,
            "blockSignature": "d30e3f95d547fa922feb31303f877a345d0ad8c232778a4507adf9082b5df3...",
            "transactions": [
                "1199750337785535382",
                "8975701802988160413"
            ],
            "version": 3,
            "totalFeeNQT": "200000000",
            "previousBlock": "2130086549390920125",
            "block": "6021945980475236545",
            "height": 278953,
            "timestamp": 30130340
        }
    ],
    "requestProcessingTime": 3
}

Verified 13-Dec-14

5.5 Get Account ID

Возвращает ID аккаунта, по заданной секретной фразе или открытому ключу. Только POST.

Запрос:

  • requestType это getAccountId
  • secretPhrase секретная фраза аккаунта (опционально)
  • publicKey публичный ключ аккаунта (опционально если secretPhrase задана)

Ответ:

  • accountRS (S) адрес аккаунта в формате Reed-Solomon
  • publicKey (S) публичный ключ аккаунта
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • account (S) номер аккаунта

5.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountId&
    secretPhrase=IWontTellYou

Ответ:

{
    "accountRS": "NXT-L6FM-89WK-VK8P-FCRBB",
    "publicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
    "requestProcessingTime": 2,
    "account": "15323192282528158131"
}

Verified 13-Dec-14

5.6 Get Account Lessors

Возвращает информацию о арендодателях аккаунта

Запрос:

  • requestType это getAccountLessors
  • account ID аккаунта
  • height высота блокчейна на момент завершения аренды (опционально, по умолчанию это последний блок)

Примечание: Если тримминг (обрезание) таблиц включен (по умолчанию), то height должна быть в пределах 1440 блоков от последнего блока.

Ответ:

  • accountRS (S) адрес аккаунта в формате Reed-Solomon
  • account (S) номер аккаунта
  • height (N) высота blockchain
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • lessors (A) массив из объектов арендодателей содержащий поля lessorRS (S), lessor (S) и guaranteedBalanceNQT (S)

5.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountLessors&
    account=7114946486381367146&
    height=282497

Ответ:

{
    "lessors": [
        {
            "guaranteedBalanceNQT": "2643314085738687",
            "lessorRS": "NXT-MRBN-8DFH-PFMK-A4DBM",
            "lessor": "9918441724915080500"
        }
    ],
    "accountRS": "NXT-TMVC-69YC-SJB4-8YCH7",
    "requestProcessingTime": 1,
    "account": "7114946486381367146",
    "height": 282497
}

Verified 13-Dec-14

5.7 Get Account Public Key

Возвращает публичный код ассоциированный с заданным ID аккаунта.

Запрос:

  • requestType это getAccountPublicKey
  • account ID аккаунта

Ответ:

  • publicKey (S) 32-байтный публичный ключ ассоциированный с заданным аккаунтом, в виде hex строки
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.7.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountPublicKey&
    account=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "publicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d...",
    "requestProcessingTime": 36
}

Verified 13-Dec-14

5.8 Get Account Transaction IDs

Возвращает ID (идентификаторы) транзакций ассоциированных с заданным аккаунтом в порядке обратном метки времени блоков.

Запрос:

  • requestType это getAccountTransactionIds
  • account ID аккаунта
  • timestamp метка времени (в секундах от времени создания генезисного блока) начиная с которой будут получаться блоки (опционально)
  • type тип возвращаемых транзакций (опционально)
  • subtype подтип возвращаемых транзакций (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого значения ID блока (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения ID блока (опционально)
  • numberOfConfirmations необходимое количество подтверждений для транзакций (опционально)

Примечание: См. Get Constants - описание типов и подтипов

Ответ:

  • transactionIds (A) массив из идентификаторов транзакций
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.8.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountTransactionIds&
    account=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "transactionIds": [
        "15200507403046301754",
        "10900022216391397990"
    ],
    "requestProcessingTime": 1
}

Verified 13-Dec-14

5.9 Get Account Transaction IDs

Возвращает транзакции ассоциированные с заданным аккаунтом в порядке обратном метки времени блоков.

Запрос:

  • requestType это getAccountTransactions
  • account ID аккаунта
  • timestamp метка времени (в секундах от времени создания генезисного блока) начиная с которой будут получаться блоки (опционально)
  • type тип возвращаемых транзакций (опционально)
  • subtype подтип возвращаемых транзакций (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого значения ID блока (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения ID блока (опционально)
  • numberOfConfirmations необходимое количество подтверждений для транзакций (опционально)

Примечание: См. Get Constants - описание типов и подтипов

Ответ:

  • transactions (A) массив из транзакций (подробности см. в разделе Get Transaction)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.9.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountTransactions&
    account=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
"requestProcessingTime": 1,
"transactions": [
    {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "5f0378b7390ff5a815eadd1354de533eef682f139362b153576e2207320a6...",
        "feeNQT": "100000000",
        "type": 0,
        "confirmations": 1704,
        "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
        "version": 1,
        "ecBlockId": "17321329645912574173",
        "signatureHash": "b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7",
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 0,
        "amountNQT": "100000000",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
        "recipient": "17013046603665206934",
        "ecBlockHeight": 275727,
        "block": "8455642159445842600",
        "blockTimestamp": 29797208,
        "deadline": 60,
        "transaction": "15200507403046301754",
        "timestamp": 29796934,
        "height": 275730
    },
    {
        "senderPublicKey": "73080c6a224062660184f10ebb7fb431d459364a12403320c7f601f9d75cc547",
        "signature": "7f4a5b70e3f91dd1e7a089c7985bb08f7035666dbfe3e857e706f08ad93f6...",
        "feeNQT": "100000000",
        "type": 0,
        "confirmations": 1706,
        "fullHash": "6612e07b74a84497b02d5bafea020391dcefadc157dc1cbd56611c66dc11f974",
        "version": 1,
        "ecBlockId": "4218793004869721496",
        "signatureHash": "0fc3d917e37111752004ac13a280ea121799388ff7aaf611f22f3ce93f1df5e0",
        "attachment": {
            "version.PublicKeyAnnouncement": 1,
            "recipientPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c"
        },
        "senderRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
        "subtype": 0,
        "amountNQT": "200000000",
        "sender": "17013046603665206934",
        "recipientRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "recipient": "15323192282528158131",
        "ecBlockHeight": 275723,
        "block": "14241452309033661857",
        "blockTimestamp": 29796841,
        "deadline": 60,
        "transaction": "10900022216391397990",
        "timestamp": 29796542,
        "height": 275728
    }
]
}

Verified 13-Dec-14

5.10 Get Balance

Возвращает баланс аккаунта

Запрос:

  • requestType это getBalance
  • account ID аккаунта

Ответ:

  • unconfirmedBalanceNQT (S) это balanceNQT без неподтвержденных исходящих транзакций, этот баланс отображается в клиенте
  • guaranteedBalanceNQT (S) баланс аккаунта (в NQT) имеющий более 1440 подтверждений
  • effectiveBalanceNXT (N) это баланс аккаунта (в NXT) который может принимать участие в форжиге: состоит из не сданного в аренду guaranteedBalance этого аккаунта плюс полученный в аренду guaranteedBalance всех арендодателей этого аккаунта
  • forgedBalanceNQT (S) баланс аккаунта (в NQT) который был сфоржен
  • balanceNQT (S) базовый баланс аккаунта (в NQT) который имеет хотя бы 1 подтверждение.
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.10.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getBalance&
    account=7114946486381367146

Ответ:

{
    "unconfirmedBalanceNQT": "9246231058415",
    "guaranteedBalanceNQT": "9242231058415",
    "effectiveBalanceNXT": 92422,
    "forgedBalanceNQT": "260560000000",
    "balanceNQT": "9246231058415",
    "requestProcessingTime": 1
}

Verified 13-Dec-14

5.11 Get Blockchain Transactions

Возвращает транзакции связанные с аккаунтом, в порядке обратном метки времени блоков.


Запрос:

  • requestType это getAccountTransactions
  • account ID аккаунта
  • timestamp самый ранний блок (в секундах начиная с блока происхождения), который будет получен (опционально)
  • type тип получаемых транзакций (опционально)
  • subtype субтип получаемых транзакций (опционально)
  • firstIndex индекс (начиная с 0) первой возвращаемой транзакции (опционально)
  • lastIndex индекс (начиная с 0) последней возвращаемой транзакции (опционально)
  • numberOfConfirmations требуемое количество подтверждений транзакций (опционально)
  • withMessage установите true чтобы получать только транзакции содержащие вложенные сообщения, не зашифрованные или зашифрованные учетной записью (опционально)
  • phasedOnly true чтобы получить только фазированные транзакции (опционально, если не задан nonPhasedOnly)
  • nonPhasedOnly установите true чтобы получить только не фазированные транзакции (опционально, если не задан phasedOnly)

Note: См. Get Constants - описание типов и подтипов


Ответ:

  • transactions (A) массив из транзакций (Подробнее смотри в разделе Get Transaction)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.11.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountTransactions&
    account=NXT-4VDY-LNVT-LMAY-FMCKA&
    lastIndex=0

Ответ:

{
    "requestProcessingTime": 2,
    "transactions": [
        {
            "signature": "0bc2045c2e4291e9595702fc6a9e805f11b65a88a867d515e44b980ef72b440a2...",
            "transactionIndex": 0,
            "type": 0,
            "phased": false,
            "ecBlockId": "441034190304176853",
            "signatureHash": "31f92d5612115e174748c7a261cd0412e00028639301aae0f0c1ddfc7618b7e7",
            "attachment": {
                "version.OrdinaryPayment": 0
            },
            "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "subtype": 0,
            "amountNQT": "1400000000",
            "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "block": "6752144003309284467",
            "blockTimestamp": 46567698,
            "deadline": 1440,
            "timestamp": 46567612,
            "height": 291611,
            "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
            "feeNQT": "100000000",
            "confirmations": 2046,
            "fullHash": "a26a2a36086e5d13f069dd9da06ce4e6b0418e9a299bec0cda39bfa04a2ca5e3",
            "version": 1,
            "sender": "15295723609781267838",
            "recipient": "11580081983047651163",
            "ecBlockHeight": 291600,
            "transaction": "1395392441102264994"
        }
    ]
}

Verified 11-Jun-15

5.12 Get Guaranteed Balance

Возвращает баланс аккаунта который подтвержден определенное количество раз.

Запрос:

  • requestType это getGuaranteedBalance
  • account ID аккаунта
  • numberOfConfirmations минимальное количество подтверждений для транзакций которые включены в гарантированный баланс (опционально, Если не указан или нулевой, то включены минимально подтвержденные транзакции)

Ответ:

  • guaranteedBalanceNQT (S) баланс аккаунта (в NQT) с как минимум numberOfConfirmations подтверждений
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.12.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getGuaranteedBalance&
    account=7114946486381367146&
    numberOfConfirmations=1440

Ответ:

{
    "guaranteedBalanceNQT": "9242231058415",
    "requestProcessingTime": 0
}

Verified 13-Dec-14

5.13 Get Unconfirmed Account Transaction IDs

Возвращает список неподтвержденных идентификаторов транзакций, ассоциированные с заданным аккаунтом.

Запрос:

  • requestType это getUnconfirmedTransactionIds
  • account ID аккаунта (опционально)

Ответ:

  • unconfirmedTransactionIds (A) массив идентификаторов неподтвержденных транзакций

5.13.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getUnconfirmedTransactionIds&
    account=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "requestProcessingTime": 1,
    "unconfirmedTransactionIds": []
}

Verified 13-Dec-14

5.14 Get Unconfirmed Account Transactions

Возвращает список неподтвержденных транзакций ассоциированных с аккаунтом.

Запрос:

  • requestType это getUnconfirmedTransactions
  • account ID аккаунта (опционально)

Ответ:

  • unconfirmedTransactions (A) массив содержащий неподтвержденные транзакции (подробнее смотри в разделе Get Transaction)

5.14.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getUnconfirmedTransactions&
    account=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "unconfirmedTransactions": [],
    "requestProcessingTime": 1
}

Verified 13-Dec-14

5.15 Search Accounts

Get accounts having a name or description that match a given query in reverse relevance order.

Запрос:

  • requestType это searchAccounts
  • query полнотекстовый запрос к полям аккаунта name (S) и description (S) в синтаксисе Lucene
  • firstIndex индекс (начиная с 0) первого возвращаемого аккаунта (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого аккаунта (опционально)

Ответ:

  • accounts (A) массив объектов аккаунта со следующими полями:
    • account (S) номер аккаунта
    • accountRS (S) адрес аккаунта в формате Reed-Solomon
    • name (S) название аккаунта
    • description (S) описание аккаунта (если применимо)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

5.15.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=searchAccounts&
    query=testnet AND tyler

Ответ:

{
    "accounts": [
        {
            "accountRS": "NXT-7C4U-3Z9K-GZM8-CU8EJ",
            "name": "Tyler Jordan",
            "description": "testnet account",
            "account": "12119426358687475802"
        }
    ],
    "requestProcessingTime": 16
}

Verified 11-Jun-15

5.16 Send NXT

Переслать NXT на аккаунт. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это sendMoney
  • amountNQT количество (в NQT) в транзакции
  • recipient ID аккаунта получателя
  • recipientPublicKey публичный ключ аккаунта получателя (опционально, повышает безопасность недавно созданного аккаунта)

Ответ: подробности смотри в разделе Create Transaction Response.

5.16.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=sendMoney&
    secretPhrase=IWontTellYou&
    recipient=NXT-4VNQ-RWZC-4WWQ-GVM8S&
    amount=100000000&
    fee=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7",
    "unsignedTransactionBytes": "001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "5f0378b7390ff5a815eadd1354de533eef682f139362b153576e2207320a6...",
        "feeNQT": "100000000",
        "type": 0,
        "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
        "version": 1,
        "ecBlockId": "17321329645912574173",
        "signatureHash": "b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7",
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 0,
        "amountNQT": "100000000",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
        "recipient": "17013046603665206934",
        "ecBlockHeight": 275727,
        "deadline": 60,
        "transaction": "15200507403046301754",
        "timestamp": 29796934,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 8475,
    "transactionBytes": "001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
    "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
    "transaction": "15200507403046301754"
}

Verified 13-Dec-14

5.17 Set Account Information

Устанавливает информацию о аккаунте. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это setAccountInfo
  • name ИМЯ ассоциированное с этим аккаунтом (опционально)
  • description описание связанное с данным аккаунтом (опционально)
  • messagePatternRegex является регулярным выражением в соответствии со спецификациями java.util.regex.Pattern; входящие транзакции принимаются только, если они содержат обычное текстовое сообщение, которое соответствует этому шаблону
  • messagePatternFlags является битовой маской java.util.regex.Pattern флага, такие как 2 (Pattern.CASE_INSENSITIVE)

Response: подробнее смотри в разделе Create Transaction Response.

5.17.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=setAccountInfo&
    secretPhrase=IWontTellYou&
    name=iwonttellyou
    description=example account
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "15917aafd59ad9cece7dfc127ab256711d1c58a8ed1a0dc7334949ca826d8a32",
    "unsignedTransactionBytes": "0115dfeecb013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "3f5167a3a23677c85aba7fbbc8bc31cddf540a632abebee4a80fe08ba92b9a0...",
        "feeNQT": "100000000",
        "type": 1,
        "fullHash": "2d31c26aa2b0ae4cf233cc4035c555bca0c579bdcef24bc9819132dc2ce5b2e5",
        "version": 1,
        "ecBlockId": "17558522603047297060",
        "signatureHash": "15917aafd59ad9cece7dfc127ab256711d1c58a8ed1a0dc7334949ca826d8a32",
        "attachment": {
            "name": "iwonttellyou",
            "description": "example account",
            "version.AccountInfo": 1
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 5,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "ecBlockHeight": 279080,
        "deadline": 60,
        "transaction": "5525548004452479277",
        "timestamp": 30142175,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 8553,
    "transactionBytes": "0115dfeecb013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "2d31c26aa2b0ae4cf233cc4035c555bca0c579bdcef24bc9819132dc2ce5b2e5",
    "transaction": "5525548004452479277"
}

Verified 13-Dec-14

6 Операции с Альясами

6.1 Buy / Sell Alias

Покупка/продажа альяса. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType может принимать значение buyAlias или sellAlias
  • alias ID альяса (опционально)
  • aliasName название альяса (опционально if alias provided)
  • priceNQT запрашиваемая цена (в NQT) за альяс (только в случае sellAlias)
  • amountNQT сумма (в NQT) предлагаемая за продаваемый альяс (только в случае buyAlias)
  • recipient ID аккаунта получателя (требуется только для sellAlias и только если конкретный получатель задан)
  • recipientPublicKey публичный ключ аккаунта получателя (требуется только если recipient указан и только если это первая транзакция для нового аккаунта)

Примечание: Альяс может быть передан, а не продан, для этого необходимо установить priceNQT равным нулю. Незаконченная передача альяса может быть отменена, путем продажи самому себе за цену равной нулю.

Ответ: Смотри подробности в разделе Create Transaction Response.

6.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=sellAlias&
    secretPhrase=IWontTellYou&
    aliasName=nextus&
    priceNQT=5&
    recipient=NXT-4VNQ-RWZC-4WWQ-GVM8S&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "d6f026cd8a883b5b6ff78a7d0121e4847eb6744b02757427de6d7ca0bf304226",
    "unsignedTransactionBytes": "01166e01d4013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "2041afc1687da2693ba092e33a84f665ad461e3b6762c18af61778261bc7e...",
        "feeNQT": "100000000",
        "type": 1,
        "fullHash": "14a3eeb17cd4082db287259a768d32065d4cf5397ed6053fffa25e92a8a66ac7",
        "version": 1,
        "ecBlockId": "1612829598027150491",
        "signatureHash": "d6f026cd8a883b5b6ff78a7d0121e4847eb6744b02757427de6d7ca0bf304226",
        "attachment": {
            "alias": "nextus",
            "priceNQT": "5",
            "version.AliasSell": 1
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 6,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
        "recipient": "17013046603665206934",
        "ecBlockHeight": 284050,
        "deadline": 60,
        "transaction": "3245077163546682132",
        "timestamp": 30671214,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 8515,
    "transactionBytes": "01166e01d4013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
    "fullHash": "14a3eeb17cd4082db287259a768d32065d4cf5397ed6053fffa25e92a8a66ac7",
    "transaction": "3245077163546682132"
}

Verified 13-Dec-14


6.2 Create / Assign Alias

Создание и/или подписывание альяса. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это setAlias
  • aliasName имя альяса
  • aliasURI URI альяса (например http://www.google.com/)

Ответ: Подробнее смотри в разделе Create Transaction Response. ID транзакции а также ID альяса.

6.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=setAlias&
    secretPhrase=IWontTellYou&
    aliasName=iwonttellyou&
    aliasURI=acct:nxt-l6fm-89wk-vk8p-fcrbb@nxt&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "0dc7e07acef27fe86686cfabe2d1bd57c0c038f9465c3fe3d10f67932a97af10",
    "unsignedTransactionBytes": "011135d0d3013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "d92aefbab189b6e61f890c34b06a47e14a1a2b2ce868f77a4591d2067c51d...",
        "feeNQT": "100000000",
        "type": 1,
        "fullHash": "53917acbf44109391609a9bb57832c0d5903301e3d2bd6ffcf45cf893480f5a1",
        "version": 1,
        "ecBlockId": "4181883296304410027",
        "signatureHash": "0dc7e07acef27fe86686cfabe2d1bd57c0c038f9465c3fe3d10f67932a97af10",
        "attachment": {
            "alias": "iwonttellyou",
            "version.AliasAssignment": 1,
            "uri": "acct:nxt-l6fm-89wk-vk8p-fcrbb@nxt"
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 1,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "ecBlockHeight": 283939,
        "deadline": 60,
        "transaction": "4109888654593921363",
        "timestamp": 30658613,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 8104,
    "transactionBytes": "011135d0d3013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473...",
    "fullHash": "53917acbf44109391609a9bb57832c0d5903301e3d2bd6ffcf45cf893480f5a1",
    "transaction": "4109888654593921363"
}

Verified 13-Dec-14

6.3 Delete Alias

Удаление альяса по заданному ID альяса или имени. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это deleteAlias
  • alias ID альяса (опционально)
  • aliasName имя альяса который будет удаляться (опционально если alias представлен)

Ответ: Подробнее смотри в разделе Create Transaction Response.

6.3.1 Пример

Запрос:

https://localhost:7876/nxt?
    requestType=deleteAlias&
    aliasName=mystical

Ответ:

{
    "signatureHash": "a6e68daed99c1015dd12546c042466612b52a9f5193d8513f7f12684aba5bf1d",
    "unsignedTransactionBytes": "011809e60c023c0010f09c34f225d425306e5be55a49469081...",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "a5088bc6469e528d884e7fd3c49afeefc8656dd59c9fa5ffeab2a17b465f6d03e77...",
        "feeNQT": "100000000",
        "type": 1,
        "fullHash": "63afc769e677b6210617ff7a9f5be2d7fe1aea7e46ccad968017d28df578fabf",
        "version": 1,
        "ecBlockId": "17895923487075501156",
        "signatureHash": "a6e68daed99c1015dd12546c042466612b52a9f5193d8513f7f12684aba5bf1d",
        "attachment": {
            "version.AliasDelete": 1,
            "alias": "mystical"
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 8,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "ecBlockHeight": 161137,
        "deadline": 60,
        "transaction": "2429260880513838947",
        "timestamp": 34399753,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 52,
    "transactionBytes": "011809e60c023c0010f09c34f225d425306e5be55a4946908156072...",
    "transaction": "2429260880513838947"
}

Verified 30-Dec-14


6.4 Get Alias

Возвращает информацию о заданном альясе

Запрос:

  • requestType это getAlias
  • alias ID альяса (опционально)
  • aliasName имя альяса (опционально, если alias представлен)

Ответ:

  • timestamp (N) время (в секундах от создания генезисного блока) когда альяс был создан или последний раз передавался
  • aliasName (S) название альяса
  • account (S) номер аккаунта который является владельцем аккаунта
  • accountRS (S) адрес аккаунта владельца альяса в формате Reed-Solomon
  • aliasURI (S) то, на что указывает альяс, в формате URI
  • alias (S) ID альяса
  • priceNQT (S) запрашиваемая цена (в NQT) альяса, если он выставлен на продужу
  • buyer (S) номер аккаунта покупателя если альяс выставлен на продажу и покупатель указан
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

6.4.1 Пример

Запрос:

https://localhost:7876/nxt?
    requestType=getAlias&
    alias=15515279700680480368

Ответ:

{
    "aliasURI": "http://google.com",
    "aliasName": "google",
    "accountRS": "NXT-FLVS-VRBV-LDPD-6DZ9W",
    "alias": "15515279700680480368",
    "requestProcessingTime": 1,
    "account": "5629477397208681336",
    "timestamp": 2409343
}

Verified 29-Dec-14

6.5 Get Alias Count

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

Запрос:

  • requestType это getAliasCount
  • account ID аккаунта

Ответ:

  • numberOfAliases (N) количество альясов принадлежащих указанный аккаунт
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

6.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAliasCount&
    account=NXT-FLVS-VRBV-LDPD-6DZ9W

Ответ:

{
    "numberOfAliases": 200,
    "requestProcessingTime": 2
}

Verified 13-Dec-14

6.6 Get Aliases

Возвращает информацию о альясах, принадлежащих указанному аккаунту, отсортированных по имени.

Запрос:

  • requestType это getAliases
  • account ID аккаунта
  • timestamp метка времени создания альяса (в секундах от времени создания генезисного блока) начиная с которой будут выбираться альясы (опционально)
  • firstIndex индекс (начиная с 0) первого получаемого альяса (опционально)
  • lastIndex индекс (начиная с 0) последнего получаемого альяса (опционально)

Ответ:

  • aliases (A) массив состоящий из объектов альясов (Подробнее смотри в разделе Get Alias )
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

6.6.1 Пример

Запрос:

https://localhost:7876/nxt?
    requestType=getAliases&
    account=5629477397208681336&
    lastIndex=1

Ответ:

{
    "aliases": [
        {
            "aliasURI": "",
            "aliasName": "101",
            "accountRS": "NXT-FLVS-VRBV-LDPD-6DZ9W",
            "alias": "8952438483248557843",
            "account": "5629477397208681336",
            "timestamp": 2409893
        }
    ],
    "requestProcessingTime": 1
}

Verified 13-Dec-14

6.7 Get Aliases Like

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

Запрос:

  • requestType это getAliasesLike
  • aliasPrefix префикс (не менее 2х символов) поля aliasName
  • firstIndex индекс (начиная с 0) первого возвращаемого альяса (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого (опционально)

Ответ:

  • aliases (A) массив из элементов альяс (Подробнее смотри в разделе Get Alias)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

6.7.1 Пример

Запрос:

https://localhost:7876/nxt?
    requestType=getAliasesLike&
    aliasPrefix=mysteri

Ответ:

{
    "aliases": [
        {
            "aliasURI": "",
            "aliasName": "mysteries",
            "accountRS": "NXT-9DZL-XFE2-EWE5-HVVAY",
            "alias": "13234331415538245332",
            "account": "18384674354580664306",
            "timestamp": 4856820
        },
        {
            "aliasURI": "anm",
            "aliasName": "mysterious",
            "accountRS": "NXT-AHBB-DSVC-WS2L-EW8BC",
            "alias": "8033154744709486670",
            "account": "14205721421835156777",
            "timestamp": 2417903
        }
    ],
    "requestProcessingTime": 1
}

Verified 11-Jun-15

7 Операции с Системой Произвольных Сообщений

7.1 Decrypt Message From

Расшифровать AES-зашифрованное сообщение.

Запрос:

  • requestType это decryptFrom
  • secretPhrase секретная фраза получателя
  • account ID аккаунта получателя
  • data данные зашифрованные алгоритмом AES
  • nonce псевдослучайная последовательность, уникальный для данного случая, связанная с зашифрованными данными
  • decryptedMessageIsText принимает значение false если расшифрованное сообщение hex строка, в противном случае расшифрованное сообщение это текст (опционально)

Ответ:

  • decryptedMessage (S) расшифрованное сообщение
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

7.1.1 Пример

Запрос:

    http://localhost:7876/nxt?
    requestType=decryptFrom&
    secretPhrase=IWontTellYou&
    account=NXT-L6FM-89WK-VK8P-FCRBB&
    data=5c30bd27cc86a8ab0349aaf66deae3c0a9db5675b5c4ba973dd47f37e06157...&
    nonce=7f3c9082c73a7bd825aa48d23fc138fd05a466700ff9fc3a040bbb29d3a60ee1&

Ответ:

{
    "decryptedMessage": "test message",
    "requestProcessingTime": 2
}

Verified 13-Dec-14

7.2 Encrypt Message To

Зашифровать сообщение используя AES, без отсылки самого сообщения.

Запрос:

  • requestType это encryptTo
  • secretPhrase секретная фраза отправителя
  • recipient ID аккаунта получателя
  • messageToEncrypt может быть любой набор данных как то UTF-8 текст или hex строка которая будет сжата и преобразована в байткод длиной не более 1000 байт а затем зашифрована при помощи AES алгоритма
  • messageToEncryptIsText может быть false если шифруемое сообщение hex строка, в противном случае шифруемое сообщение является текстовой строкой (опционально)

Ответ:

  • data (S) AES зашифрованные данные
  • nonce (S) 32-битная псевдослучайная последовательность
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

7.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=encryptTo&
    secretPhrase=IWontTellYou&
    recipient=NXT-L6FM-89WK-VK8P-FCRBB&
    messageToEncrypt=test message&

Ответ:

{
    "data": "5c30bd27cc86a8ab0349aaf66deae3c0a9db5675b5c4ba973dd47f37e06157...",
    "requestProcessingTime": 48,
    "nonce": "7f3c9082c73a7bd825aa48d23fc138fd05a466700ff9fc3a040bbb29d3a60ee1"
}

Verified 13-Dec-14

7.3 Get All Prunable Messages

Получает все доступные prunable сообщения в порядке обратном метке времени блока.

Запрос:

  • requestType это getAllPrunableMessages
  • firstIndex индекс (начиная с 0) первого возвращаемого prunable сообщения (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого prunable сообщения (опционально)

Ответ:

  • prunableMessages (A) массив из prunable сообщений (Подробнее смотри в разделе Get Prunable Message)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

7.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAllPrunableMessages&
    lastIndex=0

Ответ:

{
    "prunableMessages": [
        {
            "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "sender": "15295723609781267838",
            "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "recipient": "11580081983047651163",
            "blockTimestamp": 46382992,
            "message": "This is a test prunable plain message.",
            "transaction": "4628485271017409467",
            "isText": true,
            "transactionTimestamp": 46382948
        }
    ],
    "requestProcessingTime": 0
}

Verified 11-Jun-15

7.4 Get Prunable Message

Получает prunable сообщения, по заданному ID транзакции, дополнительно дешифровав его, если оно было зашифровано и если secretPhrase предоставлена, если оно (prunable сообщение) еще доступно.

Запрос:

  • requestType это getPrunableMessage
  • transaction ID транзакции
  • secretPhrase секретная фраза необходимая для расшифровки (опционально)

Response:

  • sender (S) is the sender account number
  • senderRS (S) is the Reed-Solomon address of the sender account
  • recipient (S) is the recipient account number
  • recipientRS (S) is the Reed-Solomon address of the recipient account
  • message (S) or encryptedMessage (O) is either the plain message text or the encrypted message object, the latter containing data (S) and nonce (S) fields
  • decryptedMessage (S) is the decrypted and decompressed (if necessary) encrypted message, if applicable and if secretPhrase is provided
  • isText (B) is true if the (decrypted) message is text, false if it is a hex string
  • isCompressed (B) is true if the encrypted message was compressed before encryption, if applicable
  • transaction (S) is the transaction ID
  • transactionTimestamp (N) is the transaction timestamp (in seconds since the genesis block)
  • blockTimestamp (N) is the block timestamp (in seconds since the genesis block)
  • requestProcessingTime (N) is the API request processing time (in millsec)

7.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getPrunableMessage&
    transaction=16832262845403902696&
    secretPhrase=secretPhrase

Ответ:

{
    "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
    "encryptedMessage": {
        "data": "ba6baa8361ac5bdb9cb591cee616dc5801a32ddf05b66a4ee527cd8d57b0...",
        "nonce": "41f93e32997c70937a005e5b0b42546a1efa9ea9eb012f98d7a92d0c5a8855a4"
    },
    "sender": "15295723609781267838",
    "decryptedMessage": "test prunable encrypted message",
    "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
    "recipient": "11580081983047651163",
    "blockTimestamp": 46117919,
    "requestProcessingTime": 3,
    "transaction": "16832262845403902696",
    "isText": true,
    "transactionTimestamp": 46117594,
    "isCompressed": true
}

Verified 11-Jun-15

7.5 Get Prunable Messages

Get all still-available prunable messages given an account id, optionally limiting to only those with another account as recipient or sender, in reverse chronological order.

Request:

  • requestType is getPrunableMessage
  • account is the account ID
  • otherAccount is another account ID, either sender or recipient, to limit the response
  • secretPhrase is the secret phrase needed for decryption (optional)
  • firstIndex is a zero-based index to the first prunable message to retrieve (optional)
  • lastIndex is a zero-based index to the last prunable message to retrieve (optional)

Ответ:

  • prunableMessages (A) массив из объектов prunable сообщений (Подробнее смотри в разделе Get Prunable Message)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

7.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getPrunableMessages&
    account=NXT-4VDY-LNVT-LMAY-FMCKA&
    lastIndex=0

Ответ:

{
    "prunableMessages": [
        {
            "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "encryptedMessage": {
                "data": "ba6baa8361ac5bdb9cb591cee616dc5801a32ddf05b66a4ee527cd8d57b0a...",
                "nonce": "41f93e32997c70937a005e5b0b42546a1efa9ea9eb012f98d7a92d0c5a8855a4"
            },
            "sender": "15295723609781267838",
            "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "recipient": "11580081983047651163",
            "blockTimestamp": 46117919,
            "transaction": "16832262845403902696",
            "isText": true,
            "transactionTimestamp": 46117594,
            "isCompressed": true
        }
    ],
    "requestProcessingTime": 1
}

Verified 11-Jun-15

7.6 Read Message

Возвращает сообщение по указанному ID транзакции.

Запрос:

  • requestType это readMessage
  • transaction ID транзакции сообщения
  • secretPhrase секретная фраза аккаунта который получает сообщение

Ответ:

  • message (S) сообщение (расшифрованное)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

7.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=readMessage&
    transaction=9908575668289607167&
    secretPhrase=IWontTellYou&

Ответ:

{
    "requestProcessingTime": 1,
    "message": "Test message."
}

Verified 13-Dec-14

7.7 Send Message

Создает транзакцию Произвольного Сообщения (отправка произвольного сообщения). Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это sendMessage
  • recipient ID аккаунта получателя (опционально)
  • recipientPublicKey публичный ключ аккаунта получателя (опционально, повышает безопасность недавно созданного аккаунта)
  • message текст UTF-8 или шестнадцатеричная строка (возможно предварительно зашифрованная с использованием произвольного алгоритма), которая будет преобразована в 1000 байтный (максимум) bytecode (опционально)
  • messageIsText установите в false если сообщение это шестнадцатеричная строка, в противном случае сообщение это текст (опционально)
  • messageToEncrypt текст UTF-8 или шестнадцатеричная строка для последующего сжатия и конвертации в 1000 байтный (максимум) байткод, зашифрованный с использованием алгоритма AES (опционально)
  • messageToEncryptIsText false если сообщение для шифрования это шестнадцатеричная строка, в противном случае сообщение для шифрования это текст (опционально)
  • encryptedMessageData уже зашифрованные данные которые заменят messageToEncrypt если представлено (опционально)
  • encryptedMessageNonce уникальное 32-битные число которое не может использоваться повторно (опционально если encryptedMessageData представлено)
  • messageToEncryptToSelfтекст UTF-8 или шестнадцатеричная строка для последующего сжатия и конвертации в 1000 байтный (максимум) байткод, зашифрованный с использованием алгоритма AES, чтобы быть отправленным аккаунтом отправителем (опционально)
  • messageToEncryptToSelfIsText false если сообщение для само-шифрования это шестнадцатеричная строка, в противном случае сообщение для шифрования это текст (опционально)
  • encryptToSelfMessageData уже зашифрованные данные которые заменят messageToEncryptToSelf представлено (опционально)
  • encryptToSelfMessageNonce уникальное 32-битные число которое не может использоваться повторно (опционально если encryptToSelfMessageData представлено)

Примечание: Любая комбинация из этих трех опций (может быть как ни одной так и все) message, messageToEncrypt, и messageToEncryptToSelf будут включены в транзакцию, но если задан только messageToEncryptToSelf, получателю нужно указать отправителя. encryptedMessageData-encryptedMessageNonce пара или encryptToSelfMessageData-encryptToSelfMessageNonce пара могут быть зашифрованы

Note: The encryptedMessageData-encryptedMessageNonce pair or the encryptToSelfMessageData-encryptToSelfMessageNonce pair can be the output of Encrypt Message To

Ответ: Подробнее смотри в разделе Create Transaction Response.

7.7.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=sendMessage&
    secretPhrase=IWontTellYou&
    recipient=NXT-4VNQ-RWZC-4WWQ-GVM8S&
    message=Test Message.&
    deadline=60

Ответ:

{
    "signatureHash": "795c58938a50d691f3f2b88bfaf03267236e972e1c068e0a5e11aeb606597f17",
    "unsignedTransactionBytes": "01100593ce013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c14...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "e916dbbfec51ca97ae76b1b190d1c74328f74c3c43ed3a06f1ca0ea250116...",
        "feeNQT": "100000000",
        "type": 1,
        "fullHash": "ff157b8a125582898b5c50d32a62f725602d5197af236fabcd6ec978b6861528",
        "version": 1,
        "ecBlockId": "6060075251340574063",
        "signatureHash": "795c58938a50d691f3f2b88bfaf03267236e972e1c068e0a5e11aeb606597f17",
        "attachment": {
            "version.Message": 1,
            "messageIsText": true,
            "message": "Test message."
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 0,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
        "recipient": "17013046603665206934",
        "ecBlockHeight": 280756,
        "deadline": 60,
        "transaction": "9908575668289607167",
        "timestamp": 30315269,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 11379,
    "transactionBytes": "01100593ce013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "ff157b8a125582898b5c50d32a62f725602d5197af236fabcd6ec978b6861528",
    "transaction": "9908575668289607167"
}

Verified 13-Dec-14

7.8 Verify Prunable Message

Verify that a prunable message obtained from any source, when hashed, matches the hash of the original prunable message.

Request: Refer to Send Message for more details about the following request parameters.

  • requestType is verifyPrunableMessage
  • message is the plain message, if applicable (optional)
  • messageIsText is false if the provided plain message is a hex string (optional)
  • encryptedMessageData is the data part of the encrypted data-nonce pair (optional if message provided)
  • encryptedMessageNonce is the nonce part of the encrypted data-nonce pair (required if encryptedMessageData provided)
  • messageToEncryptIsText is false if the encrypted message was a hex string before encryption (optional)
  • compressMessageToEncrypt is false if the encrypted message was not compressed before encryption (optional)

Note: The hash is computed from the message itself plus its associated flag(s) isText and isCompressed (encrypted only); therefore the flag(s) must be provided for verification if different from the default(s). The original encryptedMessageData-encryptedMessageNonce pair used to compute the original hash must be provided again to recompute the hash for verification of a prunable encrypted message.

Response:

  • version.PrunablePlainMessage or version.PrunableEncryptedMessage (N) is 1, the version number
  • verify (B) is true if the original hash matches the hash computed from the provided values
  • message (S) or encryptedMessage (O) is the prunable plain message or the prunable encrypted message object containing the fields:
    • data (S)
    • nonce (B)
    • isText (B)
    • isCompressed (B)
  • messageIsText (B) is true if the plain message is text, false if it is a hex string, if applicable
  • messageHash or encryptedMessageHash (S) is the hash
  • requestProcessingTime (N) is the API request processing time (in millsec)

7.8.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=verifyPrunableMessage&
    message=This is a test prunable plain message.

Ответ:

{
    "version.PrunablePlainMessage": 1,
    "verify": true,
    "messageIsText": true,
    "messageHash": "da99da8026e30d971340ef54803543af3aa48ea215f80bd9375457bad8effb3f",
    "requestProcessingTime": 1,
    "message": "This is a test prunable plain message."
}

Verified 11-Jun-15

8 Действия на Бирже Активов

8.1 Cancel Order

Отменяет существующий ордер с активом. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType может принимать значение cancelBidOrder или cancelAskOrder
  • order ID ордера который должен быть отменен

Ответ: Подробнее смотри в разделе Create Transaction Response.

8.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=cancelBidOrder&
    secretPhrase=IWontTellYou&
    order=17185236428295897167&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "20264f33a06331f6a8d7c4362d0525aee25e4ef991653f14bbfb1b2beebba433",
    "unsignedTransactionBytes": "02153c6ed6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "30cf47942179f5969369699b548f5a3517ef7ff71b337db630ea5f8b6e740...",
        "feeNQT": "100000000",
        "type": 2,
        "fullHash": "725f441d9f50a9b2e02d780098a827b1015ec902199becd493bfa73a4843ae89",
        "version": 1,
        "ecBlockId": "196207598250363138",
        "signatureHash": "20264f33a06331f6a8d7c4362d0525aee25e4ef991653f14bbfb1b2beebba433",
        "attachment": {
            "version.BidOrderCancellation": 1,
            "order": "17185236428295897167"
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 5,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "ecBlockHeight": 285586,
        "deadline": 60,
        "transaction": "12873909654136315762",
        "timestamp": 30830140,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 7640,
    "transactionBytes": "02153c6ed6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "725f441d9f50a9b2e02d780098a827b1015ec902199becd493bfa73a4843ae89",
    "transaction": "12873909654136315762"
}

Verified 13-Dec-14

8.2 Dividend Payment

Выплата дивидендов всем держателям заданного актива. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это dividendPayment
  • asset ID актива
  • height высота blockchain при которой акции держателей актива будут посчитаны (должна быть меньше чем 1440 блоков в прошлом),
  • amountNQTPerQNT сумма дивидендов (в NQT pf QNT актива)

Ответ: Подробнее смотри в разделе Create Transaction Response.

8.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dividendPayment&
    asset=3517042713515967694&
    height=161157&
    amountNQTPerQNT=100000000

Ответ:

{
    "signatureHash": "5d92fee3570b7b058ace2387f5b4eef4377ea738e6a6c2aabc06bd9f6871e4b4",
    "unsignedTransactionBytes": "02160feb0c023c0010f09c34f225d425306e5be55a49469081...",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "61e2398087b078bdba24021d909e937c2d5fe157a09fa3c82d910e7b5843e00cef2...",
        "feeNQT": "100000000",
        "type": 2,
        "fullHash": "27b52e61813b73fdf9ff3b1bacf3b344d3ed60e8c94db2c9d0518c8483150770",
        "version": 1,
        "ecBlockId": "17871828515938613022",
        "signatureHash": "5d92fee3570b7b058ace2387f5b4eef4377ea738e6a6c2aabc06bd9f6871e4b4",
        "attachment": {
            "version.DividendPayment": 1,
            "amountNQTPerQNT": "100000000",
            "asset": "3517042713515967694",
            "height": 161157
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 6,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "ecBlockHeight": 161151,
        "deadline": 60,
        "transaction": "18263006340784764199",
        "timestamp": 34401039,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 111,
    "transactionBytes": "02160feb0c023c0010f09c34f225d425306e5be55a49469081560...",
    "fullHash": "27b52e61813b73fdf9ff3b1bacf3b344d3ed60e8c94db2c9d0518c8483150770",
    "transaction": "18263006340784764199"
}

Verified 29-Dec-14

8.3 Get Account Asset Count

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

Запрос:

  • requestType это getAccountAssetCount
  • account ID аккаунта
  • height высота blockchain, чтобы определить количество актива (опционально, по умолчанию последний блок),

Примечание: Если обрезание таблиц включено (по умолчанию), высота должна быть в пределах 1440 блоков от последнего блока.

Ответ:

  • numberOfAssets (N) количество активов принадлежащих аккаунту
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountAssetCount&
    account=NXT-8N9W-TN4F-YA2S-H5B7R

Ответ:

{
    "requestProcessingTime": 1,
    "numberOfAssets": 3
}

Verified 13-Dec-14

8.4 Get Account Assets

Возвращает активы, принадлежащие указанному аккаунту, в порядке обратном количеству (от меньшего количества к большему).

Запрос:

  • requestType это getAccountAssets
  • account ID аккаунта
  • asset фильтр по ID актива (опционально)
  • height высота blockchain, при которой будут получен баланс (опционально, по умолчанию последний блок в blockchain)

Примечание: Если обрезание таблиц включено (по умолчанию), высота должна быть в пределах 1440 блоков от последнего блока.

Ответ:

  • accountAssets (A) массив из объектов актива (если параметр asset не определен) со следующими записями для каждого актива:
  • quantityQNT (S) количество (в QNT) актива
  • unconfirmedQuantityQNT (S) неподтвержденное количество (в QNT) актива
  • asset (S) ID актива
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountAssets&
    account=NXT-4VNQ-RWZC-4WWQ-GVM8S

Ответ:

{
    "accountAssets": [
        {
            "quantityQNT": "68013764",
            "unconfirmedQuantityQNT": "68013764",
            "asset": "17554243582654188572"
        }
    ],
    "requestProcessingTime": 1
}

Verified 13-Dec-14

8.5 Get Account Current Order IDs

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

Запрос:

  • requestType может быть getAccountCurrentBidOrderIds или getAccountCurrentAskOrderIds
  • account ID аккаунта
  • asset ID актива для фильтрации (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого значения ID ордера (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения ID ордера (опционально)

Ответ:

  • bidOrderIds или askOrderIds (A) массив из ID (идентификаторов) ордеров
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountCurrentBidOrderIds&
    account=NXT-L6FM-89WK-VK8P-FCRBB&
    asset=17554243582654188572

Ответ:

{
    "bidOrderIds": [
        "17185236428295897167"
    ],
    "requestProcessingTime": 4
}

Verified 14-Dec-14

8.6 Get Account Current Orders

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

Запрос:

  • requestType может быть getAccountCurrentBidOrders или getAccountCurrentAskOrders
  • account ID аккаунта
  • asset ID актива для фильтрации (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого значения ID ордера (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения ID ордера (опционально)

Ответ:

  • bidOrders или askOrders (A) массив из объектов ордеров (Подробнее смотри в разделе Get Order)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountCurrentBidOrders&
    account=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "bidOrders": [
        {
            "quantityQNT": "1000000",
            "priceNQT": "100",
            "accountRS": "NXT-L6FM-89WK-VK8P-FCRBB",
            "asset": "17554243582654188572",
            "type": "bid",
            "account": "15323192282528158131",
            "order": "17185236428295897167",
            "height": 285549
        }
    ],
    "requestProcessingTime": 1
}

Verified 14-Dec-14

8.7 Get All Assets

Возвращает все активы на бирже, в порядке обратном высоте блока создания.

Запрос:

  • requestType это getAllAssets
  • firstIndex индекс (начиная с 0) первого возвращаемого значения актива (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения актива (опционально)
  • includeCounts установите в false если необходимо чтобы записи начинающиеся с numberOf... были опущены (опционально)

Ответ:

  • assets (A) массив из объектов активов (Подробнее смотри в разделе Get Asset)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.7.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAllAssets&
    firstIndex=13&
    lastIndex=13

Ответ:

{
    "assets": [
        {
            "quantityQNT": "2100000000000000",
            "numberOfAccounts": 31,
            "accountRS": "NXT-3TKA-UH62-478B-DQU6K",
            "decimals": 8,
            "numberOfTransfers": 63,
            "name": "mgwBTC",
            "description": "Production Multigateway BTC (mgwBTC) is backed 100% by...",
            "numberOfTrades": 9,
            "asset": "17554243582654188572",
            "account": "13300069592148796968"
        }
    ],
    "requestProcessingTime": 13
}

Verified 14-Dec-14

8.8 Get All Open Orders

Возвращает все открытые ордера спроса/предложения в порядке обратном высоте блока ордера.

Запрос:

  • requestType может принимать значение getAllOpenBidOrders или getAllOpenAskOrders
  • firstIndex индекс (начиная с 0) первого возвращаемого ордера (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого ордера (опционально)

Ответ:

  • openOrders (A) массив состоящий из объектов ордеров (Подробнее смотри в разделе Get Order )
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.8.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAllOpenBidOrders&
    firstIndex=123&
    lastIndex=123

Ответ:

{
    "requestProcessingTime": 5631,
    "openOrders": [
        {
            "quantityQNT": "1000000",
            "priceNQT": "101",
            "accountRS": "NXT-L6FM-89WK-VK8P-FCRBB",
            "asset": "17554243582654188572",
            "type": "bid",
            "account": "15323192282528158131",
            "order": "12743274869785967304",
            "height": 285577
        }
    ]
}

Verified 14-Dec-14

8.9 Get All Trades

Возвращает все сделки с заданной отметкой времени в порядке обратном высоте блока.

Запрос:

  • requestType это getAllTrades
  • timestamp метка времени (в секундах от времени создания генезисного блока) начиная с которой будут возвращаться сделки (опционально, по умолчанию 0)
  • firstIndex индекс (начиная с 0) первой возвращаемой сделки (опционально)
  • lastIndex индекс (начиная с 0) последней возвращаемой сделки (опционально)
  • includeAssetInfo если false то информация о активе будет опущена (опционально)

Примечание: Если timestamp опущена или ноль, и ни один индекс не задан, будут возвращены все сделки которые есть в blockchain, что может привести к зависанию или "падению" вашей системы.

Response:

  • trades (A) массив из объектов сделок (Подробнее смотри в разделе Get Trades)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.9.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAllTrades&
    lastIndex=0

Ответ:

"trades": [
        {
            "seller": "14968762166783718535",
            "quantityQNT": "10000",
            "bidOrder": "1166717226538227076",
            "sellerRS": "NXT-8F69-W9Z9-8M6Y-ETXGZ",
            "buyer": "202478233571806601",
            "priceNQT": "19796",
            "askOrder": "16222071953599729591",
            "buyerRS": "NXT-RMEB-W7TE-28EM-2SUM7",
            "decimals": 8,
            "name": "mgwBTC",
            "block": "8807797247643599359",
            "asset": "4551058913252105307",
            "askOrderHeight": 285768,
            "bidOrderHeight": 286453,
            "tradeType": "buy",
            "timestamp": 30920039,
            "height": 286453
        }
    ],
    "requestProcessingTime": 25840

Verified 14-Dec-14

8.10 Get Asset

Получает информацию о Активе с заданным ID актива.

Запрос:

  • requestType это getAsset
  • asset ID актива
  • includeCounts установите в false если необходимо чтобы начало записей numberOf... было опущено (опционально)

Ответ:

  • account (S) номер аккаунта который выпустил актив
  • accountRS (S) номер аккаунта в формате Reed-Solomon который выпустил актив
  • name (S) название актива
  • description (S) описание актива
  • quantityQNT (S) общее существующее количество актива (в QNT)
  • asset (N) ID актива
  • decimals (N) число десятичных разрядов, используемых активом
  • numberOfAccounts (N) количество аккаунтов который владеют данным активом
  • numberOfTrades (N) число сделок по этому активу
  • numberOfTransfers (N) количество трансферов данного актива
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.10.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAsset&
    asset=17554243582654188572

Ответ:

{
    "quantityQNT": "2100000000000000",
    "numberOfAccounts": 31,
    "accountRS": "NXT-3TKA-UH62-478B-DQU6K",
    "decimals": 8,
    "numberOfTransfers": 63,
    "name": "mgwBTC",
    "description": "Production Multigateway BTC (mgwBTC) is backed 100% by...",
    "numberOfTrades": 9,
    "requestProcessingTime": 11,
    "asset": "17554243582654188572",
    "account": "13300069592148796968"
}

Verified 14-Dec-14

8.11 Get Asset Account Count

Получает количество аккаунтов владеющих активом с заданным ID.

Запрос:

  • requestType это getAccountAssetCount
  • account ID аккаунта
  • height высота blockchain, чтобы определить количество актива (опционально, по умолчанию последний блок),

Примечание: Если обрезание таблиц включено (по умолчанию), высота должна быть в пределах 1440 блоков от последнего блока.

Ответ:

  • numberOfAccounts (N) количество аккаунтов который владеют указанным активом
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.11.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAssetAccountCount&
    asset=17554243582654188572

Ответ:

{
    "numberOfAccounts": 38,
    "requestProcessingTime": 14
}

Verified 14-Dec-14

8.12 Get Asset Accounts

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

Запрос:

  • requestType это getAssetAccounts
  • asset ID актива
  • height высота blockchain ограничивающая аккаунты (опционально, по умолчанию это последний блок)
  • firstIndex индекс (начиная с 0) первого возвращаемого аккаунта (optional)
  • lastIndex индекс (начиная с 0) последнего возвращаемого аккаунта (optional)

Примечание: Если обрезание таблиц включено (по умолчанию), высота должна быть в пределах 1440 блоков от последнего блока.

Ответ:

  • accountAssets (A) массив объектов актива со следующими полями для каждого актива:
  • quantityQNT (S) количество (в QNT) актива
  • accountRS (S) адрес аккаунта в формате Reed-Solomon владельца актива
  • unconfirmedQuantityQNT (S) не подтвержденное количество (в QNT) актива
  • asset (S) ID актива
  • account (S) количество аккаунтов владеющих активом
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.12.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAssetAccounts&
    asset=5539238107226883203

Ответ:

{
    "accountAssets": [
        {
            "quantityQNT": "100000000",
            "accountRS": "NXT-JTE5-HB7Y-QPS5-B58MZ",
            "unconfirmedQuantityQNT": "100000000",
            "asset": "5539238107226883203",
            "account": "11514793277306463619"
        }
    ],
    "requestProcessingTime": 19
}

Verified 14-Dec-14

8.13 Get Asset IDs

Возвращает ID всех активов на бирже, в порядке обратном высоте блока создания ордера.

Запрос:

  • requestType это getAssetIds
  • firstIndex индекс (начиная с 0) первого возвращаемого значения ID актива (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения ID актива (опционально)

Ответ:

  • assets (A) массив из ID активов
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.13.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAssetIds&
    firstIndex=15&
    lastIndex=15

Ответ:

{
    "assetIds": [
        "17554243582654188572"
    ],
    "requestProcessingTime": 1
}

Verified 14-Dec-14

8.14 Get Asset Transfers

Возвращает перемещения связанные с заданным активом и/или учетной записью, результат возвращается в порядке обратном высоте блока.

Запрос:

  • requestType это getAssetTransfers
  • asset ID актива (опционально)
  • account ID актива (опционально если asset представлен)
  • firstIndex индекс (начиная с 0) первого возвращаемого перемещения (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого перемещения (опционально)
  • includeAssetInfo установите значение false если необходимо чтобы записи decimals и name были опущены (опционально)

Ответ:

  • transfers (A) является массивом объектов перемещений, со следующим набором полей для каждого перемещения:
  • quantityQNT (S) количество (в QNT) продаваемого актива
  • senderRS (S) адрес отправителя в формате Reed-Solomon
  • assetTransfer (S) ID транзакции перемещения актива
  • sender (S) номер аккаунта отправителя
  • recipientRS (S) адрес получателя в формате Reed-Solomon
  • decimals (N) количество десятичных знаков используемых в активе
  • recipient (S) номер аккаунта получателя
  • name (S) название актива
  • asset (S) ID актива
  • height (N) высота блока перемещения
  • timestamp (N) метка времени блока перемещения (в секундах с момента создания генезисного блока)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.14.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAssetTransfers&
    asset=17554243582654188572&
    lastIndex=0

Ответ:

{
    "transfers": [
        {
            "quantityQNT": "500000",
            "senderRS": "NXT-9K6X-4ZQS-PCQN-465T4",
            "assetTransfer": "15255934090738722602",
            "sender": "2406158154854548637",
            "recipientRS": "NXT-YMEM-ERX3-BFUZ-4MQ4P",
            "decimals": 8,
            "recipient": "3065494931320556947",
            "name": "mgwBTC",
            "asset": "17554243582654188572",
            "height": 287648,
            "timestamp": 31042663
        }
    ],
    "requestProcessingTime": 4
}

Verified 14-Dec-14

8.15 Get Assets

Возвращает информацию о активах, заданных множеством ID активов

Запрос:

  • requestType это getAssets
  • assets ID одного из множества активов
  • assets ID одного из множества активов

  • includeCounts установите false если начало записей, начинающееся с numberOf... должно быть опущено (опционально)

Ответ:

  • assets (A) массив из объектов активов (Подробнее смотри в разделе Get Asset)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.15.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAssets&
    assets=17554243582654188572

Ответ:

{
    "assets": [
        {
            "quantityQNT": "2100000000000000",
            "numberOfAccounts": 31,
            "accountRS": "NXT-3TKA-UH62-478B-DQU6K",
            "decimals": 8,
            "numberOfTransfers": 63,
            "name": "mgwBTC",
            "description": "Production Multigateway BTC (mgwBTC) is backed 100% by...",
            "numberOfTrades": 9,
            "asset": "17554243582654188572",
            "account": "13300069592148796968"
        }
    ],
    "requestProcessingTime": 15
}

Verified 14-Dec-14

8.16 Get Assets By Issuer

Возвращает информацию о активе по нескольким заданным ID учетных записей, в порядке обратном высоте блока создания ордера.

Запрос:

  • requestType это getAssetsByIssuer
  • account один из нескольких ID аккаунта
  • account один из нескольких ID аккаунта

  • firstIndex индекс (начиная с 0) первого возвращаемого значения актива (optional)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения актива (optional)
  • includeCounts установите false если начало записи numberOf... должно быть опущено (опционально)

Ответ:

  • assets (A) массив из объектов актива (Подробнее смотри в разделе Get Asset)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.16.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAssetsByIssuer&
    account=NXT-DE2F-W76R-GL25-HMFPR&
    lastIndex=0

Ответ:

{
    "assets": [
        [
            {
                "quantityQNT": "10000000000",
                "numberOfAccounts": 222,
                "accountRS": "NXT-DE2F-W76R-GL25-HMFPR",
                "decimals": 4,
                "numberOfTransfers": 278,
                "name": "NXTprivacy",
                "description": "NXTprivacy will contain various privacy related projects...",
                "numberOfTrades": 456,
                "asset": "17911762572811467637",
                "account": "18146608053740744717"
            }
        ]
    ],
    "requestProcessingTime": 9
}

Verified 14-Dec-14

8.17 Get Order

Возвращает информацию ордера предложения/спроса по заданному ID ордера.

Запрос:

  • requestType может принимать значение getBidOrder или getAskOrder
  • order ID ордера

Ответ:

  • account (S) номер аккаунта ассоциированный с заданным ордером
  • accountRS (S) адрес аккаунта в формате Reed-Solomon
  • asset (S) ID актива в ордере
  • quantityQNT (S) количество актива в ордере (в QNT)
  • priceNQT (S) цена актива в ордере (в NQT)
  • height (N) высота блока транзакции ордера
  • order (S) ID ордера
  • type (S) тип ордера (bid или ask)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.17.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getBidOrder&
    order=12743274869785967304

Ответ:

{
    "quantityQNT": "1000000",
    "priceNQT": "101",
    "accountRS": "NXT-L6FM-89WK-VK8P-FCRBB",
    "requestProcessingTime": 429,
    "asset": "17554243582654188572",
    "type": "bid",
    "account": "15323192282528158131",
    "order": "12743274869785967304",
    "height": 285577
}

Verified 14-Dec-14

8.18 Get Order IDs

Возвращает список ID (идентификаторов) ордеров предложения/спроса заданного ID актива, в порядке уменьшения цены предложения или увеличения цены спроса.

Запрос:

  • requestType может принимать значение getBidOrderIds или getAskOrderIds
  • asset ID актива
  • firstIndex индекс (начиная с 0) первого возвращаемого значения ID ордера (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения ID ордера (опционально)

Ответ:

  • bidOrderIds bkb askOrderIds (A) массив ID ордеров
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.18.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getBidOrderIds&
    asset=17554243582654188572

Ответ:

{
    "bidOrderIds": [
        "17972270381487138621",
        "8331653287549483600",
        "16386956089071870421",
        "12743274869785967304",
        "3409888667133338290"
    ],
    "requestProcessingTime": 1
}

Verified 14-Dec-14

8.19 Get Orders

Возвращает ордера спроса/предложения для указанного ID актива, в порядке уменьшения цены спроса (bid) или в порядке возрастания цены предложения (ask).

Запрос:

  • requestType может принимать значение getBidOrders или getAskOrders
  • asset ID актива
  • firstIndex индекс (начиная с 0) первого возвращаемого ордера (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого ордера (опционально)

Ответ:

  • bidOrders или askOrders (A) массив состоящий из объектов ордеров (Подробнее смотри в разделе Get Order)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.19.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getBidOrders&
    asset=17554243582654188572&
    firstIndex=3&
    lastIndex=3

Ответ:

{
    "bidOrders": [
        {
            "quantityQNT": "1000000",
            "priceNQT": "101",
            "accountRS": "NXT-L6FM-89WK-VK8P-FCRBB",
            "asset": "17554243582654188572",
            "type": "bid",
            "account": "15323192282528158131",
            "order": "12743274869785967304",
            "height": 285577
        }
    ],
    "requestProcessingTime": 2
}

Verified 14-Dec-14

8.20 Get Order Trades

Get all trades that were executed as a result of a given askOrder and/or bidOrder in reverse block height order.

Request:

  • requestType is getOrderTrades
  • askOrder is an ask order ID (optional)
  • bidOrder is a bid order ID (optional if askOrder provided)
  • firstIndex is a zero-based index to the first trade to retrieve (optional)
  • lastIndex is a zero-based index to the last trade to retrieve (optional)
  • includeAssetInfo is true if the decimals and name fields are to be included (optional)

Ответ: Подробнее смотри в разделе Get Trades.

8.20.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getOrderTrades&
    askOrder=2769987326979385551&
    includeAssetInfo=true

Ответ:

{
    "trades": [
        {
            "seller": "8069635474378047786",
            "quantityQNT": "200",
            "bidOrder": "6083013926058683287",
            "sellerRS": "NXT-5JBC-QQ8M-UAFJ-8UAZZ",
            "buyer": "3617506283101058376",
            "priceNQT": "5000000",
            "askOrder": "2769987326979385551",
            "buyerRS": "NXT-QXCA-TKAH-KK85-5QZE6",
            "decimals": 0,
            "name": "TWT",
            "block": "17820716559461579006",
            "asset": "7496917644161273018",
            "askOrderHeight": 263896,
            "bidOrderHeight": 265168,
            "tradeType": "buy",
            "timestamp": 44288754,
            "height": 265168
        }
    ],
    "requestProcessingTime": 0
}

Verified 11-Jun-15

8.21 Get Trades

Возвращает сделки, связанных с данным активом и/или аккаунтом в порядке обратном высоте блока.

Запрос:

  • requestType это getTrades
  • asset ID актива (опционально)
  • account ID аккаунта (опционально если asset представлен)
  • firstIndex индекс (начиная с 0) первой возвращаемой сделки (опционально)
  • lastIndex индекс (начиная с 0) последней возвращаемой сделки (опционально)
  • includeAssetInfo необходимо указать false если вы хотите чтобы поля decimals и name были опущены (опционально)

Ответ:

  • trades (A) массив из объектов сделок со следующими полями для каждой сделки:
  • seller (S) номер аккаунта продавца
  • quantityQNT (S) количество (в QNT) актива сделки
  • bidOrder (S) ID BID ордера
  • sellerRS (S) адрес аккаунта продавца в формате Reed-Solomon
  • buyer (S) номер аккаунта покупателя
  • priceNQT (S) цена сделки (в NQT, это ask цена для покупки или bid цена для продажи)
  • askOrder (S) ID ASK ордера
  • buyerRS (S) номер аккаунта покупателя в формате Reed-Solomon
  • decimals (N) количество десятичных знаков используемых в активе
  • name (S) Название актива
  • block (S) ID блока сделки
  • asset (S) ID актива
  • askOrderHeight (N) высота блока ask ордера
  • bidOrderHeight (N) высота блока bid ордера
  • tradeType (S) тип сделки (sell или buy, где buy означает что bid появляется после ask, или если в том же блоке, то имеет больший ID сделки)
  • timestamp (N) метка времени блока сделки (в секундах с момента генерации генезисного блока)
  • height (N) высота блока сделки
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.21.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getTrades&
    asset=17554243582654188572&
    lastIndex=0

Ответ:

{
    "trades": [
        {
            "seller": "4012743767778395236",
            "quantityQNT": "922082",
            "bidOrder": "18332182738291742411",
            "sellerRS": "NXT-J356-8B4K-L4DK-533EH",
            "buyer": "17013046603665206934",
            "priceNQT": "19607",
            "askOrder": "5860848661439768841",
            "buyerRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
            "decimals": 8,
            "name": "mgwBTC",
            "block": "15627545821108097361",
            "asset": "17554243582654188572",
            "askOrderHeight": 285964,
            "bidOrderHeight": 285821,
            "tradeType": "sell",
            "timestamp": 30869573,
            "height": 285964
        }
    ],
    "requestProcessingTime": 0
}

Verified 14-Dec-14

8.22 Issue Asset

Создает новый актив для биржи. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это issueAsset
  • name имя актива
  • description это url-кодированное описание актива в кодировке UTF-8 с максимальной длиной в 1000 байт (опционально)
  • quantityQNT общее существующее количество актива (в QNT)
  • decimals количество десятичных знаков используемых у актива (опционально, по умолчанию 0)

Ответ: Подробнее смотри в разделе Create Transaction Response. ID транзакции также ID актива.

8.22.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=issueAsset&
    publicKey=57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c&
    name=SecretCoin&
    description=This+is+SecretCoin&
    quantityQNT=100&
    deadline=60&
    feeNQT=100000000000&
    broad=false

Ответ:

{
    "unsignedTransactionBytes": "021095e5da013c0073080c6a224062660184f10ebb7fb431d459364a12403...",
    "transactionJSON": {
        "senderPublicKey": "73080c6a224062660184f10ebb7fb431d459364a12403320c7f601f9d75cc547",
        "feeNQT": "100000000000",
        "type": 2,
        "version": 1,
        "ecBlockId": "1564408139943737911",
        "attachment": {
            "name": "SecretCoin",
            "description": "This+is+SecretCoin",
            "quantityQNT": "100",
            "version.AssetIssuance": 1,
            "decimals": 0
        },
        "senderRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
        "subtype": 0,
        "amountNQT": "0",
        "sender": "17013046603665206934",
        "ecBlockHeight": 288402,
        "deadline": 60,
        "timestamp": 31122837,
        "height": 2147483647
    },
    "broadcasted": false,
    "requestProcessingTime": 2
}

Verified 14-Dec-14

8.23 Place Order

Разместить ордер (покупка/продажа) на актив. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType может принимать значение placeBidOrder или placeAskOrder
  • asset ID актива по которому выставляется ордер
  • quantityQNT количество (в QNT) актива в ордере
  • priceNQT цена покупки/продажи (в NQT)

Ответ: Подробнее смотри в разделе Create Transaction Response. ID транзакции также ID ордера.

8.23.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=placeBidOrder&
    secretPhrase=IWontTellYou&
    asset=17554243582654188572&
    quantityQNT=1000000&
    priceNQT=100&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "44028b4ddb46e7d4383331425b79019bb0f004f88ede12a5aa66f05c23a75f03",
    "unsignedTransactionBytes": "02135a5ed6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "65713e80be99a927bfa7bb2e9a7b6fbd2f17c226fb956494c68a6d90a8127...",
        "feeNQT": "100000000",
        "type": 2,
        "fullHash": "4f00aef17a397eee25027e834ca765660e4e3f3f1b162468bdac67b315aeb812",
        "version": 1,
        "ecBlockId": "14593256906948324209",
        "signatureHash": "44028b4ddb46e7d4383331425b79019bb0f004f88ede12a5aa66f05c23a75f03",
        "attachment": {
            "quantityQNT": "1000000",
            "priceNQT": "100",
            "asset": "17554243582654188572",
            "version.BidOrderPlacement": 1
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 3,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "ecBlockHeight": 285545,
        "deadline": 60,
        "transaction": "17185236428295897167",
        "timestamp": 30826074,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 8729,
    "transactionBytes": "02135a5ed6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...",
    "fullHash": "4f00aef17a397eee25027e834ca765660e4e3f3f1b162468bdac67b315aeb812",
    "transaction": "17185236428295897167"
}

Verified 14-Dec-14

8.24 Search Assets

Возвращает список активов, имеющие название или описание, которые соответствуют данному запросу, результат возвращается в порядке обратном релевантности.

Запрос:

  • requestType это searchAssets
  • query полный текстовый запрос по полям актива name (S) и description (S) в стандартном синтаксисе Lucene
  • firstIndex индекс (начиная с 0) первого возвращаемого актива (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого актива (опционально)
  • includeCounts установите false вы хотите чтобы записи начинающиеся с numberOf... были опущены (опционально)

Ответ:

  • assets (A) массив из объектов активов (Подробнее смотри в разделе Get Asset)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

8.24.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=searchAssets&
    query=assets AND production

Ответ:

{
    "assets": [
        {
            "quantityQNT": "2100000000000000",
            "numberOfAccounts": 37,
            "accountRS": "NXT-3TKA-UH62-478B-DQU6K",
            "decimals": 8,
            "numberOfTransfers": 84,
            "name": "mgwBTC",
            "description": "Production Multigateway BTC (mgwBTC) is backed 100% by...",
            "numberOfTrades": 15,
            "asset": "17554243582654188572",
            "account": "13300069592148796968"
        }
    ],
    "requestProcessingTime": 96
}

Verified 14-Dec-14

8.25 Transfer Asset

Передает заданное количество актива от одного аккаунта другому. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это transferAsset
  • recipient ID аккаунта получателя
  • recipientPublicKey публичный ключ аккаунта получателя (опционально, повышает безопасность недавно созданного аккаунта)
  • asset ID передаваемого актива
  • quantityQNT количество (в QNT) актива передаваемого актива

Ответ: Подробнее смотри в разделе Create Transaction Response. ID транзакции также ID передаваемого актива.

8.25.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=transferAsset&
    secretPhrase=IWontTellYou&
    recipient=NXT-4VNQ-RWZC-4WWQ-GVM8S&
    asset=17554243582654188572&
    quantityQNT=1000&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "f622557588bc82942984286e431c978e687783b32db6a68a1c554b2e11349751",
    "unsignedTransactionBytes": "0211c9ebda013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "33d0fccf1f19d18b4ca97d2636cf62f7a801c07628d1bbb1d6084dc3ca658d...",
        "feeNQT": "100000000",
        "type": 2,
        "fullHash": "c8f25b15b48fb5efd3341fb369627d00f8fefb59dc18016ba0c482b6de7cad59",
        "version": 1,
        "ecBlockId": "3925493493266246517",
        "signatureHash": "f622557588bc82942984286e431c978e687783b32db6a68a1c554b2e11349751",
        "attachment": {
            "version.AssetTransfer": 1,
            "quantityQNT": "1000",
            "asset": "17554243582654188572"
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 1,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
        "recipient": "17013046603665206934",
        "ecBlockHeight": 288416,
        "deadline": 60,
        "transaction": "17272869949464638152",
        "timestamp": 31124425,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 4968,
    "transactionBytes": "0211c9ebda013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473b...",
    "fullHash": "c8f25b15b48fb5efd3341fb369627d00f8fefb59dc18016ba0c482b6de7cad59",
    "transaction": "17272869949464638152"
}

Verified 14-Dec-14

9 Операции с Блоками

9.1 Get Block

Возвращает объект блока по заданному ID или высоте блока.

Запрос:

  • requestType это getBlock
  • block ID блока (опционально)
  • height высота блока (опционально если block задан)
  • timestamp метка времени (в секундах с основания генезисного блока) блока (опционально если height задано)
  • includeTransactions установите true чтобы включить детальную информацию о транзакции (опционально)

Примечание: block замещает height, которая замещает timestamp.

Ответ:

  • previousBlockHash (S) 32-байтный хеш предыдущего блока
  • payloadLength (N) длина (в байтах) всех транзакций, включенных в блок
  • totalAmountNQT (S) общая сумма (в NQT) транзакций в блоке
  • generationSignature (S) 32-байтовая сгенерированная подпись, сгенерировавшего аккаунта
  • generator (S) номер сгенерировавшего аккаунта
  • generatorPublicKey (S) 32-байтовый открытый сгенерировавшего аккаунта
  • baseTarget (S) базовая цель для следующей генерации блока
  • payloadHash (S) 32-байтовый хеш полезной нагрузки (все транзакции)
  • generatorRS (S) адрес сгенерировавшего аккаунта в формате Reed-Solomon
  • nextBlock (S) ID следующего блока
  • numberOfTransactions (N) число транзакций в блоке
  • blockSignature (S) 64-байтовая подпись блока
  • transactions (A) массив ID транзакций или объектов транзакции (если includeTransactions задан, подробнее смотри в разделе Get Transaction)
  • version (N) - версия блока
  • totalFeeNQT (S) общая сумма комиссии (в NQT) за транзакций в блоке
  • previousBlock (S) ID предыдущего блока
  • cumulativeDifficulty (S) совокупная сложность для генерации следующего блока
  • block (S) ID блока
  • height (N) высота блока (начиная с 0)
  • timestamp (N) является меткой времени (в секундах начиная с блока происхождения) блока
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

9.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getBlock&
    block=8455642159445842600

Ответ:

{
    "previousBlockHash": "c0574d7a7b8497373dbead497c2dc7f60fdcfc8c5a9fcb48f7d373acc9bbb099",
    "payloadLength": 1189,
    "totalAmountNQT": "100000000",
    "generationSignature": "c5098d37267bc71134fc8572a87b4af8727a2e5139d60fe8833fab98af22244a",
    "generator": "11693867635361772359",
    "generatorPublicKey": "fbb72a280228af5c8c74c7c754a290e1539f839553c00bc560cac7bfdb324a7c",
    "baseTarget": "1530224444",
    "payloadHash": "633992be640a593ba04e31ca4028deed70bbf47cff333e2a0372a4e2a4aba205",
    "generatorRS": "NXT-TWU9-P3E4-HCDM-CQ9L6",
    "nextBlock": "5937170741469897491",
    "requestProcessingTime": 2,
    "numberOfTransactions": 6,
    "blockSignature": "ff65a82e385c135cf9bd5be0861e9e5d3d3174fbd993e5b7f57935ec4...",
    "transactions": [
        "15184285173972564233",
        "15200280108574630445",
        "15200507403046301754",
        "15900338016714606285",
        "17881859777840687131",
        "18361738217269620028"
    ],
    "version": 3,
    "totalFeeNQT": "600000000",
    "previousBlock": "4005816059437078464",
    "block": "8455642159445842600",
    "height": 275730,
    "timestamp": 29797208
}

Verified 14-Dec-14

9.2 Get Block ID

Возвращает ID блока по заданной высоте.

Запрос:

  • requestType это getBlockId
  • height высота блока

Ответ:

  • block (S) ID блока
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

9.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getBlockId&
    height=0

Ответ:

{
    "block": "2680262203532249785",
    "requestProcessingTime": 1
}

Verified 14-Dec-14

9.3 Get Blocks

Возвращает блоки из blockchain в порядке обратном высоте блока.

Запрос:

  • requestType это getBlocks
  • firstIndex первый блок который будет возвращен запросом (опционально, по умолчанию - нулевой или последний блок в blockchain)
  • lastIndex последний блок который будет возвращен запросом (опционально, по умолчанию это firstIndex + 99)
  • includeTransactions чтобы включить в ответ детали транзакции - установите в true(опционально)

Ответ:

  • blocks (A) массив из блоков (Подробнее смотри в разделе Get Block)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

9.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getBlocks&
    lastIndex=1

Ответ:

{
    "blocks": [
        {
            "previousBlockHash": "f88c75a36317e1795348330cb9a944f33153b517ebdf05d9f3f9a606e997618d",
            "payloadLength": 981,
            "totalAmountNQT": "0",
            "generationSignature": "02f7462b62270c0028c379d838d3a192cf0b782995f3bb1929a5378d26e7e8a9",
            "generator": "2218289317977832095",
            "generatorPublicKey": "98ccf5d5173b13e4c9eab2631372f61ce8ba506db559d73b285073a689872e75",
            "baseTarget": "151761236",
            "payloadHash": "82f8c8ca1f8f2252172ed1e9836d5228432fcb18aecfa7d55a119efcd242321c",
            "generatorRS": "NXT-TGNZ-E8VK-69EX-3L9LX",
            "numberOfTransactions": 5,
            "blockSignature": "76a3f7f966256c4985262fb4622190b2b9a19b900f6ce443ab7d581e3176c...",
            "transactions": [
                "10545999940082849455",
                "16751328983055099280",
                "1257496316971695605",
                "2048859884870801838",
                "5105170273384355243"
            ],
            "version": 3,
            "totalFeeNQT": "500000000",
            "previousBlock": "8782326465060769016",
            "block": "7299310714263322546",
            "height": 281683,
            "timestamp": 30416681
        },
        {
            "previousBlockHash": "edc2d65d24883b9b32c46da4eec3792a69a5ff9a9b1e629c4e7e0224432c87c9",
            "payloadLength": 0,
            "totalAmountNQT": "0",
            "generationSignature": "8c4944c7a9ef5700d1b89660fdf83bcbd3dbbfbe191fef005d0f248a573816fe",
            "generator": "15766845356521829337",
            "generatorPublicKey": "11636697faf4ade736cedf6c528bec0142353c4d93fce05cdb818c49e0390422",
            "baseTarget": "303522472",
            "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            "generatorRS": "NXT-2EYT-C522-VL6G-FQSMP",
            "nextBlock": "7299310714263322546",
            "numberOfTransactions": 0,
            "blockSignature": "90464d183ed01cb0930ef527e746eaa092d1558697c369cc9246add5f6eec...",
            "transactions": [],
            "version": 3,
            "totalFeeNQT": "0",
            "previousBlock": "11185683789279314669",
            "block": "8782326465060769016",
            "height": 281682,
            "timestamp": 30416671
        }
    ],
    "requestProcessingTime": 2
}

Verified 14-Dec-14

9.4 Get Economic Cluster Block

Возвращает блок данных EC.

Запрос:

  • requestType это getECBlock
  • timestamp метка времени (в секундах от времени создания генезисного блока) EC блока (опционально, по умолчанию (или 0) это текущее время)

Примечание: Если timestamp превышает более чем на 15 секунд метку времени последнего блока в blockchain, будет возвращена ошибка с errorCode 4.

Ответ:

  • ecBlockHeight (N) высота EC блока
  • ecBlockId (S) ID EC блока
  • timestamp (N) метка времени (в секундах с момента создания генезисного блока) EC блока
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

9.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getECBlock

Ответ:

{
    "ecBlockHeight": 281777,
    "requestProcessingTime": 2,
    "ecBlockId": "6565813579609649593",
    "timestamp": 30427868
}

Verified 14-Dec-14

10 Операции в Магазине Цифровых Товаров

В Клиентском интерфейсе Nxt, Магазин Цифровых Товаров (DGS) называется Marketplace.

10.1 DGS Delisting

Снятие с продажи ранее выставленного товара на DGS. Только POST.

Request: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType is dgsDelisting
  • goods ID товара

Ответ: Подробнее смотри в разделе Create Transaction Response.

10.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dgsDelisting&
    goods=11813734897437346473
    secretPhrase=IWontTellYou&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "87dd2aa00690acaa5da4e8cd9db6ab94b5ed8bf0f8fe2c2ba6a39c57d3073105",
    "unsignedTransactionBytes": "03111852e2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "39ee52204d0a32c0bbd0e4bc6a6fb52299cd7d16ab74e9a040f857d3b1c3e...",
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "40e64c357e240f9b7ca5780e757e34d48a58ae93eeb19e62d020d5719b43e2b6",
        "version": 1,
        "ecBlockId": "5345754442518111082",
        "signatureHash": "87dd2aa00690acaa5da4e8cd9db6ab94b5ed8bf0f8fe2c2ba6a39c57d3073105",
        "attachment": {
            "version.DigitalGoodsDelisting": 1,
            "goods": "11813734897437346473"
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 1,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "ecBlockHeight": 292903,
        "deadline": 60,
        "transaction": "11173189325008201280",
        "timestamp": 31609368,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 5188,
    "transactionBytes": "03111852e2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "40e64c357e240f9b7ca5780e757e34d48a58ae93eeb19e62d020d5719b43e2b6",
    "transaction": "11173189325008201280"
}

Verified 14-Dec-14

10.2 DGS Delivery

Доставка товара. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это dgsDelivery
  • purchase ID ордера поставки
  • discountNQT скидка (в NQT) от цены продажи (опционально, по умолчанию 0)
  • goodsToEncrypt товар, текст или шестнадцатеричная строка, которая будет зашифрована (опционально, если goodsData представлена)
  • goodsIsText установите в false если goodsToEncrypt это шестнадцатеричная строка (опционально)
  • goodsData зашифрованный с помощью алгоритма AES (используя Encrypt Message To) goodsToEncrypt (требуется только если secretPhrase опущена)
  • goodsNonce уникальная для данного случая информация ассоциированный с зашифрованными данными (требуется только если secretPhrase опущена)

Ответ: Подробнее смотри в разделе Create Transaction Response.

10.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dgsDelivery&
    purchase=3723760852542296589&
    goodsToEncrypt=Download Code.&
    secretPhrase=IWontTellYou&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "f3f1f1bf30c7a6f5a7776aa23502dfe5240efe0d5c016760f8e8a152c4eb1b1b",
    "unsignedTransactionBytes": "0315b20fe1013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "b96c42161ce38177168de5a8906ce747a5415017df5b16cdce1c015cb6e1f10b...",
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "349926ea025b627117c05fbe3ff298e97a8efdb07f7ae552b5a91e7112c5b82b",
        "version": 1,
        "ecBlockId": "15813950788992376142",
        "signatureHash": "f3f1f1bf30c7a6f5a7776aa23502dfe5240efe0d5c016760f8e8a152c4eb1b1b",
        "attachment": {
            "goodsIsText": true,
            "discountNQT": "0",
            "purchase": "3723760852542296589",
            "goodsData": "aef91bfe543844964b0dadc51c6fe4c624b6b0c72c23c5c61f7e626f51e15...",
            "version.DigitalGoodsDelivery": 1,
            "goodsNonce": "4cb474ec53a590c6fd20d050c429d009ddefd286b2782eb3a0782ae45c2bbbbd"
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 5,
        "amountNQT": "0",
        "sender": "15323192282528158131",The transaction ID is also the order ID.
        "recipientRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
        "recipient": "7580519603555678830",
        "ecBlockHeight": 292069,
        "deadline": 60,
        "transaction": "8170192742079961396",The transaction ID is also the order ID.
        "timestamp": 31526834,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 8832,
    "transactionBytes": "0315b20fe1013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "349926ea025b627117c05fbe3ff298e97a8efdb07f7ae552b5a91e7112c5b82b",
    "transaction": "8170192742079961396"
}

Verified 14-Dec-14

10.3 DGS Feedback

Оставить отзыв о купленном товаре после его поставки. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это dgsFeedback
  • purchase ID ордера на поставку
  • message не зашифрованный (публичный) отзыв, текст длиной до 1000 байт

Примечание: параметр незашифрованное message (сообщение) используется для публикации публичного отзыва, но в дополнение или вместо, зашифрованное сообщение может быть использовано для личной обратной связи с продавцом и/или зашифрованное сообщение может быть отправлено самому себе (покупатель), хотя текущий клиент NRS не поддерживает не публичных отзывов.

Ответ: Подробнее смотри в разделе Create Transaction Response.

10.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dgsFeedback&
    purchase=10234639413366748292&
    secretPhrase=IWontTellYou&
    feeNQT=100000000&
    deadline=60&
    message=Thank You!

Ответ:

{
    "signatureHash": "bf31e4e3b2037bfe223efd72519e3a2d25cd1e0dc1a62e3eeefe59179e16a7a4",
    "unsignedTransactionBytes": "0316a463e2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "a3ee76ce4bec0328fe5cfc1a2adfc229a8c9959a81b7912664de51156987c...",
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "491d94b9031b7a7a32d9ab5d0491b81364941eb080ee9029de58cb6ffa0161f6",
        "version": 1,
        "ecBlockId": "5484311742753527844",
        "signatureHash": "bf31e4e3b2037bfe223efd72519e3a2d25cd1e0dc1a62e3eeefe59179e16a7a4",
        "attachment": {
            "purchase": "10234639413366748292",
            "version.Message": 1,
            "messageIsText": true,
            "version.DigitalGoodsFeedback": 1,
            "message": "Thank you!"
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 6,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
        "recipient": "7580519603555678830",
        "ecBlockHeight": 292938,
        "deadline": 60,
        "transaction": "8825396122598251849",
        "timestamp": 31613860,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 9343,
    "transactionBytes": "0316a463e2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "491d94b9031b7a7a32d9ab5d0491b81364941eb080ee9029de58cb6ffa0161f6",
    "transaction": "8825396122598251849"
}

Verified 14-Dec-14

10.4 DGS Listing

Размещение товара в DGS для продажи с созданием листинг транзакции. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это dgsListing
  • name название продукта, длиной до 100 символов
  • description описание продукта длиной до 1000 символов
  • tags тэги - до трёх, разделенных запятой, слов описывающих продукт, длиной до 100 символов (опционально)
  • quantity количество товара для продажи
  • priceNQT цена продукта (в NQT)

Ответ: Подробнее смотри в разделе Create Transaction Response. ID транзакции также ID товара.

10.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dgsListing&
    secretPhrase=IWontTellYou&
    name=Test Product&
    description=Testing the DGS.
    tags=test, product, tag, extra&
    quantity=3&
    priceNQT=100000000&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "565bc0a6140ae1331cd5db009fbd9da164d8802330939ef40204a9bc343b3149",
    "unsignedTransactionBytes": "031092aedf013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "465ed3dfef9a02fc97fc18a6f83bb9f07c285aef41ff78c957d59cda2972ba...",
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "a98a63204cd1f2a3304cee79776854f290f0472883c576056fec16a23efa90df",
        "version": 1,
        "ecBlockId": "4480409615309425420",
        "signatureHash": "565bc0a6140ae1331cd5db009fbd9da164d8802330939ef40204a9bc343b3149",
        "attachment": {
            "priceNQT": "100000000",
            "quantity": 3,
            "name": "Test Product",
            "description": "Testing the DGS.",
            "version.DigitalGoodsListing": 1,
            "tags": "test, product, tag, extra"
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 0,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "ecBlockHeight": 291240,
        "deadline": 60,
        "transaction": "11813734897437346473",
        "timestamp": 31436434,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 8958,
    "transactionBytes": "031092aedf013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473b...",
    "fullHash": "a98a63204cd1f2a3304cee79776854f290f0472883c576056fec16a23efa90df",
    "transaction": "11813734897437346473"
}

Verified 14-Dec-14

10.5 DGS PriceChange

Изменение цены выставленного на продажу товара. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это dgsPriceChange
  • goods ID товара
  • priceNQT новая цена товара

Ответ: Подробнее смотри в разделе Create Transaction Response.

10.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dgsPriceChange&
    goods=11813734897437346473&
    priceNQT=200000000&
    secretPhrase=IWontTellYou&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "aad88476935eda8ca3a9190163b83106e6ca95733ddfa274d29a0378d773cc3c",
    "unsignedTransactionBytes": "0312cebbdf013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "533f9c330100cab8a7a0f9375b49a09f6432b0e029660ab715a728ac75e6c2...",
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "1964e4fe11f4a00a96c79e274f9da21f64d7fe10ed77a154975b92d3c65f1287",
        "version": 1,
        "ecBlockId": "14411471768450948944",
        "signatureHash": "aad88476935eda8ca3a9190163b83106e6ca95733ddfa274d29a0378d773cc3c",
        "attachment": {
            "goods": "11813734897437346473",
            "priceNQT": "200000000",
            "version.DigitalGoodsPriceChange": 1
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 2,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "ecBlockHeight": 291259,
        "deadline": 60,
        "transaction": "765880294780986393",
        "timestamp": 31439822,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 6444,
    "transactionBytes": "0312cebbdf013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "1964e4fe11f4a00a96c79e274f9da21f64d7fe10ed77a154975b92d3c65f1287",
    "transaction": "765880294780986393"
}

Verified 14-Dec-14

10.6 DGS Purchase

Покупка товара выставленного на продажу. Только POST.

Request: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это dgsPurchase
  • goods ID продукта
  • priceNQT цена продукта
  • quantity количество приобретаемого товара
  • deliveryDeadlineTimestamp метка времени (в секундах с момента создания генезисного блока) к которой поставка продукта должна произойти.

Ответ: Подробнее смотри в разделе Create Transaction Response. ID транзакции также ID ордера на покупку.

10.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dgsPurchase&
    goods=1587116104511359906&
    quantity=1&
    deliveryDeadlineTimestamp=31800000&
    secretPhrase=IWontTellYou&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "03e112d8707ae33ec37ff4405f31920c0e67c58439e33033c248b3eaca81d2c3",
    "unsignedTransactionBytes": "0314805be2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "a2739ef63024d9d3c61bebbb2692e7a2092666e13fc380c2e8b29c3a3fc24...",
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "84f4ef2d52be088e011e5b7857fbab88665918e0df02102a8333aee53c3bb88b",
        "version": 1,
        "ecBlockId": "3186563001195424357",
        "signatureHash": "03e112d8707ae33ec37ff4405f31920c0e67c58439e33033c248b3eaca81d2c3",
        "attachment": {
            "goods": "1587116104511359906",
            "priceNQT": "100000000",
            "quantity": 1,
            "deliveryDeadlineTimestamp": 31800000,
            "version.DigitalGoodsPurchase": 1
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 4,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
        "recipient": "7580519603555678830",
        "ecBlockHeight": 292925,
        "deadline": 60,
        "transaction": "10234639413366748292",
        "timestamp": 31611776,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 5536,
    "transactionBytes": "0314805be2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "84f4ef2d52be088e011e5b7857fbab88665918e0df02102a8333aee53c3bb88b",
    "transaction": "10234639413366748292"
}

Verified 14-Dec-14

10.7 DGS Quantity Change

Изменение количества выставленного на продажу товара. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это dgsQuantityChange
  • goods ID товара
  • deltaQuantity изменение количества товара для продажи (используйте отрицательные числа для уменьшения количества)

Ответ: Подробнее смотри в разделе Create Transaction Response.

10.7.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dgsQuantityChange&
    goods=11813734897437346473&
    deltaQuantity=-1&
    secretPhrase=IWontTellYou&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "5c60fc94452980f88423c3a16a74d49209d246d0f7454024c87cc76ea3221500",
    "unsignedTransactionBytes": "031334b7df013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "7eaf8e48a780f51aa7e01c01091c9388b72a1bf075dddbd3594d55ad169272...",
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "f3cd9046bba3706dd6f63cf387f23c7c29532ff15e3423f57900613c844a646f",
        "version": 1,
        "ecBlockId": "14589429051005044326",
        "signatureHash": "5c60fc94452980f88423c3a16a74d49209d246d0f7454024c87cc76ea3221500",
        "attachment": {
            "goods": "11813734897437346473",
            "version.DigitalGoodsQuantityChange": 1,
            "deltaQuantity": -1
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 3,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "ecBlockHeight": 291249,
        "deadline": 60,
        "transaction": "7885982972263845363",
        "timestamp": 31438644,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 7474,
    "transactionBytes": "031334b7df013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "f3cd9046bba3706dd6f63cf387f23c7c29532ff15e3423f57900613c844a646f",
    "transaction": "7885982972263845363"
}

Verified 14-Dec-14

10.8 DGS Refund

Возврат покупки. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это dgsRefund
  • purchase ID (идентификатор) заказа на закупку
  • refundNQT сумма (в NQT) возврата

Ответ: Подробнее смотри в разделе Create Transaction Response.

10.8.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=dgsRefund&
    purchase=3723760852542296589&
    refundNQT=100000000&
    secretPhrase=IWontTellYou&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "dafa980759db6bd6e5f11aa7bdc1cff1bb201be750328c397870f1758cef975c",
    "unsignedTransactionBytes": "0317944ee2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "43a90c1f0dde1bca84623e69b0abe0284883600d7bfb5286b3489a9ee417...",
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "64c2af2811da3306f4671002ed1f12655fca1937a0b68164da2a71f3ee63adce",
        "version": 1,
        "ecBlockId": "11418000967717599433",
        "signatureHash": "dafa980759db6bd6e5f11aa7bdc1cff1bb201be750328c397870f1758cef975c",
        "attachment": {
            "purchase": "3723760852542296589",
            "version.DigitalGoodsRefund": 1,
            "refundNQT": "100000000"
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 7,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
        "recipient": "7580519603555678830",
        "ecBlockHeight": 292899,
        "deadline": 60,
        "transaction": "446940555271717476",
        "timestamp": 31608468,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 10509,
    "transactionBytes": "0317944ee2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b...",
    "fullHash": "64c2af2811da3306f4671002ed1f12655fca1937a0b68164da2a71f3ee63adce",
    "transaction": "446940555271717476"
}

Verified 14-Dec-14

10.9 Get DGS Expired Purchases

Get purchase orders which have expired without being delivered, given a seller ID, in reverse chronological order.

Request:

  • requestType is getDGSExpiredPurchases
  • seller is the account ID of the product seller
  • firstIndex is a zero-based index to the first purchase order to retrieve (optional)
  • lastIndex is a zero-based index to the last purchase order to retrieve (optional)

Ответ:

  • purchases (A) массив из ордеров покупки/заказов на поставку (Подробнее смотри в разделе Get DGS Purchase)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.9.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSExpiredPurchases&
    seller=NXT-XK4R-7VJU-6EQG-7R335

Ответ:

{
    "purchases": [
        {
            "seller": "5873880488492319831",
            "priceNQT": "1000000000",
            "quantity": 1,
            "deliveryDeadlineTimestamp": 44955165,
            "buyerRS": "NXT-XK4R-7VJU-6EQG-7R335",
            "pending": false,
            "purchase": "17272258199467687054",
            "name": "MyProduct",
            "goods": "4830545483228225683",
            "sellerRS": "NXT-XK4R-7VJU-6EQG-7R335",
            "buyer": "5873880488492319831",
            "timestamp": 44397533
        }
    ],
    "requestProcessingTime": 1
}

Verified 11-Jun-15

10.10 Get DGS Good

Получить данные о DGS товаре по указанному ID товара.

Запрос:

  • requestType это getDGSGood
  • goods ID товара
  • includeCounts установите в false если необходимо пропустить начало записей numberOf... (опционально)

Ответ:

  • seller (S) ID аккаунта продавца
  • quantity (N) количество товара, оставшегося для продажи
  • goods (S) ID товара
  • description (S) описание товара
  • sellerRS (S) адрес аккаунта продавца в формате Reed-Solomon
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • delisted (B) вернет true если товар был снят с продажи, false в противном случае
  • parsedTags (A) массив содержащий до трех строк тэгов, полученных из поля tags
  • tags (S) список разделенных запятой значений тегов, заданных продавцом, при публикации товара
  • priceNQT (S) текущая цена товара
  • numberOfPublicFeedbacks (N) количество публичных отзывов данных товару
  • name (S) Название товара
  • numberOfPurchases (N) количество поставок товара
  • timestamp (N) метка времени (в секундах с момента создания генезисного блока) публикации товара

10.10.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSGood&
    goods=11813734897437346473

Ответ:

{
    "seller": "15323192282528158131",
    "quantity": 3,
    "goods": "11813734897437346473",
    "description": "Testing the DGS.",
    "sellerRS": "NXT-L6FM-89WK-VK8P-FCRBB",
    "requestProcessingTime": 1,
    "delisted": false,
    "parsedTags": [
        "test",
        "product",
        "tag"
    ],
    "tags": "test, product, tag, extra",
    "priceNQT": "100000000",
    "numberOfPublicFeedbacks": 0,
    "name": "Test Product",
    "numberOfPurchases": 0,
    "timestamp": 31436434
}

Verified 14-Dec-14

10.11 Get DGS Goods

Получить товары для продажи в DGS, в порядке обратном дате их публикации если продавец не задан, иначе в алфавитном порядке по названию продуктов.

Запрос:

  • requestType это getDGSGoods
  • seller ID аккаунта продавца товара (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого товара (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого товара (опционально)
  • inStockOnly установите false если продукты отсутствующие на складе (нулевое количество) также возвращались запросом (опционально)
  • hideDelisted установите true чтобы снятые с публикации товары были опущены (опционально)
  • includeCounts установите false если необходимо чтобы поля начинающиеся с numberOf... были опущены (опционально)

Примечание:, Если ни один из опциональных параметров не задан, обработка всех товаров в blockchain, может занять много времени.

Ответ:

  • goods (A) массив товаров (подробнее смотри в разделе Get DGS Good)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.11.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSGoods&
    seller=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "goods": [
        {
            "seller": "15323192282528158131",
            "quantity": 2,
            "goods": "11813734897437346473",
            "description": "Testing the DGS.",
            "sellerRS": "NXT-L6FM-89WK-VK8P-FCRBB",
            "delisted": false,
            "parsedTags": [
                "test",
                "product",
                "tag"
            ],
            "tags": "test, product, tag, extra",
            "priceNQT": "200000000",
            "numberOfPublicFeedbacks": 0,
            "name": "Test Product",
            "numberOfPurchases": 0,
            "timestamp": 31436434
        }
    ],
    "requestProcessingTime": 46
}

Verified 14-Dec-14

10.12 Get DGS Goods Count

Возвращает количество товаров для продажи принадлежащих указанному продавцу или всем продавцам.

Запрос:

  • requestType это getDGSGoodsCount
  • seller ID аккаунта продавца (опционально, по умолчанию это все продавцы)
  • inStockOnly установите false если продукты которые закончились на складе (нулевое количество) не должны включаться в результат (опционально)

Ответ:

  • numberOfGoods (N) количество товаров продаваемых продавцом
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: поле numberOfGoods относится к числу различных товаров для продажи, независимо от количества каждого из них.

10.12.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSGoodsCount&
    seller=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "numberOfGoods": 1,
    "requestProcessingTime": 2
}

Verified 14-Dec-14

10.13 Get DGS Goods Purchase Count

Возвращает количество завершенных сделок по заданному ID товара.

Запрос:

  • requestType это getDGSGoodsPurchaseCount
  • goods ID товара
  • withPublicFeedbacksOnly установите true, чтобы заказы на закупку без публичных отзывов должны быть опущены (опционально)
  • completed установите true, если необходимо получить только завершенные заказы на покупку (опционально)

Ответ:

  • numberOfPurchases (N) количество завершенных сделок
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.13.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSGoodsPurchaseCount&
    goods=11813734897437346473

Ответ:

{
    "numberOfPurchases": 1,
    "requestProcessingTime": 1
}

Verified 14-Dec-14

10.14 Get DGS Goods Purchases

Возвращает завершены продажи заданного ID товара, в обратном хронологическом порядке.

Запрос:

  • requestType это getDGSGoodsPurchases
  • goods ID товара
  • firstIndex индекс (начиная с 0) первого возвращаемого ордера на поставку (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого ордера на поставку (опционально)
  • withPublicFeedbacksOnly установите true если ордера на поставку без публичных отзывов должны быть опущены (опционально)
  • completed установите true если должны отображаться только завершенные ордера на поставку (опционально)

Ответ:

  • purchases (A) массив ордеров продаж (Подробнее смотри в разделе Get DGS Purchase)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.14.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSGoodsPurchases&
    goods=11813734897437346473

Ответ:

{
    "purchases": [
        {
            "seller": "15323192282528158131",
            "quantity": 2,
            "pending": false,
            "purchase": "3723760852542296589",
            "goods": "11813734897437346473",
            "sellerRS": "NXT-L6FM-89WK-VK8P-FCRBB",
            "buyer": "7580519603555678830",
            "priceNQT": "200000000",
            "deliveryDeadlineTimestamp": 31600000,
            "goodsIsText": false,
            "buyerRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
            "name": "Test Product",
            "goodsData": {
                "data": "aef91bfe543844964b0dadc51c6fe4c624b6b0c72c23c5c61f7e626f51e15...",
                "nonce": "4cb474ec53a590c6fd20d050c429d009ddefd286b2782eb3a0782ae45c2bbbbd"
            },
            "timestamp": 31520720
        }
    ],
    "requestProcessingTime": 305
}

Verified 14-Dec-14

10.15 Get DGS Pending Purchases

Возвращает список ожидающих заказов, для указанного ID продавца, в обратном хронологическом порядке.

Запрос:

  • requestType это getDGSPendingPurchases
  • seller ID аккаунта продавца
  • firstIndex индекс (начиная с 0) первого возвращаемого заказа на покупку (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого заказа на покупку (опционально)

Ответ:

  • purchases (A) массив ожидающих ордеров на закупку (Подробнее смотри в разделе Get DGS Purchase)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.15.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSPendingPurchases&
    seller=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "purchases": [
        {
            "seller": "15323192282528158131",
            "priceNQT": "200000000",
            "quantity": 2,
            "deliveryDeadlineTimestamp": 31600000,
            "buyerRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
            "pending": true,
            "purchase": "3723760852542296589",
            "name": "Test Product",
            "goods": "11813734897437346473",
            "sellerRS": "NXT-L6FM-89WK-VK8P-FCRBB",
            "buyer": "7580519603555678830",
            "timestamp": 31520720
        }
    ],
    "requestProcessingTime": 1
}

Verified 14-Dec-14

10.16 Get DGS Purchase

Возвращает ордер на покупку по заданному ID ордера на покупку.

Запрос:

  • requestType это getDGSPurchase
  • purchase ID ордера на покупку

Ответ:

  • seller (S) номер аккаунта продавца
  • quantity (N) количество товара которое будет куплено
  • feedbackNotes (A) массив AES зашифрованных объектов, содержащие поля data (S) и nonce (S), в обратном хронологическом порядке, если применимо
  • publicFeedbacks (A) массив строк с отзывами в обратном хронологическом порядке, если применимо
  • pending (B) true если deliveryDeadline не прошел, false в противном случае
  • purchase (S) ID ордера поставки
  • goods (S) ID товара
  • sellerRS (S) аккаунт продавца в формате Reed-Solomon
  • buyer (S) номер аккаунта покупателя
  • priceNQT (S) цена товара (в NQT)
  • deliveryDeadlineTimestamp (N) метка времени (в секундах от времени создания генезисного блока) к которой товар должен быть доставлен
  • goodsIsText (B) false если сообщение это шестнадцатеричная строка, в противном случае сообщение это текст (опционально)
  • buyerRS (S) аккаунт покупателя в формате Reed-Solomon
  • refundNQT (S) сумма возврата (в NQT), если применимо
  • name (S) название продукта
  • goodsData (O) объект с двумя полями data (S) (зашифрованная шестнадцатеричная строка товара) и nonce (S), если продукт был поставлен
  • timestamp (N) метка времени (в секундах от времени создания генезисного блока) ордера поставки
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.16.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSPurchase&
    purchase=10234639413366748292

Ответ:

{
    "seller": "7580519603555678830",
    "quantity": 1,
    "feedbackNotes": [
        {
            "data": "7086a82f4da0708d4eaa9b16d5fc5a25c556596ea29d957d0a1dddd0a482c...",
            "nonce": "c521481ce67f7778c41c6716806047d4ea641005392cd7e5ce8d20c49623dad8"
        }
    ],
    "publicFeedbacks": [
        "Thank you again!",
        "Thank you!"
    ],
    "pending": false,
    "purchase": "10234639413366748292",
    "goods": "1587116104511359906",
    "sellerRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
    "requestProcessingTime": 1,
    "buyer": "15323192282528158131",
    "priceNQT": "100000000",
    "deliveryDeadlineTimestamp": 31800000,
    "goodsIsText": false,
    "buyerRS": "NXT-L6FM-89WK-VK8P-FCRBB",
    "discountNQT": "100000000",
    "name": "Test Product",
    "goodsData": {
        "data": "5f4868022381aa9532614a7aae1600e59e84c80571add107dabca891df97e7...",
        "nonce": "c017b846de4375741ebc9f3bff894270d218ff4090a66dfd505770ccdc2f54bd"
    },
    "timestamp": 31611776
}

Verified 14-Dec-14

10.17 Get DGS Purchase Count

Возвращает количество ордеров на поставки по ID продавцов и/или покупателей, или все ордера одним списком.

Запрос:

  • requestType это getDGSPurchaseCount
  • seller ID аккаунта продавца (опционально, по умолчанию все продавцы)
  • buyer ID аккаунта покупателя (опционально, по умолчанию все покупатели)
  • withPublicFeedbacksOnly установите true если необходимо опустить все ордера без публичного отзыва (опционально)
  • completed установите true если необходимо получить только завершенные сделки (опционально)

Ответ:

  • numberOfPurchases (N) число ордеров на поставку, связанных с продавцом и/или покупателем
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.17.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSPurchaseCount&
    seller=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "numberOfPurchases": 2,
    "requestProcessingTime": 1
}

Verified 24-Nov-14

10.18 Get DGS Purchases

Возвращает ордера на поставку, по заданному ID продавца и/или покупателя в обратном хронологическом порядке.

Запрос:

  • requestType это getDGSPurchases
  • seller ID аккаунта продавца (опционально)
  • buyer ID аккаунта покупателя (опционально если seller задано)
  • firstIndex индекс (начиная с 0) первого возвращаемого ордера на поставку (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого ордера на поставку (опционально)
  • withPublicFeedbacksOnly установите true ордера на поставку без публичных отзывов должны быть опущены (опционально)
  • completed установите true если необходимо получить только завершенные ордера на поставку (опционально)

Ответ:

  • purchases (A) массив ордеров поставки (Подробнее смотри в разделе Get DGS Purchase)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.18.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSPurchases&
    seller=NXT-L6FM-89WK-VK8P-FCRBB&
    lastIndex=0

Пример:

{
    "purchases": [
        {
            "seller": "15323192282528158131",
            "priceNQT": "200000000",
            "quantity": 2,
            "deliveryDeadlineTimestamp": 31600000,
            "buyerRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
            "pending": true,
            "purchase": "3723760852542296589",
            "name": "Test Product",
            "goods": "11813734897437346473",
            "sellerRS": "NXT-L6FM-89WK-VK8P-FCRBB",
            "buyer": "7580519603555678830",
            "timestamp": 31520720
        }
    ],
    "requestProcessingTime": 1
}

Verified 14-Dec-14

10.19 Get DGS Tag Count

Возвращает число тэгов, используемых всеми продавцами.

Запрос:

  • requestType это getDGSTagCount
  • inStockOnly установите false, если тэги не связанные с товарами на складе должны быть включены (опционально)

Ответ:

  • numberOfTags (N) количество тэгов
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.19.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSTags&
    lastIndex=0

Ответ:

{
    "requestProcessingTime": 2,
    "tags": [
        {
            "inStockCount": 40,
            "tag": "domains",
            "totalCount": 42
        }
    ]
}

Verified 14-Dec-14

10.20 Get DGS Tags

Получить теги, используемые всеми продавцами в порядке обратном inStockCount, TotalCount, tag.

Запрос:

  • requestType это getDGSTags
  • inStockOnly установите false если тэгт отсутствующие на складе должны быть также включены в ответ (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого значения тэга (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого значения тэга (опционально)

Ответ:

  • tags (A) массив из объектов тэг со следующими полями для каждого тэга:
  • inStockCount (N) число продуктов, доступных для продажи, с тэгом
  • tag (S) значение тэга
  • totalCount (N) общее количество продуктов с тэгом
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: ...Count поля относятся к количеству различных тэгированных продуктов, независимо от количества каждого из них.

10.20.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSTags&
    lastIndex=0

Ответ:

{
    "requestProcessingTime": 2,
    "tags": [
        {
            "inStockCount": 40,
            "tag": "domains",
            "totalCount": 42
        }
    ]
}

Verified 24-Dec-14

10.21 Get DGS Tags Like

Get all tags starting with a given prefix in reverse inStockCount, reverse totalCount, tag order. (at least 2 characters long)

Request:

  • requestType is getDGSTagsLike
  • tagPrefix is the prefix (at least 2 characters long) of the tag
  • inStockOnly is false if out-of-stock tags are to be retrieved (optional)
  • firstIndex is a zero-based index to the first tag to retrieve (optional)
  • lastIndex is a zero-based index to the last tag to retrieve (optional)

Response:

  • tags (A) is an array of tag objects with the following fields for each tag:
    • inStockCount (N) is the number of products available for sale as tagged
    • tag (S) is the tag word
    • totalCount (N) is the total number of products as tagged
  • requestProcessingTime (N) is the API request processing time (in millisec)

Note: The ...Count fields refer to the number of distinct products tagged, regardless of the quantity of each.

10.21.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getDGSTagsLike&
    tagPrefix=item

Ответ:

{
    "requestProcessingTime": 1,
    "tags": [
        {
            "inStockCount": 1,
            "tag": "items",
            "totalCount": 1
        }
    ]
}

Verified 11-Jun-15

10.22 Search DGS Goods

Возвращает список товаров, у которых название или описание соответствуют данному поисковому запросу в обратном порядке релевантности, затем в порядке названия (данные продавца), затем в обратном хронологическом порядке.

Запрос:

  • requestType это searchDGSGoods
  • query полнотекстовый запрос по полях товаров name и description в синтаксисе Lucene (опционально)
  • tag запрос по полю товара tags в синтаксисе Lucene (опционально)
  • seller ID аккаунта продавца товара (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого товара (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого товара (опционально)
  • inStockOnly установите false если товары отсутствующие на складе (с нулевым количеством) должны также возвращаться запросом (опционально)
  • hideDelisted установите true если необходимо чтобы снятые с публикации товары были опущены (опционально)
  • includeCounts установите false если необходимо чтобы поля начинающиеся с numberOf... были опущены (опционально)

Ответ:

  • goods (A) массив объектов товар (Подробнее смотри в разделе Get DGS Good)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

10.22.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=searchDGSGoods&
    tag=te?t AND prod*

Ответ:

{
    "goods": [
        {
            "seller": "7580519603555678830",
            "quantity": 1,
            "goods": "1587116104511359906",
            "description": "This is a test. Please do not order.",
            "sellerRS": "NXT-6GMG-FC5F-YSX6-8CVEL",
            "delisted": false,
            "parsedTags": [
                "test",
                "product",
                "tag"
            ],
            "tags": "test,product,tag",
            "priceNQT": "100000000",
            "numberOfPublicFeedbacks": 1,
            "name": "Test Product",
            "numberOfPurchases": 1,
            "timestamp": 31611435
        }
    ],
    "requestProcessingTime": 4
}

Verified 14-Dec-14

11 Операции Форжинга

11.1 Start / Stop / Get Forging

Начать или остановить форжинг аккаунта, или проверить текущий статус форжинга. Только POST.

Запрос:

  • requestType может принимать значение startForging, stopForging или getForging
  • secretPhrase секретная фраза аккаунта

Ответ:

  • deadline (N) предполагаемое время (в секундах начиная с последнего блока), пока учетная запись не сфоржит блок (для startForging и getForging только)
  • hitTime (N) предполагаемое время (в секундах начиная со времени генерации генезисного блока), когда аккаунт сфоржит блок (для startForging и getForging только)
  • remaining (N) время ожидания меньшее прошедшего время с момента создания последнего блока (только getForging)
  • foundAndStopped (B) true, если форжинг будет остановлен, false, если форжинг был уже остановлен (только stopForging)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: Запрос getForging возвращает errorCode 5, если учетная запись не форжит. Если у аккаунта нулевой effectiveBalance, форжинг может быть запущен, но deadline, remainingTime и hitTime будут обнулены.

11.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=startForging&
    secretPhrase=IWontTellYou

Ответ:

{
    "requestProcessingTime": 1,
    "deadline": 0,
    "hitTime": 0
}

Verified 14-Dec-14

11.2 Lease Balance

Передать в аренду гарантированный баланс NXT другому аккаунту, после 1440 подтверждений. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это leaseBalance
  • period период лизинга (указывается в количестве блоков, 1440 минимум)
  • recipient аккаунт лизингополучателя (получатель)
  • recipientPublicKey публичный ключ аккаунта лизингополучателя (получателя) (опционально, повышает безопасность для недавно созданных аккаунтов)

Ответ: Подробнее смотри в разделе Create Transaction Response.

11.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=leaseBalance&
    period=1440&
    recipient=NXT-4VNQ-RWZC-4WWQ-GVM8S&
    secretPhrase=IWontTellYou&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "462590bb85b615ddd34d59a1ffdc452a9baee2088044c1b9eb44298e49158f35",
    "unsignedTransactionBytes": "04107977ce013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473b...",
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "4a89702535246fd55bfc4b4691dc4266daa3100e00cdf0caaed57a5ad750da075a...",
        "feeNQT": "100000000",
        "type": 4,
        "fullHash": "251bcd86057c09bb2d055bbeeb9b67ccae861f75d4aada21b3b79a13db9712e1",
        "version": 1,
        "ecBlockId": "6565389899781382679",
        "signatureHash": "462590bb85b615ddd34d59a1ffdc452a9baee2088044c1b9eb44298e49158f35",
        "attachment": {
            "version.EffectiveBalanceLeasing": 1,
            "period": 1440
        },
        "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
        "subtype": 0,
        "amountNQT": "0",
        "sender": "15323192282528158131",
        "recipientRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
        "recipient": "17013046603665206934",
        "ecBlockHeight": 280672,
        "deadline": 60,
        "transaction": "13477439723061189413",
        "timestamp": 30308217,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 7340,
    "transactionBytes": "04107977ce013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473b...",
    "fullHash": "251bcd86057c09bb2d055bbeeb9b67ccae861f75d4aada21b3b79a13db9712e1",
    "transaction": "13477439723061189413"
}

Verified 14-Dec-14

12 Операции с Клеймами

12.1 Decode Hallmark

Декодировать клеймо узла.

Запрос:

  • requestType это decodeHallmark
  • hallmark значение клейма (hallmark)

Ответ:

  • valid (B) вернется true если host короче 100 символов, weight > 0 и вложенная подпись верифицирована
  • weight (N) вес присвоенный клейму (hallmark)
  • host (S) IP адрес или имя домена ассоциированное с клеймом (hallmark)
  • account (S) номер аккаунта ассоциированного с клеймом (hallmark)
  • accountRS (S) номер аккаунта в формате Reed-Solomon ассоциированного с клеймом (hallmark)
  • date (S) дата создания клейма, в формате YYYY-MM-DD
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

12.1.1 Пример

Запрос:

http://127.0.0.1:7876/nxt?
    requestType=decodeHallmark&
    hallmark=827ed8cf83bbd36419002759d960a1bec952f2209db8ed3be958...

Ответ:

{
    "date": "2013-12-10",
    "valid": true,
    "accountRS": "NXT-FEJ5-H4YB-QD3D-2L3W2",
    "host": "nxttyclub.info",
    "weight": 100,
    "requestProcessingTime": 2,
    "account": "31580691533050371"
}

Verified 14-Dec-14

12.2 Generate Hallmark

Создает клеймо узла. Только POST.

Запрос:

  • requestType это markHost
  • secretPhrase секретная фраза аккаунта который делает метку для узла
  • host IP адрес или имя домена узла
  • weight вес присвоенный узлу
  • date текущая дата в формате YYYY-MM-DD

Примечание: Подробнее смотри в разделе Создание Клейма.

Ответ:

  • hallmark (S) шестнадцатеричная строка клейма
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: Подробнее смотри в разделе Создание Клейма для уточнения инструкций по созданию клейма для публичного узла.

12.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=markHost&
    secretPhrase=IWontTellYou&
    host=iwonttellyou.com&
    weight=1&
    date=2014-11-22

Ответ:

{
    "hallmark": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c...",
    "requestProcessingTime": 5
}

Verified 14-Dec-14

13 Операции в Денежной Системе

Основная документация по Monetary System доступна здесь. Документация по работе с инструментом MintWorker для создания валют доступна здесь.

13.1 Can Delete Currency

Делает проверку может ли валюта быть удалена

Запрос:

  • requestType это canDeleteCurrency
  • account ID аккаунта
  • currency ID валюты

Ответ:

  • canDelete (B) вернет true если валюта может быть удалена, false в ином случае
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: валюта может быть удален только, когда всем количеством валюты владеет один account. Rreserveable валюта, которая еще не была выпущена, может быть удалена выпускающим аккаунтом. Mintable валюта, у которой не завершена чеканк, не может быть удалена аккаунтом который её не выпускал.

13.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=canDeleteCurrency&
    account=NXT-2HCZ-6GCJ-2XGV-EDRPH&
    currency=4923907272718555444

Ответ:

{
    "canDelete": true,
    "requestProcessingTime": 1
}

Verified 23-Dec-14

13.2 Currency Buy / Sell

Создать запрос обмена, для покупки или продажи конвертируемой валюты. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это currencyBuy или currencySell
  • currency ID валюты
  • rateNQT курс обмена (в NQT за QNT)
  • units сумма валюты, которая будет куплена или продана (в QNT)

'Примечание:' запрос обмена выполняется сразу же после его помещения в blockchain на основе имеющихся на данный момент предложений (Подробнее смотри в разделе Публикация Предложения Обмена). Запрос заканчивается, независимо от суммы обмениваемой валюты; Запрос может быть выполнен полностью, выполнен частично, или закончится без обмена, если соответствующие предложения не будут найдены.

Ответ: Подробнее смотри в разделе Create Transaction Response.

13.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=currencyBuy&
    currency=6520756875632314476&
    rateNQT=1500000000&
    units=200&
    secretPhrase=SECRETPHRASE&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "0471907734d4aae7fc708131726f8660a68e66fe873fa17cab4f0cb3f879243f",
    "unsignedTransactionBytes": "051607cb08023c0010f09c34f225d425306e5be55a49469081...",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "dda6c065344827bfdecfee179b22dfee1d5280fa5da5431b012d9ea045a0d80b9d4...",
        "feeNQT": "100000000",
        "type": 5,
        "fullHash": "d388798c9ecaf2cd28578cfcb8fb7e8f07d308e36e2a5674bb1c7766595b8435",
        "version": 1,
        "ecBlockId": "10096636210021430702",
        "signatureHash": "0471907734d4aae7fc708131726f8660a68e66fe873fa17cab4f0cb3f879243f",
        "attachment": {
            "currency": "6520756875632314476",
            "version.ExchangeSell": 1,
            "units": "200",
            "rateNQT": "1500000000"
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 6,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "ecBlockHeight": 162266,
        "deadline": 60,
        "transaction": "14840146504449624275",
        "timestamp": 34130695,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 331,
    "transactionBytes": "051607cb08023c0010f09c34f225d425306e5be55a49469081560...",
    "fullHash": "d388798c9ecaf2cd28578cfcb8fb7e8f07d308e36e2a5674bb1c7766595b8435",
    "transaction": "14840146504449624275"
}

Verified 29-Dec-14

13.3 Currency Mint

Отправляет запрос в blockchain чтобы чеканить дополнительные единицы валюты. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это currencyMint
  • currency ID mintable валюты
  • nonce вычисленная уникальная последовательность
  • units сумма (в QNT) валюты, для чеканки
  • counter (N) счетчик, связанный с аккаунтом чеканки

Примечание: Хэш nonce должен быть меньше чем targetBytes как предусмотрено в Get Minting Target для заданных units и counter. counter должен увеличиваться с каждой подачей.

Ответ: Подробнее смотри в разделе Create Transaction Response.

13.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=currencyMint&
    currency=9207767346829573996&
    nonce=-6757092571753666960&
    units=1&
    counter=26&
    secretPhrase=SECRETPHRASE&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "f0e9f3b040890043fbc2d1b235377eb566805419f459184bc9290051bacdf80f",
    "unsignedTransactionBytes": "0517655a0c023c0010f09c34f225d425306e5be55a49469081...",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "e961f58250dd256bb5f0628df342beb6ce042765d7cdad8d7598495759d7ec00ad8...",
        "feeNQT": "100000000",
        "type": 5,
        "fullHash": "05cbe451cdece14bab56c5684d30cd7eb62e45a86136071e90ae26981d4c1fc3",
        "version": 1,
        "ecBlockId": "12526333689713738846",
        "signatureHash": "f0e9f3b040890043fbc2d1b235377eb566805419f459184bc9290051bacdf80f",
        "attachment": {
            "currency": "9207767346829573996",
            "units": "1",
            "counter": "26",
            "version.CurrencyMinting": 1,
            "nonce": "-6757092571753666960"
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 7,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "ecBlockHeight": 160721,
        "deadline": 60,
        "transaction": "5467911789190892293",
        "timestamp": 34364005,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 815,
    "transactionBytes": "0517655a0c023c0010f09c34f225d425306e5be55a49469081560...",
    "fullHash": "05cbe451cdece14bab56c5684d30cd7eb62e45a86136071e90ae26981d4c1fc3",
    "transaction": "5467911789190892293"
}

Verified 29-Dec-14

13.4 Currency Reserve Claim

Запрос/Затребование Reserve Валюты. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это currencyReserveClaim
  • currency ID валюты
  • units сумма (в QNT) reserve валюты, чтобы быть затребованной

Примечание: Держатели claimable валюты может затребовать заблокированные NQT обратно, таким образом уменьшая объем валюты.

Ответ: Подробнее смотри в разделе Create Transaction Response.

13.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=currencyReserveClaim&
    currency=15992040603642022742&
    units=36

Ответ:

{
    "signatureHash": "6daef8c9b8653a9b78b64e400c2ab64ea201e9888b8bc54ec6c9a28814b0a69e",
    "unsignedTransactionBytes": "0512a7830b023c00169cf83994b0e8c48a152ddc50606d58bd...",
    "transactionJSON": {
        "senderPublicKey": "169cf83994b0e8c48a152ddc50606d58bd4b2b85ec2f5bbbaae93d838443df7f",
        "signature": "5ab6605aca7a958b10e5f0198660eccd01bff1418f2bf172105ba39e9c911d09709...",
        "feeNQT": "100000000",
        "type": 5,
        "fullHash": "f32e02362dce767c6f4b069f793f2cd8c6b89bad04847c8abe98d8998cede94f",
        "version": 1,
        "ecBlockId": "14980969893438059909",
        "signatureHash": "6daef8c9b8653a9b78b64e400c2ab64ea201e9888b8bc54ec6c9a28814b0a69e",
        "attachment": {
            "version.ReserveClaim": 1,
            "currency": "15992040603642022742",
            "units": "36"
        },
        "senderRS": "NXT-BMUV-8QQR-47VK-CR7F3",
        "subtype": 2,
        "amountNQT": "0",
        "sender": "11580081983047651163",
        "ecBlockHeight": 160064,
        "deadline": 60,
        "transaction": "8968582401529884403",
        "timestamp": 34309031,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 7,
    "transactionBytes": "0512a7830b023c00169cf83994b0e8c48a152ddc50606d58bd4b2...",
    "fullHash": "f32e02362dce767c6f4b069f793f2cd8c6b89bad04847c8abe98d8998cede94f",
    "transaction": "8968582401529884403"
}

Verified 29-Dec-14

13.5 Currency Reserve Increase

Увеличить резерв не выпущенной reservable валюты. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это currencyReserveIncrease
  • currency ID валюты
  • amountPerUnitNQT дополнительное количество (в NQT за QNT как reserveSupply) для резерва (подробнее смотри раздел Issue Currency)

Примечание: Дополнительные amountPerUnitNQT * reserveSupply NQT (без учета того, что было зарезервировано ранее) будут заблокированы, пока не будет достигнута высота issuanceHeight. После выпуска, если валюта claimable, NQT останутся заблокированными, пока не будут востребованы; иначе NQT будут переданы создавшему валюту аккаунту. Также при выпуске, часть reserveSupply QNT будет передана каждому инвестирующему аккаунту пропорционально NQT, которые ими были внесены.

Ответ: Подробнее смотри в разделе Create Transaction Response.

13.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=currencyReserveIncrease&
    currency=11847174313362984527
    amountPerUnitNQT=40000000

Ответ:

{
    "signatureHash": "0ba69ec678e0d4c4f94ee576d9520bf13a1c88b87e46c79d937b8f998a4a1f54",
    "unsignedTransactionBytes": "05115c930b023c00169cf83994b0e8c48a152ddc50606d58bd...",
    "transactionJSON": {
        "senderPublicKey": "169cf83994b0e8c48a152ddc50606d58bd4b2b85ec2f5bbbaae93d838443df7f",
        "signature": "01ab2e01e8543321bb93baef1cdfd24335b2f98f4898c0203ebb372f6ea2140f609...",
        "feeNQT": "100000000",
        "type": 5,
        "fullHash": "0e583d097aa7832ef97f49bf1c43fe6fa26592cd7b60cd1c652b1139719c9404",
        "version": 1,
        "ecBlockId": "3894856940593871962",
        "signatureHash": "0ba69ec678e0d4c4f94ee576d9520bf13a1c88b87e46c79d937b8f998a4a1f54",
        "attachment": {
            "amountPerUnitNQT": "40000000",
            "currency": "11847174313362984527",
            "version.ReserveIncrease": 1
        },
        "senderRS": "NXT-BMUV-8QQR-47VK-CR7F3",
        "subtype": 1,
        "amountNQT": "0",
        "sender": "11580081983047651163",
        "ecBlockHeight": 160118,
        "deadline": 60,
        "transaction": "3351706690276644878",
        "timestamp": 34313052,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 7,
    "transactionBytes": "05115c930b023c00169cf83994b0e8c48a152ddc50606d58bd4b2...",
    "fullHash": "0e583d097aa7832ef97f49bf1c43fe6fa26592cd7b60cd1c652b1139719c9404",
    "transaction": "3351706690276644878"
}

Verified 29-Dec-14

13.6 Delete Currency

Удаление валюты которая может быть удалена (Подробнее смотри Как Удалить Валюту). Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это deleteCurrency
  • currency ID валюты

Ответ: Подробнее смотри в разделе Create Transaction Response.

13.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=deleteCurrency&
    currency=7103310507724273660&
    secretPhrase=SECRETPHRASE&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "3f2b029337263728f4d4fed1f774252b06706159659e6ba9116b2d74b67a8435",
    "unsignedTransactionBytes": "05189d7208023c0010f09c34f225d425306e5be55a49469081...",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "09c7be5b0742191f3777cc850f9478af21bd42225aec5e0793b57cd188767a0be6f...",
        "feeNQT": "100000000",
        "type": 5,
        "fullHash": "a877379e3f3713e2f8baaa777c9a48af23d7da74e00301f12a4051dcf747243f",
        "version": 1,
        "ecBlockId": "2688066685599408512",
        "signatureHash": "3f2b029337263728f4d4fed1f774252b06706159659e6ba9116b2d74b67a8435",
        "attachment": {
            "version.CurrencyDeletion": 1,
            "currency": "7103310507724273660"
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 8,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "ecBlockHeight": 162004,
        "deadline": 60,
        "transaction": "16290425023506118568",
        "timestamp": 34108061,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 112,
    "transactionBytes": "05189d7208023c0010f09c34f225d425306e5be55a49469081...",
    "fullHash": "a877379e3f3713e2f8baaa777c9a48af23d7da74e00301f12a4051dcf747243f",
    "transaction": "16290425023506118568"
}

Verified 29-Dec-14

13.7 Get Account Currencies

Возвращает список валют выпущенных указанным аккаунтом.

Запрос:

  • requestType это getAccountCurrencies
  • account ID аккаунта
  • currency фильтр по ID валюты (опционально)
  • height высота blockchain, для которой формируется ответ (опционально, по умолчанию текущая высота)

Ответ:

  • accountCurrencies (A) массив объектов валюты со следующими полями:
  • code (S) Код валюты
  • unconfirmedUnits (S) сумма неподтвержденных единиц валюты (в QNT)
  • decimals (N) число десятичных разрядов валюты
  • name (S) Название валюты
  • currency (S) ID валюты
  • units (S) сумма валюты (in QNT)
  • issuanceHeight (N) blockchain высота выпуска reservable валюты
  • type (N) битовая маска типа валюты (Подробнее смотри в разделе Get Currency)
  • issuerAccountRS (S) адрес аккаунта выпустившего валюту, в формате Reed-Solomon
  • issuerAccount (S) ID аккаунта выпустившего валюту
  • requestProcessingTime (N) вреемя выполнения API запроса (в миллисекундах)

13.7.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountCurrencies&
    account=NXT-4VDY-LNVT-LMAY-FMCKA

Ответ:

{
    "accountCurrencies": [
        {
            "code": "MYSTX",
            "unconfirmedUnits": "10000",
            "decimals": 2,
            "name": "MystcoinX",
            "currency": "6520756875632314476",
            "units": "10000",
            "issuanceHeight": 0,
            "type": 1
        }
    ],
    "requestProcessingTime": 1
}

Verified 29-Dec-14

13.8 Get Account Currency Count

Возвращает количество валют выпущенных заданным аккаунтом.

Запрос:

  • requestType это getAccountCurrencyCount
  • account ID аккаунта
  • height высота blockchain к которой применяется ответ (опционально, по умолчанию это текущая высота)

Ответ:

  • numberOfPurchases (N) количество выпущенных валют
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.8.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountCurrencyCount&
    account=NXT-4VDY-LNVT-LMAY-FMCKA

Ответ:

{
    "numberOfCurrencies": 1,
    "requestProcessingTime": 1
}

Verified 29-Dec-14

13.9 Get Account Exchange Requests

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

Запрос:

  • requestType это getAccountExchangeRequests
  • account ID аккаунта
  • currency ID валюты
  • firstIndex индекс (начиная с 0) первого возвращаемого запроса (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого запроса (опционально)

Ответ:

  • exchangeRequests (A) массив запросов со следующими полями для каждого запроса:
  • code (S) код валюты
  • subtype (N) 5 для покупки и 6 для продажи
  • decimals (N) количество десятичных знаков
  • name (S) Название валюты
  • units (S) количество единиц валюты для покупки или продажи (в QNT)
  • issuanceHeight (N) blockchain высота выпуска reservable валюты, ноль в любом другом случае
  • type (N) битовая маска типа валюты (подробнее смотри в разделе Get Currency)
  • transaction (S) ID транзакции
  • timestamp (N) метка времени (в секундах с момента создания генезисного блока) запроса
  • rateNQT (S) курс обмена (в NQT за QNT)
  • issuerAccountRS (S) адрес аккаунта выпустившего валюту в формате Reed-Solomon
  • issuerAccount (S) ID аккаунта выпустившего валюту
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: Даже истекшие, невыполненные запросы будут получены.

13.9.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountExchangeRequests&
    account=NXT-4VDY-LNVT-LMAY-FMCKA&
    currency=6520756875632314476

Ответ:

{
    "exchangeRequests": [
        {
            "code": "MYSTX",
            "subtype": 6,
            "decimals": 2,
            "name": "MystcoinX",
            "units": "200",
            "issuanceHeight": 0,
            "type": 1,
            "transaction": "14840146504449624275",
            "timestamp": 34130695,
            "rateNQT": "1500000000"
        }
    ],
    "requestProcessingTime": 1
}

Verified 29-Dec-14

13.10 Get All Currencies

Возвращает все валюты, в порядке обратном дате создания.

Запрос:

  • requestType это getAllCurrencies
  • firstIndex индекс (начиная с 0) первой возвращаемой валюты (опционально)
  • lastIndex индекс (начиная с 0) последней возвращаемой валюты (опционально)
  • includeCounts установите false чтобы опустить поля numberOf... (опционально)

Ответ:

  • currencies (A) массив состоящий из объектов валюты (Подробнее смотри в разделе Get Currency )
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.10.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAllCurrencies&
    firstIndex=2&
    lastIndex=2

Ответ:

{
    "requestProcessingTime": 3,
    "currencies": [
        {
            "initialSupply": "10000",
            "currentReservePerUnitNQT": "0",
            "types": [
                "EXCHANGEABLE"
            ],
            "code": "MYSTX",
            "creationHeight": 162067,
            "minDifficulty": 0,
            "numberOfTransfers": 0,
            "description": "Exchangable",
            "minReservePerUnitNQT": "0",
            "currentSupply": "10000",
            "issuanceHeight": 0,
            "type": 1,
            "reserveSupply": "0",
            "maxDifficulty": 0,
            "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "decimals": 2,
            "name": "MystcoinX",
            "numberOfExchanges": 12,
            "currency": "6520756875632314476",
            "maxSupply": "10000",
            "account": "15295723609781267838",
            "algorithm": 0
        }
    ]
}

Verified 29-Dec-14

13.11 Get All Exchanges

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

Запрос:

  • requestType это getAllExchanges
  • timestamp самая ранняя метка времени, которая будет возвращена (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого обмена (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого обмена (опционально)
  • includeCurrencyInfo установите false чтобы опустить дополнительные подробности о валюте (опционально)

Ответ:

  • exchanges (A) массив объектов обмена (Подробнее смотри Получить обмены)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.11.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAllExchanges&
    firstIndex=7&
    lastIndex=7

Ответ:

{
    "exchanges": [
        {
            "seller": "15295723609781267838",
            "code": "MYSTX",
            "sellerRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "units": "5000",
            "issuanceHeight": 0,
            "type": 1,
            "rateNQT": "10000000",
            "buyer": "11580081983047651163",
            "offer": "17204924627068821879",
            "buyerRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "decimals": 2,
            "name": "MystcoinX",
            "currency": "6520756875632314476",
            "block": "4816799421151726903",
            "transaction": "2086609620693258113",
            "timestamp": 34206117,
            "height": 163202
        }
    ],
    "requestProcessingTime": 1
}

Verified 29-Dec-14

13.12 Get Buy / Sell Offers

Возвращает предложения покупки/продажи валюты по заданному ID валюты и/или ID аккаунта в хронологическом порядке.

Запрос:

  • requestType это getBuyOffers или getSellOffers
  • currency ID валюты (опционально)
  • account ID валюты (опционально, если currency задано)
  • availableOnly установите true чтобы были включены только предложения с ненулевым объемом и лимитом, но будет проигнорировано если currency и account будут заданы (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого предложения (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого предложения (опционально)

Ответ:

  • offers (A) массив из объектов предложений покупки или продажи(Подробнее смотри Get Offer)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.12.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getSellOffers&
    currency=6520756875632314476

Ответ:

{
    "offers": [
        {
            "offer": "4813417617929273983",
            "expirationHeight": 163125,
            "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "limit": "1000",
            "currency": "6520756875632314476",
            "supply": "500",
            "account": "15295723609781267838",
            "height": 163110,
            "rateNQT": "20000000"
        }
    ],
    "requestProcessingTime": 1
}

Verified 29-Dec-14

13.13 Get Currencies

Возвращает описание валют по заданным значениям ID валют.

Запрос:

  • requestType это getCurrencies
  • currencies один из множества ID валют
  • currencies один из множества ID валют

  • includeCounts установите false чтобы опустить записи numberOf... (опционально)

Ответ:

  • currencies (A) массив из объектов валют (Подробнее смотри Get Currency)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.13.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrencies&
    currencies=6520756875632314476

Ответ:

{
    "requestProcessingTime": 3,
    "currencies": [
        {
            "initialSupply": "10000",
            "currentReservePerUnitNQT": "0",
            "types": [
                "EXCHANGEABLE"
            ],
            "code": "MYSTX",
            "creationHeight": 162067,
            "minDifficulty": 0,
            "numberOfTransfers": 0,
            "description": "Exchangable",
            "minReservePerUnitNQT": "0",
            "currentSupply": "10000",
            "issuanceHeight": 0,
            "type": 1,
            "reserveSupply": "0",
            "maxDifficulty": 0,
            "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "decimals": 2,
            "name": "MystcoinX",
            "numberOfExchanges": 12,
            "currency": "6520756875632314476",
            "maxSupply": "10000",
            "account": "15295723609781267838",
            "algorithm": 0
        }
    ]
}

Verified 30-Dec-14

13.14 Get Currencies By Issuer

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

Запрос:

  • requestType это getCurrenciesByIssuer
  • account один из множества ID аккаунта
  • account один из множества ID аккаунта

  • firstIndex индекс (начиная с 0) первой возвращаемой валюты (опционально)
  • lastIndex индекс (начиная с 0) последней возвращаемой валюты (опционально)
  • includeCounts установите false если необходимо чтобы поля numberOf... были опущены (опционально)

Ответ:

  • currencies (A) массив из массивов объектов валюты, где внешний массив индексирован заданными идентификаторами учетных записей (Подробнее о объекте валюты смотри в разделе Get Currency)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.14.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrenciesByIssuer&
    account=NXT-4VDY-LNVT-LMAY-FMCKA

Ответ:

{
    "requestProcessingTime": 334,
    "currencies": [
        [
            {
                "initialSupply": "10000",
                "currentReservePerUnitNQT": "0",
                "types": [
                    "EXCHANGEABLE"
                ],
                "code": "MYSTX",
                "creationHeight": 162067,
                "minDifficulty": 0,
                "numberOfTransfers": 0,
                "description": "Exchangable",
                "minReservePerUnitNQT": "0",
                "currentSupply": "10000",
                "issuanceHeight": 0,
                "type": 1,
                "reserveSupply": "0",
                "maxDifficulty": 0,
                "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
                "decimals": 2,
                "name": "MystcoinX",
                "numberOfExchanges": 12,
                "currency": "6520756875632314476",
                "maxSupply": "10000",
                "account": "15295723609781267838",
                "algorithm": 0
            }
        ]
    ]
}

Verified 06-Feb-14

13.15 Get Currency

Возвращает подробную информацию о валюте

Запрос:

  • requestType это getCurrency
  • currency ID валюты (опционально)
  • code код валюты (опционально если currency задано)
  • includeCounts если false то поля numberOf... будут опущены (опционально)

Ответ:

  • initialSupply (S) первоначальное количество монеты (в QNT)
  • currentReservePerUnitNQT (S) минимальный резерв валюты (в NQT за QNT)
  • types (A) массив из типов валют, один или более из: EXCHANGEABLE, CONTROLLABLE, RESERVABLE, CLAIMABLE, MINTABLE, NON_SHUFFLEABLE
  • code (S) код валюты
  • creationHeight (N) высота blockchain создания валюты
  • minDifficulty (N) минимальная сложность mintable валюты
  • numberOfTransfers (N) количество передач валюты
  • description (S) описание валюты
  • minReservePerUnitNQT (S) минимальный резерв валюты (в NQT за QNT) для reservable валюты
  • currentSupply (S) текущий объем валюты (d QNT)
  • issuanceHeight (N) высота blockchain выпуска reservable валюты
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • type (N) битовая маска типа валюты, от младшего до старшего значащего бита: exchangeable, controllable, reservable, claimable, mintable, non-shuffleable
  • reserveSupply (S) текущий резерв валюты (в NQT) для reservable валюты
  • maxDifficulty (N) максимальная сложность для mintable валюты
  • accountRS (S) адрес аккаунта издателя валюты в формате Reed-Solomon
  • decimals (N) число десятичных разрядов, используемых валютой
  • name (S) название валюты
  • numberOfExchanges (N) количество обменов валюты
  • currency (S) ID валюты
  • maxSupply (S) максимальный объем валюты (в QNT)
  • account (S) ID аккаунта издателя валюты
  • algorithm (N) номер алгоритма для mintable валюты: 2 для SHA256, 3 для SHA3, 5 для Scrypt, 25 для Keccak25

13.15.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrency&
    code=MYSTX

Ответ:

{
    "initialSupply": "10000",
    "currentReservePerUnitNQT": "0",
    "types": [
        "EXCHANGEABLE"
    ],
    "code": "MYSTX",
    "creationHeight": 162067,
    "minDifficulty": 0,
    "numberOfTransfers": 0,
    "description": "Exchangable",
    "minReservePerUnitNQT": "0",
    "currentSupply": "10000",
    "issuanceHeight": 0,
    "requestProcessingTime": 0,
    "type": 1,
    "reserveSupply": "0",
    "maxDifficulty": 0,
    "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
    "decimals": 2,
    "name": "MystcoinX",
    "numberOfExchanges": 0,
    "currency": "6520756875632314476",
    "maxSupply": "10000",
    "account": "15295723609781267838",
    "algorithm": 0
}

Verified 06-Feb-15

13.16 Get Currency Account Count

Возвращает количество аккаунтов владеющих заданной валютой.

Запрос:

  • requestType это getCurrencyAccountCount
  • currency ID валюты
  • height высота blockchain к которой применяется ответ (опционально, по умолчанию это текущая высота)

Ответ:

  • numberOfAccounts (N) количество аккаунтов владеющих заданной валютой
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.16.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrencyAccountCount&
    currency=6520756875632314476

Ответ:

{
    "numberOfAccounts": 2,
    "requestProcessingTime": 1
}

Verified 06-Feb-15

13.17 Get Currency Accounts

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

Запрос:

  • requestType это getCurrencyAccounts
  • currency ID валюты
  • height высота blockchain, к которой применяется ответ (опционально, по умолчанию это текущая высота),
  • firstIndex индекс (начиная с 0) первого возвращаемого аккаунта (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого аккаунта (опционально)

Ответ:

  • accountCurrencies (A) массив объектов аккаунтов со следующими полями:
  • unconfirmedUnits (S) количество неподтвержденных единиц валюты (в QNT)
  • accountRS (S) аккаунта в формате Reed-Solomon
  • currency (S) ID валюты
  • units (S) количество валюты (в QNT)
  • account (S) номер аккаунта
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.17.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrencyAccounts&
    currency=6520756875632314476

Ответ:

{
    "accountCurrencies": [
        {
            "unconfirmedUnits": "9000",
            "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "currency": "6520756875632314476",
            "units": "9000",
            "account": "15295723609781267838"
        },
        {
            "unconfirmedUnits": "1000",
            "accountRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "currency": "6520756875632314476",
            "units": "1000",
            "account": "11580081983047651163"
        }
    ],
    "requestProcessingTime": 1
}

Verified 06-Feb-15

13.18 Get Currency Founders

Возвращает основателей reservable валюты.

Запрос:

  • requestType это getCurrencyFounders
  • currency ID валюты

Ответ:

  • founders (A) массив, объектов основателей, каждый из которых имеет следующие поля:
  • accountRS (S) адрес основателей в формате Reed-Solomon
  • amountPerUnitNQT (S) количество (в NQT за QNT как reserveSupply) зарезервированная основателем
  • currency (S) ID валюты
  • account (S) номер счета создателя валюты
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.18.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrencyFounders&
    currency=16165836410580103964

Ответ:

{
    "founders": [
        {
            "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "amountPerUnitNQT": "100000000",
            "currency": "16165836410580103964",
            "account": "15295723609781267838"
        }
    ],
    "requestProcessingTime": 1
}

Verified 06-Feb-15

13.19 Get Currency IDs

Возвращает все ID валют в хронологическом порядке обратном дате создания валюты.

Запрос:

  • requestType это getCurrencyIds
  • firstIndex индекс (начиная с 0) первой возвращаемой валюты (опционально)
  • lastIndex индекс (начиная с 0) последней возвращаемой валюты (опционально)

Ответ:

  • currencyIds(A) массив из ID валют
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.19.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrencyIds&
    lastIndex=2

Ответ:

{
    "currencyIds": [
        "3543596621551215845",
        "6520756875632314476",
        "10304209318415949524"
    ],
    "requestProcessingTime": 2
}

Verified 06-Feb-14

13.20 Get Currency Transfers

Возвращает перемещения указанной по ID валюты и/или ID аккаунта.

Запрос:

  • requestType это getCurrencyTransfers
  • currency ID валюты (опционально)
  • account ID аккаунта (опционально, если currency задано)
  • firstIndex индекс (начиная с 0) первого возвращаемого перемещения (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого перемещения (опционально)
  • includeCurrencyInfo установите false чтобы опустить некоторые поля валюты (опционально)

Ответ:

  • transfers (A) массив из объектов трансфера
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.20.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrencyTransfers&
    currency=9387514940677621191

Ответ:

  • code (S) Код валюты
  • units (S) количество передаваемых единиц (в QNT)
  • issuanceHeight (N) высота blockchain выпускаемой валюты для reservable валюты
  • type (N) битовая маска типа валюты (Подробнее смотри в разделе Get Currency)
  • issuerAccountRS (S) Адрес в формате Reed-Solomon аккаунта выпускающий валюту
  • transfer (S) ID трансфера (передачи)
  • senderRS (S) адрес отправителя в формате Reed-Solomon
  • sender (S) адрес отправителя
  • recipientRS (S) адрес получателя в формате Reed-Solomon
  • decimals (N) количество десятичных знаков используемых в валюте
  • recipient (S) адрес получателя
  • name (S) название валюты
  • currency (S) ID валюты
  • issuerAccount (S) ID аккаунта выпустившего валюту
  • height (N) высота blockchain трансфера
  • timestamp (N) отметка времени трансфера (в секундах с момента генерации генезисного блока)
  • issuerAccountRS (S) номер аккаунта выпустившего валюту в формате Reed-Solomon
  • issuerAccount (S) номер аккаунта выпустившего валюту
{
    "transfers": [
        {
            "issuerAccountRS":"NXT-4VDY-LNVT-LMAY-FMCKA",
            "code": "MYSTX",
            "units": "10",
            "issuanceHeight": 0,
            "type": 1,
            "issuerAccountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "transfer": "12208608533071682262",
            "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "sender": "15295723609781267838",
            "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "decimals": 2,
            "recipient": "11580081983047651163",
            "name": "MystcoinX",
            "currency": "9387514940677621191",
            "issuerAccount": "15295723609781267838",
            "height": 159732,
            "timestamp": 34280949,
            "issuerAccount":"15295723609781267838"
        }
    ],
    "requestProcessingTime": 0
}

Verified 06-Feb-15

13.21 Get Exchanges

Возвращает список обменов указанной валюты и/или аккаунта в обратном хронологическом порядке.

Запрос:

  • requestType это getExchanges
  • currency ID валюты (опционально)
  • account ID аккаунта (опционально, если currency представлено)
  • firstIndex индекс (начиная с 0) первого возвращаемого обмена валют (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого обмена валют (опционально)
  • includeCurrencyInfo установите false чтобы опустить некоторые поля валюты (опционально)

Ответ:

  • exchanges (A) массив объектов обмена со следующими полями для каждого обмена:
  • seller (S) номер аккаунта продавца
  • code (S) код валюты
  • sellerRS (S) номер аккаунта продавца в формате Reed-Solomon
  • units (S) сумма валюты, которая обменивается (in QNT)
  • issuanceHeight (N) высота blockchain выпуска валюты для reservable валюты
  • type (N) битовая маска типа валюты (подробнее смотри в разделе Get Currency)
  • rateNQT (S) курс обмена валюты (в NQT за QNT)
  • buyer (S) номер аккаунта покупателя
  • offer (S) ID предложения
  • buyerRS (S) номер аккаунта покупателя в формате Reed-Solomon
  • decimals (N) число десятичных разрядов, используемых валютой
  • name (S) название валюты
  • currency (S) ID валюты
  • block (S) ID блока, блока содержащего транзакцию обмена
  • transaction (S) ID транзакции обмена
  • timestamp (N) метка времени обмена (в секундах от времени создания генезисного блока)
  • height высота blockchain блока содержащего транзакцию обмена
  • issuerAccountRS (S) номер аккаунта издателя валюты в формате Reed-Solomon
  • issuerAccount (S) ID аккаунта издателя валюты
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.21.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getExchanges&
    currency=6520756875632314476

Ответ:

{
    "exchanges": [
        {
            "issuerAccountRS":"NXT-4VDY-LNVT-LMAY-FMCKA",
            "seller": "15295723609781267838",
            "code": "MYSTX",
            "sellerRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "units": "1",
            "issuanceHeight": 0,
            "type": 1,
            "rateNQT": "1500000000",
            "buyer": "11580081983047651163",
            "offer": "7762792906174207279",
            "buyerRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "decimals": 2,
            "name": "MystcoinX",
            "currency": "6520756875632314476",
            "block": "2329341955641682831",
            "transaction": "12589829502215822061",
            "timestamp": 34137058,
            "height": 162356,
            "issuerAccount":"15295723609781267838"
        }
    ],
    "requestProcessingTime": 0
}

Verified 06-Feb-15

13.22 Get Exchanges By Exchange Request

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

Запрос:

  • requestType это getExchangesByExchangeRequest
  • transaction ID транзакции запроса обмена
  • includeCurrencyInfo установите false чтобы опустить несколько связанных с валютой полей

Ответ:

  • exchanges (A) массив объектов обмена (Подробнее смотри в разделе Get Exchanges)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.22.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getExchangesByExchangeRequest&
    transaction=12589829502215822061

Ответ:

{
    "exchanges": [
        {
            "issuerAccountRS":"NXT-4VDY-LNVT-LMAY-FMCKA",
            "seller": "15295723609781267838",
            "code": "MYSTX",
            "sellerRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "units": "1",
            "issuanceHeight": 0,
            "type": 1,
            "rateNQT": "1500000000",
            "buyer": "11580081983047651163",
            "offer": "7762792906174207279",
            "buyerRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "decimals": 2,
            "name": "MystcoinX",
            "currency": "6520756875632314476",
            "block": "2329341955641682831",
            "transaction": "12589829502215822061",
            "timestamp": 34137058,
            "height": 162356,
            "issuerAccount":"15295723609781267838"
        }
    ],
    "requestProcessingTime": 1
}

Verified 06-Feb-15

13.23 Get Exchanges By Offer

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

Запрос:

  • requestType это getExchangesByOffer
  • offer (S) ID предложения валюты
  • includeCurrencyInfo установите false что опустить некоторые связанные с валютой поля (опционально)
  • firstIndex индекс (начиная с 0) первого возвращаемого обмена валюты (опционально)
  • lastIndex индекс (начиная с 0) последнего возвращаемого обмена валюты (опционально)

Ответ:

  • exchanges (A) массив объектов обмена (Подробнее смотри в разделе Get Exchanges)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.23.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getExchangesByOffer&
    offer=7762792906174207279

Ответ:

{
    "exchanges": [
        {
            "issuerAccountRS":"NXT-4VDY-LNVT-LMAY-FMCKA",
            "seller": "15295723609781267838",
            "code": "MYSTX",
            "sellerRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "units": "1",
            "issuanceHeight": 0,
            "type": 1,
            "rateNQT": "1500000000",
            "buyer": "11580081983047651163",
            "offer": "7762792906174207279",
            "buyerRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "decimals": 2,
            "name": "MystcoinX",
            "currency": "6520756875632314476",
            "block": "2329341955641682831",
            "transaction": "12589829502215822061",
            "timestamp": 34137058,
            "height": 162356,
            "issuerAccount":"15295723609781267838"
        }
    ],
    "requestProcessingTime": 1
}

Verified 06-Feb-15

13.24 Get Minting Target

Возвращает текущий целевой уровень минтинга mintable валюты.

Запрос:

  • requestType это getMintingTarget
  • currency ID mintable валюты
  • account ID аккаунта который минтит (кует)
  • units количество (в QNT) валюты для минтинга (ковки)

Примечание: units не может быть больше чем 1/10000 значения maxSupply (Подробнее смотри в разделе Issue Currency). Увеличение units уменьшает targetBytes.

Ответ:

  • difficulty (S) текущая сложность, оценка числа хешей что была достигнута цель
  • targetBytes (S) 32-байтовая цель (прямой порядок байтов), которая должна равняться или превышать вычисленный хеш nonce
  • currency (S) ID валюты
  • counter (N) счетчик ассоциированный с кующим аккаунтом, значение ранее использовалось в Currency Mint
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание:, Если nonce найден такой, что его хеш меньше, чем цель, он может быть передан в blockchain вместе с counter + 1 используя Currency Mint, c результирующим units NQT, зачисляемым на чеканящий аккаунт. difficulty обратно пропорциональна связанной цели, и увеличивается экспоненциально приближаясь кmaxSupply, т.к. цель определена как (2exp-1)/units, где exp уменьшается линейно с 256-minDifficulty до 256-maxDifficulty. (Подробнее читайте в разделе Issue Currency о maxSupply, minDifficulty и maxDifficulty.)

13.24.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getMintingTarget&
    currency=9207767346829573996&
    account=NXT-4VDY-LNVT-LMAY-FMCKA&
    units=1

Ответ:

{
    "difficulty": "1024",
    "targetBytes": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff3f00",
    "currency": "9207767346829573996",
    "counter": 0,
    "requestProcessingTime": 1
}

Verified 06-Feb-15

13.25 Get Offer

Возвращает подробности предложения по заданному ID предложения.

Запрос:

  • requestType это getOffer
  • offer ID предложения

Ответ:

  • sellOffer и buyOffer (O) объекты со следующими полями:
  • offer (S) ID предложения
  • expirationHeight (N) blockchain высота окончания действия предложения
  • accountRS (S) адрес аккаунта опубликовавшего предложение, в формате Reed-Solomon
  • limit (S) суммарный лимит покупаемой или продаваемой валюты
  • currency (S) ID валюты
  • supply (S) текущий объем валюты
  • account (S) адрес аккаунта опубликовавшего предложение
  • height (N) blockchain высота создания предложения
  • rateNQT (S) курс обмена валюты (в NQT за QNT)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.25.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getOffer&
    offer=4813417617929273983

Ответ:

{
    "sellOffer": {
        "offer": "4813417617929273983",
        "expirationHeight": 163125,
        "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "limit": "1000",
        "currency": "6520756875632314476",
        "supply": "500",
        "account": "15295723609781267838",
        "height": 163110,
        "rateNQT": "20000000"
    },
    "buyOffer": {
        "offer": "4813417617929273983",
        "expirationHeight": 163125,
        "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "limit": "1000",
        "currency": "6520756875632314476",
        "supply": "500",
        "account": "15295723609781267838",
        "height": 163110,
        "rateNQT": "10000000"
    },
    "requestProcessingTime": 0
}

Verified 06-Feb-15

13.26 Issue Currency

Выпуск новой валюты или перевыпуск существующей валюты с другими свойствами. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это issueCurrency
  • name название валюты, от 3 до 10 символов и длиннее чем код валюты
  • code код валюты в верхнем регистре со следующими правилами комиссии за регистрацию: три символа - 25000 NXT, четыре символа - 1000 NXT, пять символов - 40 NXT, перевыпуск валюты - 40 NXT
  • description описание валюты
  • type битовая маска типа валюты, от младшего до старшего значащего бита: exchangeable, controllable, reservable, claimable, mintable, non-shuffleable
  • initialSupply первичное количество валюты (в QNT) (должно соответствовать maxSupply если это mintable или claimable валюты, должно быть нулем если это claimable валюта)
  • reserveSupply резервируемый объем валюты (в QNT) (должно соответствовать maxSupply)
  • maxSupply максимальный объем валюты (в QNT)
  • issuanceHeight высота blockchain, на которой выпущена reservable валюта, если резервный минимум достигнут
  • minReservePerUnitNQT минимальный резерв валюты (в NQT за QNT как reserveSupply) для выпускаемой reservable валюты
  • minDifficulty минимальная сложность (минимум 1) для mintable валюты
  • maxDifficulty максимальная сложность (максимум 255 и больше чем minDifficulty) для mintable валюты
  • ruleset для будущего использования, всегда устанавливается в 0
  • algorithm алгоритм для mintable валюты: 2 для SHA256, 3 для SHA3, 5 дляScrypt, 25 для Keccak25
  • decimals число десятичных разрядов, используемых валютой (опционально, по умолчанию ноль)

Примечания: Правила допустимой композиции типов, которые надо знать. Reservable требует exchangeable и/или claimable, так же как и controllable; но mintable требует exchangeable. Claimable требует reservable, не-mintable и ноль в параметре initialSupply.

Ответ: Подробнее смотри раздел Create Transaction Response. ID транзакции также является ID валюты.

13.26.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=issueCurrency&
    name=MystcoinX&
    code=MYSTX&
    description=Exchangeable
    type=1&
    initialSupply=10000&
    maxSupply=10000&
    decimals=2&
    secretPhrase=SECRETPHRASE&
    feeNQT=4000000000&
    deadline=60
    

Ответ:

{
    "signatureHash": "c5ec66dd60bcc13fc0fe2cb617b4d7a05e7ef6360aacc591c911969785361491",
    "unsignedTransactionBytes": "05100f8308023c0010f09c34f225d425306e5be55a49469081...",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "da27e4bead869d0e96fb9370f0afcd0c49eb17b7da503705384239d9abaec209733...",
        "feeNQT": "4000000000",
        "type": 5,
        "fullHash": "6c08c076d4617e5a4be6f027c9b3e47ddb0e92fab87032d631546051dbdbfe8c",
        "version": 1,
        "ecBlockId": "2004481009157728964",
        "signatureHash": "c5ec66dd60bcc13fc0fe2cb617b4d7a05e7ef6360aacc591c911969785361491",
        "attachment": {
            "initialSupply": "10000",
            "code": "MYSTX",
            "minDifficulty": 0,
            "ruleset": 0,
            "description": "Exchangable",
            "minReservePerUnitNQT": "0",
            "issuanceHeight": 0,
            "type": 1,
            "reserveSupply": "0",
            "version.CurrencyIssuance": 1,
            "maxDifficulty": 0,
            "decimals": 2,
            "name": "MystcoinX",
            "maxSupply": "10000",
            "algorithm": 0
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 0,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "ecBlockHeight": 162060,
        "deadline": 60,
        "transaction": "6520756875632314476",
        "timestamp": 34112271,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 53,
    "transactionBytes": "05100f8308023c0010f09c34f225d425306e5be55a49469081560...",
    "fullHash": "6c08c076d4617e5a4be6f027c9b3e47ddb0e92fab87032d631546051dbdbfe8c",
    "transaction": "6520756875632314476"
}

Verified 06-Feb-15

13.27 Publish Exchange Offer

Публикация предложения обмена для exchangeable валюты. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это publishExchangeOffer
  • currency ID валюты
  • buyRateNQT предлагаемый курс покупки (в NQT за QNT)
  • sellRateNQT предлагаемый курс продажи (в NQT за QNT)
  • totalBuyLimit суммарный лимит (в QNT) покупаемой валюты
  • totalSellLimit суммарный лимит (в QNT) продаваемой валюты
  • initialBuySupply начальная сумма (в QNT) валюты, предлагаемой для покупки, не может превышать totalBuyLimit
  • initialSellSupply начальная сумма (в QNT) валюты, предлагаемой для продажи, не может превышать totalSellLimit
  • expirationHeight высота blockchain до которой предложение действует

Примечание: Каждый раз валюта покупается в ответ на запрос обмена-продажи валюты (подробнее смотрите раздел Currency Sell), totalBuyLimit понижается и объем предложения валюты к продаже увеличивается на сумму покупки. Когда totalBuyLimit становится нулем, предложение покупки снимается. Это же замечание относится и к ситуации когда buy и sell были обменены. Только самое последнее (новое) предложение ассоциированное с аккаунтом, будет активным, даже если более ранние предложения того аккаунта еще не завершилось или достигло своих пределов.

Ответ: Подробнее смотри раздел Create Transaction Response. ID транзакции также является ID предложения.

13.27.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=publishExchangeOffer&
    currency=6520756875632314476&
    buyRateNQT=10000000&
    sellRateNQT=20000000&	
    totalBuyLimit=1000&
    totalSellLimit=1000&
    initialBuySupply=500&
    initialSellSupply=500&
    expirationHeight=163080&
    secretPhrase=SECRETPHRASE&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "6fd60fcbc6e7022f12adad82a76c0534d2f79a569b9857b02328bf7573cf93f8",
    "unsignedTransactionBytes": "0514d7c409023c0010f09c34f225d425306e5be55a49469081...",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "b204a7d9622ac6b99936447a4314fac1c2f0c67e45f4021f4b1949755c081802a34...",
        "feeNQT": "100000000",
        "type": 5,
        "fullHash": "fccb2c6200a04bbce82b9e623051b8d8ed9d519dbb0a12ec5a354c842da9a664",
        "version": 1,
        "ecBlockId": "6813726597245349906",
        "signatureHash": "6fd60fcbc6e7022f12adad82a76c0534d2f79a569b9857b02328bf7573cf93f8",
        "attachment": {
            "totalSellLimit": "1000",
            "buyRateNQT": "10000000",
            "initialSellSupply": "500",
            "totalBuyLimit": "1000",
            "expirationHeight": 163080,
            "sellRateNQT": "20000000",
            "version.PublishExchangeOffer": 1,
            "currency": "6520756875632314476",
            "initialBuySupply": "500"
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 4,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "ecBlockHeight": 163049,
        "deadline": 60,
        "transaction": "13568114225891298300",
        "timestamp": 34194647,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 54,
    "transactionBytes": "0514d7c409023c0010f09c34f225d425306e5be55a4946908156072...",
    "transaction": "13568114225891298300"
}

Verified 06-Feb-15

13.28 Search Currencies

Возвращает валюты имеющих код соответствующий заданному запросу в порядке обратной релевантности.

Запрос:

  • requestType это searchCurrencies
  • query полный текстовый запрос по полю валюты code в стандартном синтаксисе Lucene
  • firstIndex индекс (начиная с 0) первой возвращаемой валюты (опционально)
  • lastIndex индекс (начиная с 0) последней возвращаемой валюты (опционально)
  • includeCounts установите false если поля начинающиеся с numberOf... должны быть опущены (опционально)

Ответ:

  • currencies (A) массив из объектов валют (Подробнее смотри Get Currency)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

13.28.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=searchCurrencies&
    query=MYST?

Ответ:

{
    "requestProcessingTime": 5,
    "currencies": [
        {
            "initialSupply": "10000",
            "currentReservePerUnitNQT": "0",
            "types": [
                "EXCHANGEABLE"
            ],
            "code": "MYSTX",
            "creationHeight": 159726,
            "minDifficulty": 0,
            "numberOfTransfers": 3,
            "description": "Exchangeable",
            "minReservePerUnitNQT": "0",
            "currentSupply": "10000",
            "issuanceHeight": 0,
            "type": 1,
            "reserveSupply": "0",
            "maxDifficulty": 0,
            "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "decimals": 2,
            "name": "MystcoinX",
            "numberOfExchanges": 0,
            "currency": "9387514940677621191",
            "maxSupply": "10000",
            "account": "15295723609781267838",
            "algorithm": 0
        }
    ]
}

Verified 06-Feb-15

13.29 Transfer Currency

Трансфер (передача) валюты заданному получателю. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это transferCurrency
  • recipient ID аккаунта получателя передачи
  • currency ID валюты
  • units количество (в QNT) которое будет передано

Ответ: Подробнее смотри раздел Create Transaction Response.

13.29.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=transferCurrency&
    recipient=NXT-BMUV-8QQR-47VK-CR7F3&
    currency=9387514940677621191&
    units=10

Ответ:

{
    "signatureHash": "eda8f238d164074170ddb8163d7d71f08062f1f1a51712f05670a670e64e5eff",
    "unsignedTransactionBytes": "0513ad150b023c0010f09c34f225d425306e5be55a49469081...",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "7629cba6e776685c9e134f8d96c54a5bcad6915c433f833b1ca792c69e75ee0ac6f...",
        "feeNQT": "100000000",
        "type": 5,
        "fullHash": "d65a8adfc6b06da98ce50bb36d52305a8c9300b8defbeed9f2582628d9e258f0",
        "version": 1,
        "ecBlockId": "13770841487927223834",
        "signatureHash": "eda8f238d164074170ddb8163d7d71f08062f1f1a51712f05670a670e64e5eff",
        "attachment": {
            "currency": "9387514940677621191",
            "version.CurrencyTransfer": 1,
            "units": "10"
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 3,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
        "recipient": "11580081983047651163",
        "ecBlockHeight": 159721,
        "deadline": 60,
        "transaction": "12208608533071682262",
        "timestamp": 34280877,
        "height": 2147483647
    },
    "broadcasted": true,
    "requestProcessingTime": 8,
    "transactionBytes": "0513ad150b023c0010f09c34f225d425306e5be55a49469081560...",
    "fullHash": "d65a8adfc6b06da98ce50bb36d52305a8c9300b8defbeed9f2582628d9e258f0",
    "transaction": "12208608533071682262"
}

Verified 06-Feb-15

14 Networking Operations

14.1 Add Peer

Add a peer to the list of known peers and attempt to connect to it. Password protected like the Debug Operations. POST only.

Запрос:

  • requestType это addPeer
  • peer IP адрес или доменное имя узла (опционально - плюс порт)

Response: refer to Get Peer

  • isNewlyAdded is true if the peer was not already known, omitted otherwise

14.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=addPeer&
    peer=nxt9.webice.ru

Ответ:

{
    "hallmark": "4a8fd0f2af5f511e041ad7bee1625ae3a711ddcc056c60cf7ab3523e2c99092f0e006e...",
    "downloadedVolume": 155414,
    "address": "23.95.51.154",
    "weight": 19829,
    "uploadedVolume": 63532,
    "requestProcessingTime": 478,
    "version": "1.4.8",
    "platform": "webice.ru",
    "lastUpdated": 37014605,
    "blacklisted": false,
    "announcedAddress": "nxt9.webice.ru",
    "application": "NRS",
    "state": 1,
    "shareAddress": true
}

Verified 11-Jun-15

14.2 Blacklist Peer

Blacklist a peer for the default blacklisting period. Password protected like the Debug Operations. POST only.

Запрос:

  • requestType это blacklistPeer
  • peer IP адрес или доменное имя узла (опционально - плюс порт)

Ответ:

  • done (B) true если узел в черном списке
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

14.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=blacklistedPeer&
    peer=nxt9.webice.ru

Ответ:

{
    "requestProcessingTime": 0,
    "done": true
}

Verified 11-Jun-15

14.3 Get Inbound Peers

Get all peers that have sent a request to this peer in the last 30 minutes.

Request:

  • requestType is getInboundPeers
  • includePeerInfo is true to include peer information, otherwise include only the address (optional)

Response:

  • peers (A) is an array of peer addresses or peer objects (refer to Get Peer for details) depending on includePeerInfo
  • requestProcessingTime (N) is the API request processing time (in millisec)

14.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getInboundPeers

Ответ:

{
    "peers": [],
    "requestProcessingTime": 1
}

Verified 11-Jun-15

14.4 Get My Info

Возвращает имя хоста и адрес указанного узла.

Запрос:

  • requestType это getMyInfo

Ответ:

  • host (S) имя хоста узла
  • address (S) адрес узла
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

14.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getMyInfo

Ответ:

{
    "address": "127.0.0.1",
    "host": "127.0.0.1",
    "requestProcessingTime": 1
}

Verified 14-Dec-14

14.5 Get Peer

Возвращает информацию о заданном узле.

Запрос:

  • requestType это getPeer
  • peer IP адрес узла.

Ответ:

  • hallmark (S) шестнадцатеричная строка клейма узла, если он определен
  • downloadedVolume (N) количество байт загруженных узлом
  • address (S) IP адрес или DNS имя узла
  • weight (N) значение веса узла
  • uploadedVolume (N) количество байт выгруженных узлом
  • version (S) версия программного обеспечения работающего на узле
  • platform (S) строка описывающая платформу на которой работает узел
  • lastUpdated (N) метка времени (в секундах с момента создания генезисного блока) последнего обновления статуса узла
  • blacklisted (B) возвращает true если узел в черном списке
  • announcedAddress (S) имя которое узел анонсирует сети (может быть DNS имя, IP адрес, или любая другая строка)
  • application (S) имя программного обеспечения узла, обычно NRS
  • state (N) определяет состояние узла: 0 для NON_CONNECTED, 1 для CONNECTED, или 2 для DISCONNECTED
  • shareAddress (B) true, если адрес поддерживает работу с другими узлами
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

14.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getPeer&
    peer=75.128.106.176

Ответ:

{
    "hallmark": "1babaff947607837e6591e8f216d449c4e6e9786496a9d26ac0ca9cae...",
    "downloadedVolume": 1244,
    "weight": 235,
    "uploadedVolume": 217380,
    "requestProcessingTime": 1,
    "version": "1.3.3",
    "platform": "phalanx",
    "lastUpdated": 31181426,
    "blacklisted": false,
    "announcedAddress": "phalanx149.ddns.net",
    "application": "NRS",
    "state": 1,
    "shareAddress": true
}

Verified 14-Dec-14

14.6 Get Peers

Получает список IP адресов узлов.

Запрос:

  • requestType это getPeers
  • active установите true для активных (не NON_CONNECTED) узлов только (опционально, если true аннулирует state)
  • state состояние узла, одно из NON_CONNECTED, CONNECTED, или DISCONNECTED (опционально)
  • getPeers установите true чтобы включить подробности у узле как в Get Peer

Примечание: Если ни active ни state не заданы, будут возвращены все известные узлы.

Ответ:

  • peers (A) массив адресов узлов
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

14.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getPeers&
    state=DISCONNECTED

Ответ:

{
    "peers": [
        "198.50.146.93",
        "213.46.57.77"
    ],
    "requestProcessingTime": 1
}

Verified 14-Dec-14

15 Phasing Operations

Phasing (фазинг) реализован для тестовой сети начиная с версии version 1.5.0e, в основной сети активирован с блока 445.000 и версии version 1.5.10.

15.1 Approve Transaction

Approve (vote for) a phased transaction. POST only.

Request: Refer to Create Transaction Request for common parameters.

  • requestType is approveTransaction
  • transactionFullHash is the full hash of the transaction to be approved (may be used up to 10 times per API request)
  • revealedSecretText is the secret phrase text (required only for phasingVotingModel = 5 (refer to Create Phasing Poll), optional if revealedSecret provided)
  • revealedSecret is the UTF-8 hexadecimal encoding of revealedSecretText (optional)

Note: This transaction will be accepted in the blockchain only if all phased transactions it is voting for are already in it.

Ответ: Подробнее смотри в разделе Create Transaction Response.

15.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=approveTransaction&
    transactionFullHash=5016cc59b0665675f00513e8c647288e0a668a78c4964c84d0de8f768b89060a&
    revealedSecretText=secret&
    secretPhrase=secretPhrase&
    feeNQT=100000000&
    deadline=60

Ответ:

{
    "signatureHash": "db429ccecd7d13b54b43cf9db7656cef6df6152c60e626b393000ed00a652c95",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "380e1a94e40d58e9382aa742ca998373e27c5d30890d91a74d83bfead849e507e93c51...",
        "feeNQT": "100000000",
        "type": 1,
        "fullHash": "2bb80af156e70067f509df9ad5a88b687040cff4a8c778c69aef77863d3d15ef",
        "version": 1,
        "phased": false,
        "ecBlockId": "704052112466096836",
        "signatureHash": "db429ccecd7d13b54b43cf9db7656cef6df6152c60e626b393000ed00a652c95",
        "attachment": {
            "transactionFullHashes": [
                "5016cc59b0665675f00513e8c647288e0a668a78c4964c84d0de8f768b89060a"
            ],
            "version.PhasingVoteCasting": 1,
            "revealedSecret": "736563726574"
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 9,
        "amountNQT": "0",
        "sender": "15295723609781267838",
        "ecBlockHeight": 262493,
        "deadline": 60,
        "transaction": "7422186546503792683",
        "timestamp": 43965004,
        "height": 2147483647
    },
    "unsignedTransactionBytes": "01194cda9e023c0010f09c34f225d425306e5be55a494690...",
    "broadcasted": true,
    "requestProcessingTime": 20,
    "transactionBytes": "01194cda9e023c0010f09c34f225d425306e5be55a4946908156072a...",
    "fullHash": "2bb80af156e70067f509df9ad5a88b687040cff4a8c778c69aef77863d3d15ef",
    "transaction": "7422186546503792683"
}

Verified 11-Jun-15

15.2 Create Phasing Poll

Create a phased transaction with conditional deferred execution based on the result of a phasing poll, on a list of linked transactions or on the revelation of a secret; or simply with unconditional deferred execution. POST only.

Request: Refer to Create Transaction Request for common parameters.

  • requestType is any type from the Create Transaction list which is phasing-safe, indicated with italics such as Send NXT, the requestType of which is sendMoney
  • phased is true to create a phased transaction (optional but required for all of the following parameters, which are all optional for unphased transactions)
  • phasingFinishHeight is the block height at which the poll will finish; the transaction will be executed at this block height only if all conditions (if any) have been met, otherwise the transaction will never be executed
  • phasingVotingModel is -1 for unconditional transaction execution (no phasing poll), 0 for One Vote Per Account, 1 for Vote By NXT Balance, 2 for Vote By Asset Balance, 3 for Vote By Currency Balance, 4 is for One Vote Per Linked Transaction and 5 is Vote by Secret
  • phasingQuorum is the number of votes needed for transaction approval: 0 for voting model -1, the number of accounts for model 0, total NQT for model 1, total QNT for models 2 and 3, the number of transactions for model 4 and 1 for model 5 (required if phasingVotingModel >= 0, default 0)
  • phasingMinBalance is the minimum balance (in NQT or QNT) required for voting (optional, default 0)
  • phasingMinBalanceModel is 1 for NXT balance, 2 for an asset balance, 3 for a currency balance (required if phasingMinBalance > 0, must match phasingVotingModel when phasingVotingModel = 1, 2 or 3)
  • phasingHolding is the asset or currency ID (required if phasingMinBalanceModel > 1)
  • phasingWhitelisted is the account ID of an account allowed to vote for the transaction; once used, only whitelisted accounts are allowed to vote (optional, may be used up to ten times per API request)
  • phasingLinkedFullHash is the full hash of a transaction that must be in the blockchain at the phasingFinishHeight; transactions already in the blockchain before the acceptance of the phased transaction can also be linked, as long as they are not more than 60 days old, or themselves phased transactions (required only for voting model 4, may be used up to ten times per API request)
  • phasingHashedSecret is the hash of a secret phrase (up to 100 bytes long) required for approval (required only for voting model 5)
  • phasingHashedSecretAlgorithm is the hash function used: 2 for SHA256, 6 for RIPEMD160 and 62 for SHA256 followed by RIPEMD160, according to Get Constants (required for a phasingHashedSecret)

Note: When a balance affects the poll result, the result depends only on the balance (including pending outgoing phased transfers) computed just prior to the finish height.

Ответ: Подробнее смотри в разделе Create Transaction Response.

15.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=sendMoney&
    recipient=NXT-BMUV-8QQR-47VK-CR7F3&
    secretPhrase=secretPhrase&
    feeNQT=200000000&
    deadline=60&
    phased=true&
    phasingFinishHeight=261550&
    phasingVotingModel=0&
    phasingQuorum=2

Ответ:

{
    "signatureHash": "df6c2dfcaf17f83256cfe388f408e091c08f208a060d54d1fbdb407ffdca121c",
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "418a5453329d6c8d29b1b49dff30653a7f1e66992cece404d8ae997413deaa015b749a...",
        "feeNQT": "200000000",
        "type": 0,
        "fullHash": "6fd876512477ef4fab089ec2ffa084d6db75ba3cd0cef2541675515470dca374",
        "version": 1,
        "phased": true,
        "ecBlockId": "17522485785088843392",
        "signatureHash": "df6c2dfcaf17f83256cfe388f408e091c08f208a060d54d1fbdb407ffdca121c",
        "attachment": {
            "phasingFinishHeight": 261550,
            "phasingHolding": "0",
            "phasingQuorum": "2",
            "version.Phasing": 1,
            "phasingMinBalance": "0",
            "phasingMinBalanceModel": 0,
            "version.OrdinaryPayment": 0,
            "phasingVotingModel": 0
        },
        "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
        "subtype": 0,
        "amountNQT": "2000000000",
        "sender": "15295723609781267838",
        "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
        "recipient": "11580081983047651163",
        "ecBlockHeight": 261454,
        "deadline": 60,
        "transaction": "5759953446299424879",
        "timestamp": 43874749,
        "height": 2147483647
    },
    "unsignedTransactionBytes": "0010bd799d023c0010f09c34f225d425306e5be55a494690...",
    "broadcasted": true,
    "requestProcessingTime": 760,
    "transactionBytes": "0010bd799d023c0010f09c34f225d425306e5be55a4946908156072a...",
    "fullHash": "6fd876512477ef4fab089ec2ffa084d6db75ba3cd0cef2541675515470dca374",
    "transaction": "5759953446299424879"
}

Verified 11-Jun-15

15.3 Get Account Phased Transaction Count

Get the number of pending phased transactions associated with an account given the account ID.

Запрос:

  • requestType это getAccountPhasedTransactionCount
  • account ID аккаунта

Response:

  • numberOfPhasedTransactions (N) число незаконченных фазированных (поэтапных) транзакций
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

15.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountPhasedTransactionCount&
    account=15295723609781267838

Ответ:

{
    "requestProcessingTime": 1,
    "numberOfPhasedTransactions": 3
}

Verified 11-Jun-15

15.4 Get Account Phased Transactions

Get pending phased transactions associated with an account given the account ID in reverse chronological creation order.

Запрос:

  • requestType 'nj getAccountPhasedTransactions
  • account ID аккаунта
  • firstIndex индекс (начиная с 0) первой возвращаемой фазированной транзакции (опционально)
  • lastIndex индекс (начиная с 0) последней возвращаемой фазированной транзакции (опционально)

Ответ: Подробнее смотри в разделе Get Transaction.

15.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAccountPhasedTransactions&
    account=15295723609781267838&
    lastIndex=0

Ответ:

{
    "requestProcessingTime": 2,
    "transactions": [
        {
            "signature": "803d3fad7076bfe3f48a8ced40bb7075539858bf2b9d23b7653671a7204e6108234d...",
            "transactionIndex": 0,
            "type": 0,
            "phased": true,
            "ecBlockId": "14167949999961480077",
            "signatureHash": "693b18675d813dcc2de1a889fd919d0c4a0eaa679df0b0f8b0ec703bc2e278d4",
            "attachment": {
                "phasingFinishHeight": 262450,
                "phasingHolding": "17091401215301664836",
                "phasingQuorum": "500",
                "version.Phasing": 1,
                "phasingMinBalance": "100",
                "phasingMinBalanceModel": 2,
                "version.OrdinaryPayment": 0,
                "phasingVotingModel": 2
            },
            "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "subtype": 0,
            "amountNQT": "500000000",
            "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "block": "11015494088798322289",
            "blockTimestamp": 43957876,
            "deadline": 60,
            "timestamp": 43957682,
            "height": 262418,
            "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
            "feeNQT": "2100000000",
            "confirmations": 27,
            "fullHash": "e57462c46447f8bd7a0bafd9ab65bde8743ca6c13213185271d7ea6c48118861",
            "version": 1,
            "sender": "15295723609781267838",
            "recipient": "11580081983047651163",
            "ecBlockHeight": 262409,
            "transaction": "13688769565509711077"
        }
   ]
}

Verified 11-Jun-15

15.5 Get Asset Phased Transactions

Get pending phased transactions based on an asset in reverse chronological creation order. These transactions can be considered transaction approval requests.

Request:

  • requestType is getAssetPhasedTransactions
  • asset is the asset ID
  • account is an account ID of the account that created the phased transactions (optional)
  • withoutWhitelist is true to omit phased transactions that include a whitelist (optional)
  • firstIndex is a zero-based index to the first phased transaction to retrieve (optional)
  • lastIndex is a zero-based index to the last phased transaction to retrieve (optional)

Ответ: Подробнее смотри в разделе Get Transaction.

15.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getAssetPhasedTransactions&
    asset=17091401215301664836

Ответ:

{
    "requestProcessingTime": 2,
    "transactions": [
        {
            "signature": "803d3fad7076bfe3f48a8ced40bb7075539858bf2b9d23b7653671a7204e6108234d...",
            "transactionIndex": 0,
            "type": 0,
            "phased": true,
            "ecBlockId": "14167949999961480077",
            "signatureHash": "693b18675d813dcc2de1a889fd919d0c4a0eaa679df0b0f8b0ec703bc2e278d4",
            "attachment": {
                "phasingFinishHeight": 262450,
                "phasingHolding": "",
                "phasingQuorum": "500",
                "version.Phasing": 1,
                "phasingMinBalance": "100",
                "phasingMinBalanceModel": 2,
                "version.OrdinaryPayment": 0,
                "phasingVotingModel": 2
            },
            "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "subtype": 0,
            "amountNQT": "500000000",
            "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "block": "11015494088798322289",
            "blockTimestamp": 43957876,
            "deadline": 60,
            "timestamp": 43957682,
            "height": 262418,
            "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
            "feeNQT": "2100000000",
            "confirmations": 27,
            "fullHash": "e57462c46447f8bd7a0bafd9ab65bde8743ca6c13213185271d7ea6c48118861",
            "version": 1,
            "sender": "15295723609781267838",
            "recipient": "11580081983047651163",
            "ecBlockHeight": 262409,
            "transaction": "13688769565509711077"
        }
   ]
}

Verified 11-Jun-15

15.6 Get Currency Phased Transactions

Get pending phased transactions based on a currency in reverse chronological creation order. These transactions can be considered transaction approval requests.

Request:

  • requestType is getCurrencyPhasedTransactions
  • currency is the currency ID
  • account is an account ID of the account that created the phased transactions (optional)
  • withoutWhitelist is true to omit phased transactions that include a whitelist (optional)
  • firstIndex is a zero-based index to the first phased transaction to retrieve (optional)
  • lastIndex is a zero-based index to the last phased transaction to retrieve (optional)

Ответ: Подробнее смотри в разделе Get Transaction.

15.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getCurrencyPhasedTransactions&
    currency=12366259387060174981

Ответ:

{
    "requestProcessingTime": 2,
    "transactions": [
        {
            "signature": "ec467483307c73c08e7e9195eeddf23ce129ce30d703881cca505cbb0569c2009...",
            "transactionIndex": 0,
            "type": 0,
            "phased": true,
            "ecBlockId": "7353294686633135686",
            "signatureHash": "12cc1d54a453c3d1231b991a54f3323db6a51c00387ca5480db268164d5b7cfa",
            "attachment": {
                "phasingFinishHeight": 263500,
                "phasingHolding": "12366259387060174981",
                "phasingQuorum": "100",
                "version.Phasing": 1,
                "phasingMinBalance": "10",
                "phasingMinBalanceModel": 3,
                "version.OrdinaryPayment": 0,
                "phasingVotingModel": 3
            },
            "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "subtype": 0,
            "amountNQT": "800000000",
            "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "block": "699750272975612223",
            "blockTimestamp": 44042909,
            "deadline": 60,
            "timestamp": 44042827,
            "height": 263430,
            "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
            "feeNQT": "4100000000",
            "confirmations": 2,
            "fullHash": "5799d135aacf48a317c813fea405c317e7ab90888afb701b92c17914744f244f",
            "version": 1,
            "sender": "15295723609781267838",
            "recipient": "11580081983047651163",
            "ecBlockHeight": 263424,
            "transaction": "11765882356459739479"
        }
    ]
}

Verified 11-Jun-15

15.7 Get Phasing Poll

Get the details of a phasing poll.

Request:

  • requestType is getPhasingPoll
  • transaction is the transaction ID of the phasing poll
  • countVotes is true to compute the poll result while the votes are still available (optional)

Response:

  • transaction (S) is the transaction ID of the phasing poll
  • account (S) is the number of the account that created the phasing poll
  • accountRS (S) is the Reed-Solomon address of the account that created the phasing poll
  • finishHeight (N) is the block height at which the poll finished or will finish
  • votingModel (N) is the voting model (refer to Create Transaction Request)
  • quorum (S) is the minimum number of votes needed to approve the poll
  • transactionFullHash (S) is the full hash of the phasing poll transaction
  • finished (B) is true if the poll is finished, false otherwise (omitted if finished is false)
  • result (S) is the sum of the result of each account that approved (voted for) the transaction; an account's result is 1 if the voting model is 0, 4 or 5; it is the NQT, asset QNT or currency QNT balance of the account if the voting model is 1, 2 or 3 respectively; however, the result is 0 if minBalance is not met
  • approved (B) is true if the poll was approved, false otherwise
  • minBalance (S) is the required minimum balance of voting accounts to be eligible to vote
  • minBalanceModel (N) is the minimum balance model (refer to Create Transaction Request)
  • hashedSecret (S) is the hash of a secret that must be included in each approval (vote) transaction for the approval to be accepted (refer to Create Transaction Request)
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • linkedFullHashes (A) is an array of full hashes of linked transactions (omitted if votingModel != 4)
  • whitelist (A) is an array of whitelist objects containing the following two fields (omitted if votingModel != 5):
    • whitelisted (S) is the number of the whitelisted account
    • whitelistedRS (S) is the Reed-Solomon address of the whitelisted account

15.7.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getPhasingPoll&
    transaction=15402897900571339064

Ответ:

{
    "votingModel": 0,
    "quorum": "2",
    "transactionFullHash": "38292a530816c2d5693bf5d0afb20847a3c4d2f37c3665fd294a7d2fdc278d56",
    "finished": true,
    "whitelist": [
        {
            "whitelistedRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "whitelisted": "11580081983047651163"
        },
        {
            "whitelistedRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "whitelisted": "15295723609781267838"
        }
    ],
    "requestProcessingTime": 1,
    "result": "2",
    "approved": true,
    "minBalance": "0",
    "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
    "finishHeight": 259600,
    "minBalanceModel": 0,
    "transaction": "15402897900571339064",
    "account": "15295723609781267838",
    "hashedSecret": ""
}

Verified 11-Jun-15

15.8 Get Phasing Poll Vote

Get a cast phasing poll vote given a phased transaction ID and an account ID of a voter, if it is still available.

Request:

  • requestType is getPhasingPollVote
  • transaction is the phased transaction ID
  • account is the account ID of a voter in the poll

Response:

  • voter (S) is the account ID of the voter in the poll
  • voterRS (S) is the Reed-Solomon address of the voter
  • transaction (S) is the phased transaction ID
  • requestProcessingTime (N) is the API request processing time (in millisec)

15.8.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getPhasingPollVote&
    transaction=12580288379938056583&
    account=15295723609781267838

Ответ:

{
    "voterRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
    "voter": "15295723609781267838",
    "requestProcessingTime": 1,
    "transaction": "9761138556025135837"
}

Verified 11-Jun-15

15.9 Get Phasing Poll Votes

Get all cast phasing poll votes in a phasing poll given a phased transaction ID, if they are still available.

Request:

  • requestType is getPhasingPollVotes
  • transaction is the phased transaction ID
  • firstIndex is a zero-based index to the first vote to retrieve (optional)
  • lastIndex is a zero-based index to the last vote to retrieve (optional)

Ответ: Подробнее смотри в разделе Get Phasing Poll Vote

15.9.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getPhasingPollVotes&
    account=12580288379938056583

Response:

{
    "votes": [
        {
            "voterRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "voter": "15295723609781267838",
            "transaction": "9761138556025135837"
        }
    ],
    "requestProcessingTime": 2
}

Verified 17-Apr-15

15.10 Get Phasing Polls

Get phasing poll details given multiple phased transaction IDs.

Request:

  • requestType is getPhasingPolls
  • transaction is one of the multiple phased transaction IDs
  • transaction is one of the multiple phased transaction IDs

  • countVotes is true to compute the poll result while the votes are still available (optional)

Response: Refer to Get Phasing Poll.

15.10.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getPhasingPolls&
    transaction=12580288379938056583&
    transaction=13688769565509711077&
    countVotes=true

Response:

{
    "polls": [
        {
            "votingModel": 1,
            "quorum": "100000000000",
            "transactionFullHash": "87a92edaa02996aeaf59a619ca513563775870c2b8ca490b61b02535745cdd34",
            "finished": true,
            "whitelist": [],
            "result": "186700000000",
            "approved": true,
            "minBalance": "10000000000",
            "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "finishHeight": 262450,
            "minBalanceModel": 1,
            "transaction": "12580288379938056583",
            "account": "15295723609781267838",
            "hashedSecret": ""
        },
        {
            "votingModel": 2,
            "quorum": "500",
            "transactionFullHash": "e57462c46447f8bd7a0bafd9ab65bde8743ca6c13213185271d7ea6c48118861",
            "finished": true,
            "whitelist": [],
            "result": "500",
            "holding": "17091401215301664836",
            "approved": true,
            "minBalance": "100",
            "accountRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "finishHeight": 262450,
            "minBalanceModel": 2,
            "transaction": "13688769565509711077",
            "account": "15295723609781267838",
            "hashedSecret": ""
        }
    ],
    "requestProcessingTime": 1
}

Verified 17-Apr-15

15.11 Get Voter Phased Transactions

Get pending phased transactions which include a whitelist in reverse chronological creation order. These transactions can be considered transaction approval requests.

Request:

  • requestType is getVoterPhasedTransactions
  • account is a whitelisted account ID included in the phased transactions
  • firstIndex is a zero-based index to the first phased transaction to retrieve (optional)
  • lastIndex is a zero-based index to the last phased transaction to retrieve (optional)

Response: Refer to Get Transaction for details.

15.11.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getVoterPhasedTransactions&
    account=15295723609781267838

Response:

{
    "requestProcessingTime": 1,
    "transactions": [
        {
            "signature": "e527fce6591049b61d232ebbf4171319ae4e208f34d8a055ffb09f07dec7d9033527...",
            "transactionIndex": 0,
            "type": 0,
            "phased": true,
            "ecBlockId": "13625660527605830055",
            "signatureHash": "2a3cc644b1cb48130a172de92a418d48522b45a25a36d4d48c2347f032e430ab",
            "attachment": {
                "phasingFinishHeight": 263850,
                "phasingHolding": "0",
                "phasingQuorum": "2",
                "version.Phasing": 1,
                "phasingWhitelist": [
                    "11580081983047651163",
                    "15295723609781267838"
                ],
                "phasingMinBalance": "0",
                "phasingMinBalanceModel": 0,
                "version.OrdinaryPayment": 0,
                "phasingVotingModel": 0
            },
            "senderRS": "NXT-4VDY-LNVT-LMAY-FMCKA",
            "subtype": 0,
            "amountNQT": "1100000000",
            "recipientRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "block": "16550954176569210781",
            "blockTimestamp": 44074579,
            "deadline": 1440,
            "timestamp": 44074556,
            "height": 263813,
            "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
            "feeNQT": "200000000",
            "confirmations": 0,
            "fullHash": "b54a7e14c910e0750af0b29c0328347e27411dbe5d158d5d358ee2165b781968",
            "version": 1,
            "sender": "15295723609781267838",
            "recipient": "11580081983047651163",
            "ecBlockHeight": 263804,
            "transaction": "8493807353039047349"
        }
    ]
}

Verified 18-Apr-15

16 Операции с Информацией о Сервере

16.1 Event Register

Create, modify or remove an event listener which can report server events via Event Wait. POST only.

Request:

  • requestType is eventRegister
  • event is one of multiple server events from the following list of event names: (optional, default is all possible events)
    • Block.BLOCK_GENERATED
    • Block.BLOCK_POPPED
    • Block.BLOCK_PUSHED
    • Peer.ADD_INBOUND
    • Peer.ADDED_ACTIVE_PEER
    • Peer.BLACKLIST
    • Peer.CHANGED_ACTIVE_PEER
    • Peer.DEACTIVATE
    • Peer.NEW_PEER
    • Peer.REMOVE
    • Peer.REMOVE_INBOUND
    • Peer.UNBLACKLIST
    • Transaction.ADDED_CONFIRMED_TRANSACTIONS
    • Transaction.ADDED_UNCONFIRMED_TRANSACTIONS
    • Transaction.REJECT_PHASED_TRANSACTION
    • Transaction.RELEASE_PHASED_TRANSACTION
    • Transaction.REMOVE_UNCONFIRMED_TRANSACTIONS
  • event is one of multiple server events (optional)

  • add is true to add events to an existing listener (optional, omit if remove is true)
  • remove is true to remove events from an existing listener (optional, omit if add is true)

Note: To create a new event listener, omit both add and remove. To remove an existing event listener, set remove to true and omit event; all registered events will be removed, any outstanding Event Wait will be completed and the listener will be deactivated.

Note: An event listener is automatically deactivated whenever all registered events are removed or if Event Wait is not called frequently enough, according to the nxt.apiEventTimeout property. The timeout is not precise; the removal process runs every nxt.apiEventTimeout / 2 seconds, so that many extra seconds may elapse before removal; the first Event Wait call should be made immediately after registration to avoid deactivation.

Note: Each API user (with a unique address) can create only one event listener. When a new one is created, it will replace an existing one. The maximum number of unique users is controlled by the nxt.maxEventUsers property.

Response:

  • registered is true if the operation completed successfully
  • requestProcessingTime (N) is the API request processing time (in millisec)

16.1.1 Example

Request:

http://localhost:7876/nxt?
    requestType=eventRegister

Response:

{
    "registered": true,
    "requestProcessingTime": 5780
}

Verified 16-May-15

16.2 Event Wait

Wait for events registered with Event Register. POST only.

Request:

  • requestType is eventWait
  • timeout is the amount of time (in seconds) to wait for an event before the call returns (optional, default and maximum is the nxt.apiEventTimeout property)

Notes: The call returns immediately if one or more events have occurred since the last call; multiple events are all returned together. If a new call is made before the last one returns, the timeout timer resets to the new value. Event registration expires if wait calls are not made frequently enough, according to the nxt.apiEventTimeout property.

Response:

  • events (A) is an array of event objects each of which has the following fields:
    • name (S) is the name of the event (refer to Event Register for the list of event names)
    • ids (A) is an array of identifiers, depending on the type of event:
      • block string identifier (S) for a block event
      • peer network address (S) for a peer event
      • transaction string identifier (S) for a transaction event
  • requestProcessingTime (N) is the API request processing time (in millisec)

16.2.1 Example

Request:

http://localhost:7876/nxt?
    requestType=eventWait

Response:

{
    "requestProcessingTime": 0,
    "events": [
        {
            "name": "Block.BLOCK_PUSHED",
            "ids": [
                "11748297033830700369"
            ]
        },
        {
            "name": "Transaction.REMOVED_UNCONFIRMED_TRANSACTIONS",
            "ids": []
        },
        {
            "name": "Peer.ADDED_ACTIVE_PEER",
            "ids": [
                "178.150.207.53"
            ]
        }
    ]
}

Verified 16-May-15

16.3 Get Blockchain Status

Возвращает статус blockchain.

Запрос:

  • requestType это getBlockchainStatus

Ответ:

  • lastBlock (S) ID последнего блока в blockchain
  • application (S) название приложения, как правило NRS
  • isScanning (B) возвратит true если blockchain сканируется приложением, false в противном случае
  • cumulativeDifficulty (S) суммарная сложность
  • lastBlockchainFeederHeight (N) высота последнего blockchain самой большой суммарной сложности, полученной от узла
  • numberOfBlocks (N) количество блоков в blockchain (высота + 1)
  • time (N) текущая метка времени (в секундах от времени создания генезисного блока)
  • version (S) версия приложения
  • lastBlockchainFeeder (S) адрес или опубликованный узлами адрес, содержащий последний blockchain с самой большой суммарной сложностью
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

16.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getBlockchainStatus

Ответ:

{
    "lastBlock": "13550158957448265604",
    "application": "NRS",
    "isScanning": false,
    "cumulativeDifficulty": "10466581687632679",
    "lastBlockchainFeederHeight": 281637,
    "numberOfBlocks": 281638,
    "time": 30410779,
    "requestProcessingTime": 0,
    "version": "1.3.2",
    "lastBlockchainFeeder": "nxt01.now.im"
}

Verified 14-Dec-14

16.4 Get Constants

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

Запрос:

  • requestType это getConstants

Ответ:

  • maxBlockPayloadLength (N) максимальная длина полезной нагрузки блока (в байтах)
  • genesisAccountId (S) генезисный аккаунт
  • genesisBlockId (S) ID генезисного блока
  • transactionTypes (A) массив определенных типов и подтипов транзакций (см. пример ниже),
  • peerStates (A) массив с определенными статусами узлов (см. пример ниже)
  • maxArbitraryMessageLength (N) максимальная длинна (в байтах) произвольного сообщения
  • currencyTypes (A) массив определенных типов валюты (см. пример ниже)

16.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getConstants

Ответ:

{
    "maxBlockPayloadLength": 44880,
    "genesisAccountId": "1739068987193023818",
    "genesisBlockId": "2680262203532249785",
    "transactionTypes": [
        {
            "description": "Payment",
            "value": 0,
            "subtypes": [
                {"description": "Ordinary payment", "value": 0}
            ]
        },
        {
            "description": "Messaging",
            "value": 1,
            "subtypes": [
                {"description": "Arbitrary message", "value": 0},
                {"description": "Alias assignment", "value": 1},
                {"description": "Alias sell", "value": 6},
                {"description": "Alias buy", "value": 7},
                {"description": "Poll creation", "value": 2},
                {"description": "Vote casting", "value": 3},
                {"description": "Hub terminal announcement", "value": 4},
                {"description": "Account info", "value": 5}
            ]
        },
        {
            "description": "Colored coins",
            "value": 2,
            "subtypes": [
                {"description": "Asset issuance", "value": 0},
                {"description": "Asset transfer", "value": 1},
                {"description": "Ask order placement", "value": 2},
                {"description": "Bid order placement", "value": 3},
                {"description": "Ask order cancellation", "value": 4},
                {"description": "Bid order cancellation", "value": 5}
            ]
        },
        {
            "description": "Digital goods",
            "value": 3,
            "subtypes": [
                {"description": "Listing", "value": 0},
                {"description": "Delisting", "value": 1},
                {"description": "Price change", "value": 2},
                {"description": "Quantity change", "value": 3},
                {"description": "Purchase", "value": 4},
                {"description": "Delivery", "value": 5},
                {"description": "Feedback", "value": 6},
                {"description": "Refund", "value": 7}
            ]
        },
        {
            "description": "Account Control",
            "value": 4,
            "subtypes": [
                {"description": "Effective balance leasing", "value": 0}
            ]
        }
    ],
    "peerStates": [
        {"description": "Non-connected", "value": 0},
        {"description": "Connected", "value": 1},
        {"description": "Disconnected", "value": 2}
    ],
    "maxArbitraryMessageLength": 1000
}

Verified 14-Dec-14

16.5 Get Plugins

Get a list of all installed plugins on the server.

Request:

  • requestType is getPlugins

Response:

  • plugins (A) is an array of plugin names (S)
  • requestProcessingTime (N) is the API request processing time (in millisec)

16.5.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getPlugins

Response:

{
    "plugins": [
        "hello_world"
    ],
    "requestProcessingTime": 9
}

Verified 28-Apr-15

16.6 Get State

Получает состояние серверов узлов и сети.

Запрос:

  • requestType это getState
  • includeCounts установите в false если необходимо чтобы начало записей numberOf... было опущено (опционально)

Ответ:

  • numberOfPeers (N) количество известных узлов в сети
  • numberOfGoods (N) количество DGS товаров в сети
  • numberOfUnlockedAccounts (N) число разблокированных аккаунтов на данном узле
  • numberOfTransfers (N) количество AE перемещений в blockchain
  • numberOfOrders (N) количество AE ордеров в blockchain
  • numberOfTransactions (N) количество транзакций в blockchain
  • maxMemory (N) максимальный объем памяти, который может использовать узел (in Байтах)
  • numberOfOffers (N) число предложений покупки валюты в blockchain
  • isScanning (B) true если этот узел сканировал blockchain, false в противном случае
  • cumulativeDifficulty (S) текущая совокупная сложность форжинга
  • numberOfCurrencies (N) количество валют в blockchain
  • numberOfAssets (N) количество активов AE в blockchain
  • freeMemory (N) объем свободной памяти на данном узле (в Байтах)
  • availableProcessors (N) количество процессоров используемых узлом
  • numberOfAccounts (N) количество аккаунтов в blockchain
  • numberOfBlocks (N) количество блоков (высота + 1) в blockchain
  • isTestnet (B) true если узел подключен к тестовой сети, false в противном случае
  • numberOfCurrencyTransfers (N) количество перемещений валют в blockchain
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • version (S) версия программного обеспечения (NRS) на данном узле
  • numberOfBidOrders (N) число BID ордеров AE в blockchain
  • lastBlock (S) последний адрес блока
  • totalMemory (N) объем используемой памяти на данном узле (в Байтах)
  • application (S) название программного обеспечения запущенного на этом узле (как правило NRS)
  • numberOfAliases (N) количество альясов в сети
  • lastBlockchainFeederHeight (N) высота последнего blockchain фидера
  • numberOfExchanges (N) число обменов валюты в blockchain
  • numberOfTrades (N) число сделок AE в blockchain
  • numberOfPurchases (N) количество DGS поставок в blockchain
  • numberOfTags (N) количество DGS тэгов в blockchain
  • time (N) текущее время узла (в секундах с момента создания генезисного блока)
  • numberOfAskOrders (N) число ASK ордеров AE в blockchain
  • lastBlockchainFeeder (S) анонсированное имя фидера последнего blockchain
  • peerport (N) порт для входящих сетевых запросов peer to peer
  • isOffline (B) true если этот узел подключен к другим узлам, false в противном случае

Примечание: AE это Asset Exchange (Биржа Активов), DGS это Digital Goods Store (Магазин Цифровых Товаров)

16.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getState

Ответ:

{
    "numberOfPeers": 431,
    "numberOfGoods": 459,
    "numberOfUnlockedAccounts": 0,
    "numberOfTransfers": 64524,
    "numberOfOrders": 3420,
    "numberOfTransactions": 634536,
    "maxMemory": 900726784,
    "isScanning": false,
    "cumulativeDifficulty": "10801094336553083",
    "numberOfAssets": 350,
    "freeMemory": 32551440,
    "availableProcessors": 4,
    "numberOfAccounts": 85033,
    "numberOfBlocks": 289637,
    "requestProcessingTime": 19837,
    "version": "1.3.4",
    "numberOfBidOrders": 1070,
    "lastBlock": "8304024978641923138",
    "totalMemory": 239075328,
    "application": "NRS",
    "numberOfAliases": 135450,
    "lastBlockchainFeederHeight": 289638,
    "numberOfTrades": 50386,
    "numberOfPurchases": 230,
    "numberOfTags": 421,
    "time": 31262438,
    "numberOfAskOrders": 2350,
    "lastBlockchainFeeder": "89.250.243.200"
}

Verified 14-Dec-14

16.7 Get Time

Получает текущее время.

Запрос:

  • requestType это getTime

Ответ:

  • time (N) текущее время (в секундах с момента создания генезисного блока).
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

16.7.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getTime

Ответ:

{
    "time": 31184078,
    "requestProcessingTime": 1
}

Verified 14-Dec-14

17 Tagged Data Operations

This section is under construction.

Tagged data are similar to prunable plain messages without a recipient, but with additional searchable metadata fields.

The Tagged Data feature is released for testing with version 1.5.3e and is currently only functional on the Testnet.

17.1 Download Tagged Data

Download tagged data as a file if it is still available.

Request:

  • requestType is downloadTaggedData
  • transaction is the transaction ID of the tagged data

Response: The downloaded data file named nxt, unless there is an error in the request.

17.1.1 Example

Request:

http://localhost:7876/nxt?
    requestType=downloadTaggedData&
    transaction=9169681701986886056

Response: Downloaded file named nxt with contents:

d4f167249340d6d746f49441b8ccdb1bd3521feb

Verified 18-May-15

17.2 Extend Tagged Data

Extend the expiration time of already uploaded tagged data. POST only.

Request:

  • requestType is extendTaggedData
  • transaction is the transaction ID of the tagged data
  • data is the tagged data (optional)
  • file is the pathname of a data file to upload (optional if data provided)
  • filename
  • name
  • description
  • tags
  • type
  • channel
  • isText

Note: The data and metadata (filename, name, description, tags, type, channel and isText) parameters can be omitted if the tagged data has not yet expired; otherwise, the tagged data can be restored to the blockchain only if these fields have exactly the same values as when the data was uploaded (refer to Upload Tagged Data).

Note: Anyone can submit an extension, not only the original uploader. Each extend transaction increases the expiration deadline by two weeks (24 hours on Testnet). Extending an existing tagged data from another account does not change the original submitter account ID by which it is indexed and searchable.

Response: Refer to Create Transaction Response.

17.2.1 Example

Request:

http://localhost:7876/nxt?
    requestType=extendTaggedData&
    transaction=10830004527486756064&
    secretPhrase=secretPhrase&
    feeNQT=100000000&
    deadline=60

Response:

{
    "signatureHash": "769fec24c144f46bd35fa462b57cfe6d57917132854dde70ea75c7532126dc20",
    "transactionJSON": {
        "senderPublicKey": "169cf83994b0e8c48a152ddc50606d58bd4b2b85ec2f5bbbaae93d838443df7f",
        "signature": "eadad32e8e370a4d07187cc505601b7a2b2393dfbfafbf26a32f2a7e9fc4c40eb1a...",
        "feeNQT": "100000000",
        "type": 6,
        "fullHash": "73861eb1be48d53db30afd9c803ac59d341852a4da1f5762c81d0ed9d48d28c0",
        "version": 1,
        "phased": false,
        "ecBlockId": "10179902849722954249",
        "signatureHash": "769fec24c144f46bd35fa462b57cfe6d57917132854dde70ea75c7532126dc20",
        "attachment": {
            "version.TaggedDataExtend": 1,
            "filename": "",
            "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
            "name": "Stargate SG1 full series",
            "channel": "torrent",
            "description": "Hash of the torrent.",
            "type": "",
            "taggedData": "10830004527486756064",
            "isText": true,
            "tags": "video,scifi,torrent"
        },
        "senderRS": "NXT-BMUV-8QQR-47VK-CR7F3",
        "subtype": 1,
        "amountNQT": "0",
        "sender": "11580081983047651163",
        "ecBlockHeight": 292811,
        "deadline": 60,
        "transaction": "4455547390205527667",
        "timestamp": 46672054,
        "height": 2147483647
    },
    "unsignedTransactionBytes": "0611b628c8023c00169cf83994b0e8c48a152ddc50606d58bd4b2b85...",
    "broadcasted": true,
    "requestProcessingTime": 57,
    "transactionBytes": "0611b628c8023c00169cf83994b0e8c48a152ddc50606d58bd4b2b85ec2f5bbb...",
    "fullHash": "73861eb1be48d53db30afd9c803ac59d341852a4da1f5762c81d0ed9d48d28c0",
    "transaction": "4455547390205527667"
}

Verified 18-May-15

17.3 Get Account Tagged Data

Get all available tagged data uploaded by a given account in reverse chronological order.

Request:

  • requestType is getAccountTaggedData
  • account is the account ID
  • includeData is false to omit data (optional)
  • firstIndex is a zero-based index to the first tagged data to retrieve (optional)
  • lastIndex is a zero-based index to the last tagged data to retrieve (optional)

Response:

  • data (A) is an array of tagged data objects (refer to Get Tagged Data with hash omitted for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

17.3.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getAccountTaggedData&
    account=NXT-BMUV-8QQR-47VK-CR7F3

Response:

{
    "data": [
        {
            "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
            "channel": "torrent",
            "description": "Hash of the torrent.",
            "type": "",
            "parsedTags": [
                "video",
                "scifi",
                "torrent"
            ],
            "transactionTimestamp": 46758014,
            "tags": "video,scifi,torrent",
            "filename": "",
            "accountRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "name": "Stargate SG1 full series",
            "blockTimestamp": 46672108,
            "transaction": "10830004527486756064",
            "account": "11580081983047651163",
            "isText": true
        }
    ]
}

Verified 19-May-15

17.4 Get All Tagged Data

Get all available tagged data in reverse chronological order.

Request:

  • requestType is getAllTaggedData
  • includeData is false to omit data (optional)
  • firstIndex is a zero-based index to the first tagged data to retrieve (optional)
  • lastIndex is a zero-based index to the last tagged data to retrieve (optional)

Response:

  • taggedData (A) is an array of tagged data objects (refer to Get Tagged Data with hash omitted for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

17.4.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getAllTaggedData

Response:

{
    "requestProcessingTime": 4,
    "taggedData": [
        {
            "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
            "channel": "torrent",
            "description": "Hash of the torrent.",
            "type": "",
            "parsedTags": [
                "video",
                "scifi",
                "torrent"
            ],
            "transactionTimestamp": 46758014,
            "tags": "video,scifi,torrent",
            "filename": "",
            "accountRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "name": "Stargate SG1 full series",
            "blockTimestamp": 46672108,
            "transaction": "10830004527486756064",
            "account": "11580081983047651163",
            "isText": true
        }
    ]
}

Verified 18-May-15

17.5 Get Channel Tagged Data

Get available tagged data by channel, optionally filtered by account, in reverse chronological order.

Request:

  • requestType is getChannelTaggedData
  • channel is the channel string
  • account is an account ID (optional)
  • includeData is false to omit data (optional)
  • firstIndex is a zero-based index to the first tagged data to retrieve (optional)
  • lastIndex is a zero-based index to the last tagged data to retrieve (optional)

Response:

  • data (A) is an array of tagged data objects (refer to Get Tagged Data with hash omitted for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

17.5.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getChannelTaggedData&
    channel=torrent

Response:

{
    "data": [
        {
            "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
            "channel": "torrent",
            "description": "Hash of the torrent.",
            "type": "",
            "parsedTags": [
                "video",
                "scifi",
                "torrent"
            ],
            "transactionTimestamp": 46758014,
            "tags": "video,scifi,torrent",
            "filename": "",
            "accountRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "name": "Stargate SG1 full series",
            "blockTimestamp": 46672108,
            "transaction": "10830004527486756064",
            "account": "11580081983047651163",
            "isText": true
        }
    ]
}

Verified 19-May-15

17.6 Get Data Tag Count

Get the total number of distinct available data tags.

Request:

  • requestType is getDataTagCount

Response:

  • numberOfDataTags (N) is the total number of distinct data tags
  • requestProcessingTime (N) is the API request processing time (in millisec)

17.6.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getDataTagCount

Response:

{
    "numberOfDataTags": 3,
    "requestProcessingTime": 2
}

Verified 18-May-15

17.7 Get Data Tags

Get the distinct tags of all available tagged data, with the number of uses of each tag, in order of number of uses, then alphabetical order.

Request:

  • requestType is getDataTags
  • firstIndex is a zero-based index to the first tag to retrieve (optional)
  • lastIndex is a zero-based index to the last tag to retrieve (optional)

Response:

  • tags (A) is an array of tag objects including the fields:
    • tag (S) is a tag word
    • count (N) is the number of uses of tag among all tagged data
  • requestProcessingTime (N) is the API request processing time (in millisec)

17.7.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getDataTags

Response:

{
    "requestProcessingTime": 5,
    "tags": [
        {
            "count": 2,
            "tag": "video"
        },
        {
            "count": 1,
            "tag": "scifi"
        },
        {
            "count": 1,
            "tag": "torrent"
        }
    ]
}

Verified 18-May-15

17.8 Get Data Tags Like

Prefix search of available data tags, return in alphabetical order.

Request:

  • requestType is getDataTagsLike
  • tagPrefix is the prefix to search for (2 character minimum) among all data tags
  • firstIndex is a zero-based index to the first tag to retrieve (optional)
  • lastIndex is a zero-based index to the last tag to retrieve (optional)

Response:

  • tags (A) is an array of tag objects including the fields:
    • tag (S) is a tag word
    • count (N) is the number of uses of tag among all tagged data
  • requestProcessingTime (N) is the API request processing time (in millisec)

17.8.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getDataTagsLike&
    tagPrefix=sci

Response:

{
    "requestProcessingTime": 9,
    "tags": [
        {
            "count": 1,
            "tag": "scifi"
        }
    ]
}

Verified 18-May-15

17.9 Get Tagged Data

Get available tagged data given a transaction ID.

Request:

  • requestType is getTaggedData
  • transaction is the transaction ID
  • includeData is false to omit data (optional)

Response:

  • data (S) is the tagged data
  • hash (S) is the hash of the tagged data
  • filename (S) is the metadata filename field
  • name (S) is the metadata name field
  • description (S) is the metadata description field
  • tags (S) is the metadata tags field
  • parsedTags (A) is an array of tag words (S) parsed from tags
  • type (S) is the metadata type field
  • channel (S) is the metadata channel field
  • isText (B) is the metadata isText field
  • account (S) is the number of the account that originally uploaded the tagged data
  • accountRS (S) is the Reed-Solomon address of the uploading account
  • transaction (S) is the transaction ID
  • transactionTimestamp (N) is the transaction timestamp (in seconds since the genesis block)
  • blockTimestamp (N) is the block timestamp (in seconds since the genesis block)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Note: Refer to Upload Tagged Data for details about the data and metadata (filename, name, description, tags, type, channel and isText) fields.

17.9.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getTaggedData&
    transaction=10830004527486756064

Response:

{
    "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
    "channel": "torrent",
    "description": "Hash of the torrent.",
    "requestProcessingTime": 1,
    "type": "",
    "parsedTags": [
        "video",
        "scifi",
        "torrent"
    ],
    "transactionTimestamp": 46758014,
    "tags": "video,scifi,torrent",
    "filename": "",
    "accountRS": "NXT-BMUV-8QQR-47VK-CR7F3",
    "name": "Stargate SG1 full series",
    "blockTimestamp": 46672108,
    "transaction": "10830004527486756064",
    "account": "11580081983047651163",
    "isText": true
}

Verified 18-May-15

17.10 Search Tagged Data

Full text search on available tagged data name, description and tags; optionally filtered by tag, channel or uploading account; return in reverse relevance order.

Request:

  • requestType is searchTaggedData
  • query is a full text query on the metadata fields name (S), description (S) and tags (S) in the standard Lucene syntax
  • tag is a word in the tags string (optional)
  • channel is a channel string (optional)
  • account is an account ID (optional)
  • includeData is false to omit data (optional)
  • firstIndex is a zero-based index to the first tagged data to retrieve (optional)
  • lastIndex is a zero-based index to the last tagged data to retrieve (optional)

Response:

  • data (A) is an array of tagged data objects (refer to Get Tagged Data with hash omitted for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

17.10.1 Example

Request:

http://localhost:7876/nxt?
    requestType=searchTaggedData&
    query=SG?

Response:

{
    "data": [
        {
            "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
            "channel": "torrent",
            "description": "Hash of the torrent.",
            "type": "",
            "parsedTags": [
                "video",
                "scifi",
                "torrent"
            ],
            "transactionTimestamp": 46758014,
            "tags": "video,scifi,torrent",
            "filename": "",
            "accountRS": "NXT-BMUV-8QQR-47VK-CR7F3",
            "name": "Stargate SG1 full series",
            "blockTimestamp": 46672108,
            "transaction": "10830004527486756064",
            "account": "11580081983047651163",
            "isText": true
        }
    ]
}

Verified 19-May-15

17.11 Upload Tagged Data

Upload and broadcast new tagged data. POST only.

Request: Refer to Create Transaction Request for common parameters.

  • requestType is uploadTaggedData
  • data is the data (optional)
  • file is the pathname of a data file to upload (optional if data provided)
  • filename is a filename to associate with data (optional if file uploaded in which case the uploaded filename is always used)
  • name is the name or title of data (optional if file uploaded in which case the uploaded filename is used, but name takes precedence if provided)
  • description is a description of data (optional)
  • tags is a list of up to 5 words from 3 to 20 characters long and separated by commas, describing the actual content of data; for example: audio,mp3,classical (optional)
  • type is the mime type of data such as torrent, pdf, doc, image, etc. (optional)
  • channel is a data feed label such as pirate bay torrents, wikileaks, etc. (optional)
  • isText is false if data is a hex string (optional)

Note: The maximum length of data plus all associated metadata is 42 kilobytes. The maximum length of description is 1000 bytes. The maximum length of the other metadata (name, tags, type, channel and filename) is 100 bytes each.

Response: Refer to Create Transaction Response.

17.11.1 Example

Request:

http://localhost:7876/nxt?
    requestType=uploadTaggedData&
    data=d4f167249340d6d746f49441b8ccdb1bd3521feb&
    name=Stargate SG1 full series&
    description=Hash of the torrent.&
    tags=video,scifi,torrent&
    channel=torrent&
    secretPhrase=secretPhrase&
    feeNQT=100000000&
    deadline=60

Response:

{
    "signatureHash": "8a8aa7e3ec8187370f642039cfda45130fdc54e5755cd24ec4556fc9d8d2baaf",
    "transactionJSON": {
        "senderPublicKey": "169cf83994b0e8c48a152ddc50606d58bd4b2b85ec2f5bbbaae93d838443df7f",
        "signature": "056327a7ca35c943beb9a6e253c5a53b252a28bfc9fb1c0a869a0c9dfe94b40abd31826efface863878f46a9...",
        "feeNQT": "100000000",
        "type": 6,
        "fullHash": "e064b8e8bce74b967e283a4a77df27239da1b7977d6de5d149557d61d28186e7",
        "version": 1,
        "phased": false,
        "ecBlockId": "322350258816443096",
        "signatureHash": "8a8aa7e3ec8187370f642039cfda45130fdc54e5755cd24ec4556fc9d8d2baaf",
        "attachment": {
            "filename": "",
            "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
            "name": "Stargate SG1 full series",
            "channel": "torrent",
            "description": "Hash of the torrent.",
            "type": "",
            "version.TaggedDataUpload": 1,
            "isText": true,
            "hash": "d55c6006b872a3de17d8bfba490070083523e34737d5e7d2bdf5e72c41cd2fea",
            "tags": "video,scifi,torrent"
        },
        "senderRS": "NXT-BMUV-8QQR-47VK-CR7F3",
        "subtype": 0,
        "amountNQT": "0",
        "sender": "11580081983047651163",
        "ecBlockHeight": 292809,
        "deadline": 60,
        "transaction": "10830004527486756064",
        "timestamp": 46671614,
        "height": 2147483647
    },
    "unsignedTransactionBytes": "0610fe26c8023c00169cf83994b0e8c48a152ddc50606d58bd4b2f5b...",
    "broadcasted": true,
    "requestProcessingTime": 45,
    "transactionBytes": "0610fe26c8023c00169cf83994b0e8c48a152ddc50606d58bd4b2b85ec2f5bbb...",
    "fullHash": "e064b8e8bce74b967e283a4a77df27239da1b7977d6de5d149557d61d28186e7",
    "transaction": "10830004527486756064"
}

Verified 18-May-15

17.12 Verify Tagged Data

Verify expired tagged data downloaded from another node, against the hash in the blockchain.

Request:

  • requestType is verifyTaggedData
  • transaction is the transaction ID of the tagged data
  • data is the tagged data (optional)
  • file is the pathname of a data file to upload (optional if data provided)
  • filename
  • name
  • description
  • tags
  • type
  • channel
  • isText

Note: The data and metadata (filename, name, description, tags, type, channel and isText) must have exactly the same values as when the data was uploaded (refer to Upload Tagged Data).

Response:

  • verify (B) is true if the hash of the provided data and metadata matches the hash in the blockchain
  • version.TaggedDataUpload (N) is 1, the version number
  • data (S) is the tagged data
  • hash (S) is the hash of the tagged data
  • filename (S) is the metadata filename field
  • name (S) is the metadata name field
  • description (S) is the metadata description field
  • tags (S) is the metadata tags field
  • type (S) is the metadata type field
  • channel (S) is the metadata channel field
  • isText (B) is the metadata isText field
  • requestProcessingTime (N) is the API request processing time (in millisec)

Note: This call returns an error if there is a hash mismatch.

17.12.1 Example

Request:

http://localhost:7876/nxt?
    requestType=verifyTaggedData&
    transaction=10830004527486756064&
    data=d4f167249340d6d746f49441b8ccdb1bd3521feb&
    name=Stargate SG1 full series&
    description=Hash of the torrent.&
    tags=video,scifi,torrent&
    channel=torrent

Response:

{
    "filename": "",
    "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
    "name": "Stargate SG1 full series",
    "channel": "torrent",
    "description": "Hash of the torrent.",
    "verify": true,
    "requestProcessingTime": 2,
    "type": "",
    "version.TaggedDataUpload": 1,
    "isText": true,
    "hash": "d55c6006b872a3de17d8bfba490070083523e34737d5e7d2bdf5e72c41cd2fea",
    "tags": "video,scifi,torrent"
}

Verified 18-May-15

18 Операции с Токенами

18.1 Decode Token

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

Запрос:

  • requestType 'nj decodeToken
  • website URL (без http://) веб-сайта для которого разрешается авторизация
  • token закодированная авторизационная строка

Ответ:

  • account (S) номер аккаунта ассоциированный с данным токеном
  • accountRS (S) адрес аккаунта в формате Reed-Solomon
  • timestamp (N) время (в секундах от момента создания генезисного блока) когда токен был создан
  • valid (B) возвращает true если токен верный, false в противном случае
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: Так как token содержит открытый ключ и подпись аккаунта-генератора, веб-сайт может проверить владельца открытого ключа, и открытый ключ позволит определить ID учетной записи.

18.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=decodeToken&
    website=iwonttellyou.com&
    token=ikt6vuqnjiq0mckepv1b90ae11ev5e987d3jm53cjvrihgnerpjk6f7p3o7t4k01...

Ответ:

{
    "valid": true,
    "accountRS": "NXT-L6FM-89WK-VK8P-FCRBB",
    "requestProcessingTime": 1,
    "account": "15323192282528158131",
    "timestamp": 31352643
}

Verified 14-Dec-14

18.2 Generate Token

Создать авторизационный токен. Токен можно использовать для авторизации вашей учетной записи на каком либо веб-сайте, не требуя ввода секретной фразы. Только POST.

Запрос:

  • requestType это generateToken
  • secretPhrase секретная фраза аккаунта, для которого генерируется токен
  • website URL web сайта, для которого необходима авторизация по токену

Примечание: web сайт как правило это URL (ведущие http:// не нужны) который владелец аккаунта подписывает своей secretPhrase (приватным ключом) чтобы связать аккаунт с заданным URL, также website может быть любым текстом, который владелец аккаунта захочет подписать.

Ответ:

  • token (S) 160 символьная строка, представляющих 100-байтовый маркер, который состоит из 32-байтового открытого ключа, 4-байтовой метки времени и 64-байтовой подписи
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание:, Так как маркер содержит открытый ключ и подпись генератора, website может быть проверен авторизованным владельцем открытого ключа используя Декодирование Токена

18.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=generateToken&
    secretPhrase=IWontTellYou&
    website=iwonttellyou.com

Ответ:

{
    "requestProcessingTime": 3,
    "token": "ikt6vuqnjiq0mckepv1b90ae11ev5e987d3jm53cjvrihgnerpjk6f7p3o..."
}

Verified 14-Dec-14

19 Операции с Транзакциями

19.1 Broadcast Transaction

Транслировать (передать) транзакцию в сеть. Только POST.

Запрос:

  • requestType это broadcastTransaction
  • transactionBytes байткод подписанной транзакции (опционально)
  • transactionJSON объект транзакции (опционально, если задан transactionBytes)

Ответ:

  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • fullHash (S) полный хеш подписанной транзакции
  • transaction (S) ID транзакции

19.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=broadcastTransaction&
    transactionBytes=001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...

Ответ:

{
    "requestProcessingTime": 4,
    "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
    "transaction": "15200507403046301754"
}

Заметка: Если транзакция уже была передана, следующее информационное уведомление появляется на выходе консоли и файле журнала: Сделка 15200507403046301754 уже в blockchain (или в пуле неподтвержденных транзакций), и не будет передана снова.

Verified 14-DEC-14

19.2 Calculate Full Hash

Рассчитывает полный хэш пранзакции.

Запрос:

  • requestType это calculateFullHash
  • unsignedTransactionBytes неподписанные байты транзакции
  • signatureHash SHA-256 хэш подписи транзакции

Ответ:

  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • fullHash (S) полный хэш подписанной транзакции

19.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=calculateFullHash&
    unsignedTransactionBytes=001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f2...&
    signatureHash=b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7

Ответ:

{
    "requestProcessingTime": 1,
    "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1"
}

Verified 14-DEC-14

19.3 Get Transaction

Возвращает объект транзакции по заданному ID транзакции.

Запрос:

  • requestType это getTransaction
  • transaction ID транзакции (опционально)
  • fullHash полный хэш транзакции (опционально, если ID транзакции представлен)

Ответ:

  • sender (S) ID аккаунта отправителя
  • senderRS (S) аккаунт отправителя в формате Reed-Solomon
  • feeNQT (S) комиссия (в NQT) транзакции
  • amountNQT (S) сумма (в NQT) транзакции
  • transactionIndex (N) индекс (начиная с 0), указывающий порядок транзакции в ее блоке
  • timestamp (N) метка времени транзакции (в секундах от времени создания генезисного блока)
  • referencedTransactionFullHash (S) полный хеш транзакции, на которую ссылается текущая транзакция, опускается, если ни на какую предыдущую транзакцию текущая не ссылается
  • confirmations (N) количество подтверждений транзакции
  • subtype (N) подтип транзакции (подробнее ознакомиться с текущими подтипами транзакций можно в разделе Get Constants)
  • block (S) ID блока содержащего транзакцию
  • blocktimestamp (N) метка времени блока (в секундах от времени создания генезисного блока)
  • height (N) высота блока в blockchain
  • senderPublicKey (S) открытый ключ аккаунта отправителя транзакции
  • type (N) тип транзакции (подробнее ознакомиться с текущими подтипами транзакций можно в разделе Get Constants)
  • deadline (N) крайний срок (в минутах) для подтверждения транзакции
  • signature (S) цифровая подпись транзакции
  • recipient (S) номер аккаунта получателя, если применимо
  • recipientRS (S) номер аккаунта получателя в формате Reed-Solomon, если применимо
  • fullHash (S) полный хэш подписанной транзакции
  • signatureHash (S) SHA-256 хэш подписи транзакции
  • transaction (S) ID транзакции
  • version (N) номер версии транзакции
  • ecBlockId (N) ID блока EC (экономической кластеризации)
  • ecBlockHeight (N) высота блока EC (экономической кластеризации)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • attachment (O) объект, содержащий любые дополнительные данные, необходимые для транзакции, если применимо

Примечание: блок, blocktimestamp и confirmations поля опущены для неподтвержденных транзакций. Double-spending транзакции не будут получены.

19.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getTransaction&
    transaction=15200507403046301754

Ответ:

{
    "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
    "signature": "5f0378b7390ff5a815eadd1354de533eef682f139362b153576e2207320a6...",
    "feeNQT": "100000000",
    "requestProcessingTime": 2842,
    "type": 0,
    "confirmations": 849,
    "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
    "version": 1,
    "ecBlockId": "17321329645912574173",
    "signatureHash": "b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7",
    "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
    "subtype": 0,
    "amountNQT": "100000000",
    "sender": "15323192282528158131",
    "recipientRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
    "recipient": "17013046603665206934",
    "ecBlockHeight": 275727,
    "block": "8455642159445842600",
    "blockTimestamp": 29797208,
    "deadline": 60,
    "transaction": "15200507403046301754",
    "timestamp": 29796934,
    "height": 275730
}

Verified 14-DEC-14

19.4 Get Transaction Bytes

Возвращает байткод транзакции.

Запрос:

  • requestType это getTransactionBytes
  • transaction ID транзакции

Ответ:

  • confirmations (N) число подтверждений транзакции
  • transactionBytes (S) байты, содержавшиеся в транзакции
  • unsignedTransactionBytes (S) неподписанные байты, содержавшиеся в транзакции
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

19.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getTransactionBytes&
    transaction=15200507403046301754

Ответ:

{
    "unsignedTransactionBytes": "001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473...",
    "requestProcessingTime": 66,
    "confirmations": 1019,
    "transactionBytes": "001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473..."
}

Verified 14-DEC-14

19.5 Parse Transaction

Возвращает объект транзакции, по заданному байт-коду транзакции (подписанному или не подписанному), или производит репарсинг объекта транзакции. Проверка подписи.

Запрос:

  • requestType это parseTransaction
  • transactionBytes подписанный или неподписанный байт-код транзакции (опционально)
  • transactionJSON объект транзакции (опционально, если transactionBytes представлен)

Ответ: Подробнее о дополнительных параметрах смотри в разделе Get Transaction.

  • verify (B) возвращает true если подпись верифицирована, false в противном случае

19.5.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=parseTransaction&
    transactionBytes=001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...

Ответ:

{
    "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
    "signature": "5f0378b7390ff5a815eadd1354de533eef682f139362b153576e2207320a6...",
    "feeNQT": "100000000",
    "requestProcessingTime": 2,
    "type": 0,
    "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
    "version": 1,
    "ecBlockId": "17321329645912574173",
    "signatureHash": "b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7",
    "senderRS": "NXT-L6FM-89WK-VK8P-FCRBB",
    "subtype": 0,
    "amountNQT": "100000000",
    "sender": "15323192282528158131",
    "recipientRS": "NXT-4VNQ-RWZC-4WWQ-GVM8S",
    "recipient": "17013046603665206934",
    "ecBlockHeight": 275727,
    "verify": true,
    "deadline": 60,
    "transaction": "15200507403046301754",
    "timestamp": 29796934,
    "height": 2147483647
}

Verified 14-DEC-14

19.6 Sign Transaction

Вычисляет полный хеш, хеш подписи и ID транзакции неподписанной транзакции.

Запрос:

  • requestType это signTransaction
  • unsignedTransactionBytes это unsignedTransactionBytes поле транзакции (опционально)
  • unsignedTransactionJSON это transactionJSON поле транзакции, без субполя подписи (опционально, если unsignedTransactionBytes задан)
  • secretPhrase секретная фраза подписывающего аккаунта
  • validate, установите false, чтобы пропустить проверку подписываемых байтов транзакции (полезно на узлах, где не загружен полный blockchain)

Ответ:

  • signatureHash (S) хеш SHA 256 подписи транзакции, используемой в транзакциях условного депонирования
  • verify (B) вернет true если подпись верифицирована , false если нет
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • transactionBytes (S) подписанные байты транзакции
  • fullHash (S) полный хэш подписанной транзакции
  • transaction (S) ID транзакции, полученный из fullHash

19.6.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=signTransaction&
    unsignedTransactionBytes=001046aac6013c0057fb6f3a958e320bb49c4e81b4c2...&
    secretPhrase=IWontTellYou

Ответ:

{
    "signatureHash": "b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f...",
    "verify": true
    "requestProcessingTime": 3,
    "transactionBytes": "001046aac6013c0057fb6f3a958e320bb49c4e81b4c2...",
    "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
    "transaction": "15200507403046301754",
}

Verified 14-DEC-14

20 Операции с системой голосования

Система Голосований сейчас находится в состоянии разработки и доступна только в Testnet. Подробнее смотри на странице this forum thread. Следующие вызовы API являются неполными, устаревшими версиями.

20.1 Cast Vote

Отдать свой голос в голосовании. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это castVote
  • poll название голосования в котором вы хотите принять название
  • vote1 ваш голос
  • vote2 ваш голос (опционально если при голосовании возможны несколько вариантов ответа)
  • vote3 ваш голос (опционально если при голосовании возможны несколько вариантов ответа)

Note: The allowed vote values are integers between minRangeValue and maxRangeValue, inclusive. This range, along with the minimum and maximum number of options that can and must be voted on are specified when the poll is created. Refer to Create Poll.

Ответ: Подробнее смотри в разделе Create Transaction Response.

20.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=castVote&
    poll=18991918535014782&
    vote1=yes&
    secretPhrase=MySuperSecretPasswordThatIsNotActuallyPostedHereOrIsEvenRealSoDoNotEvenTryIt&
    feeNQT=100000000&
    deadline=1440

Ответ:

{
    "fullHash":                 "637ea3215258adef61f7fc5a90eff6435d1a7ad8c3790d5855c6943b9aff1daf",
    "signatureHash":            "a6745e26165e9c7870c85bd174348e4e72c825378cfb71760e04f08e30879fa6",
    "transactionBytes":         "010314feda00a005668683e673274c671802492d6f54cdc33...",
    "hash":                     "10ee68836162f6a8e2559a6dbcbc41c4db4b7441e6ff321f01b268d761c6916d",
    "transaction":              "17270557255810645603",
    "broadcasted":              true,
    "unsignedTransactionBytes": "010314feda00a005668683e673274c671802492d6f54cdc33d247aa426e7..."
}

Verified 14-DEC-14

20.2 Create Poll

Создать новое голосование. Только POST.

Запрос: Информацию о общих параметрах смотри в разделе Create Transaction Request.

  • requestType это createPoll
  • name название голосования
  • description описание голосования
  • minNumberOfOptions минимальное количество вариантов в голосовании
  • maxNumberOfOptions максимальное количество вариантов в голосовании
  • optionsAreBinary указывает что варианты бинарные (опционально)
  • option1 название первого варианта
  • option2 название второго варианта (опционально)
  • option3 название третьего варианта (опционально)

Notes: Up to 100 options (answers) can be specified, but there is an extra fee for each option beyond 20. Unlike the API, the NRS client treats a vote of 0 as a nonvote not contributing to the number answers (options) chosen. The NRS client uses checkboxes for selecting answers when minRangeValue = 0 and maxRangeValue = 1; otherwise sliding controls are used to select answers from the allowed range.

Ответ: Подробнее смотри в разделе Create Transaction Response. ID транзакции также ID голосования.

20.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=createPoll&
    name=Testing123&
    description=Testing&
    minNumberOfOptions=1&
    maxNumberOfOptions=1&
    option1=yes&
    option2=no&
    secretPhrase=MySuperSecretPasswordThatIsNotActuallyPostedHereOrIsEvenRealSoDoNotEvenTryIt&
    feeNQT=100000000&
    deadline=1440

Ответ:

{
    "fullHash":                 "7ef9e19d0c7943002fd98a7ae08f1b4a1d473c67796f89225b167fd4913ce73f",
    "signatureHash":            "a76722be0652d5c88cb7292d1cb04ea299eaea74c35ad726e868d08799946c38",
    "transactionBytes":         "010234fbda00a005668683e673274c671802492d6f54cdc33d247aa426e...",
    "hash":                     "940383ff1bf177d4e4fee05c78865b12ace2570152c64570219dfc0aa10c246b",
    "transaction":              "18991918535014782",
    "broadcasted":              true,
    "unsignedTransactionBytes": "010234fbda00a005668683e673274c671802492d6f54cdc33d247..."
}

Verified 14-DEC-14

Verified 7-Apr-15

20.3 Get Poll

Возвращает информацию о запрошенном голосовании

Запрос:

  • requestType это getPoll
  • poll ID голосования, по которому необходимо получить информацию

Ответ:

  • description (S) описание голосования
  • name (S) название голосования
  • maxNumberOfOptions (N) максимальное количество вариантов у голосования
  • optionsAreBinary (N) если варианты бинарные
  • voters (A) массив проголосовавших (участников) голосования
  • minNumberOfOptions (N) минимальное количество вариантов у голосования
  • options (A) список вариантов (пунктов голосования)

20.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getPoll&
    poll=15826354927269615782

Ответ:

{
    "description":        "Does this work?",
    "name":               "Test",
    "maxNumberOfOptions": 1,
    "optionsAreBinary":   false,
    "voters":             [],
    "minNumberOfOptions": 1,
    "options":            [ "Yes", "No", "I don't know" ]
}

Verified 14-DEC-14

20.4 Get Poll Result

Get the result of a poll.

Request:

  • requestType is getPollResult
  • poll is the poll ID
  • votingModel (optional, default null)
  • holding (optional, default null)
  • minBalance (optional, default 0)
  • minBalanceModel (required if minBalance > 0, must match votingModel when votingModel > 0)

Note: The votingModel, holding, minBalance and minBalanceModel parameters are optional and default to the original values specified when the poll was created (refer to Create Poll). The original values can only be overridden while the votes are still stored in the database, until 1441 blocks after the poll is completed. If votingModel is specified, holding, minBalance and minBalanceModel or the defaults specified above apply, otherwise they are ignored.

Response:

  • poll (S) is the poll ID
  • votingModel (N) is the votingModel used to calculate results (refer to Note above)
  • minBalanceModel (N) is the minBalanceModel used to calculate results (refer to Note above)
  • minBalance (S) is the minBalance used to calculate results (refer to Note above)
  • holding (S) is the asset or currency ID if the voting model uses an asset or currency balance to determine weight, if applicable (refer to Note above)
  • decimals (N) is the number decimal places used by the asset or currency, if applicable
  • finished (B) is true if the poll is complete, false otherwise
  • options (A) is the array of options (answers) of the poll
  • requestProcessingTime (N) is the API request processing time (in millisec)
  • results (A) is an array of result objects with the following fields for each result:
    • weight (S) is the sum of the weight of each account that voted for the corresponding option (answer); an account's weight is 1 if the voting model is 0, otherwise it is the NQT, asset QNT or currency QNT balance of the account if the voting model is 1, 2 or 3 respectively; however, the weight is 0 if minBalance is not met
    • result (S) is the sum over each account that voted for the corresponding option (answer) of: the product of the account's weight and the rangeValue selected when the vote was cast.

20.4.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=getPollIds

Ответ:

{
    "pollIds":
    [
        "15826354927269615782",
        "8883605113950920958"
    ]
}

Verified 14-DEC-14

20.5 Get Poll Vote

Get a poll vote given a poll ID and an account ID.

Request:

  • requestType is getPollVote
  • poll is the poll ID
  • account is the account ID

Response:

  • votes (A) is an array of votes, the range values (S) corresponding to each option (answer) with empty strings for non-votes
  • voter (S) is the account number of the voter
  • voterRS (S) is the Reed-Solomon address of the voter
  • transaction (S) is the transaction ID of the vote
  • requestProcessingTime (N) is the API request processing time (in millisec)

Note: Votes are deleted from the database 1441 blocks after the poll is finished. Only aggregate results are kept (refer to Get Poll Result).

20.5.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getPollVote&
    account=9096010195498999548

Response:

{
    "voterRS": "NXT-THLJ-CYAL-JQST-6FNS5",
    "votes": [
        "1",
        ""
    ],
    "voter": "4747512364439223888",
    "requestProcessingTime": 1,
    "transaction": "6214591232702166122"
}

Verified 8-Apr-15

20.6 Get Poll Votes

Get all votes on a poll in reverse chronological order.

Request:

  • requestType is getPollVotes
  • poll is the poll ID
  • firstIndex is a zero-based index to the first vote to retrieve (optional)
  • lastIndex is a zero-based index to the last vote to retrieve (optional)

Response:

  • votes (A) is an array of vote objects (refer to Get Poll Vote for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Note: Votes are deleted from the database 1441 blocks after the poll is finished. Only aggregate results are kept (refer to Get Poll Result).

20.6.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getPollVotes&
    poll=9096010195498999548&
    lastIndex=0

Response:

{
    "votes": [
        {
            "voterRS": "NXT-THLJ-CYAL-JQST-6FNS5",
            "votes": [
                "1",
                ""
            ],
            "voter": "4747512364439223888",
            "transaction": "6214591232702166122"
        }
    ],
    "requestProcessingTime": 1
}

Verified 8-Apr-15

20.7 Get Poll IDs

Возвращает ID идентификаторы всех голосований

Запрос:

  • requestType это getPollIds

Ответ:

  • pollIds (A) массив из идентификаторов голосований

Response:

  • polls (A) is an array of polls (refer to Get Poll for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

20.7.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getPolls&
    lastIndex=0

Response:

{
    "polls": [
        {
            "minRangeValue": 0,
            "votingModel": 3,
            "description": "Should we start fully backing Credits with something tangible?",
            "finished": false,
            "poll": "10307833923604182368",
            "minNumberOfOptions": 1,
            "holding": "415923435949896799",
            "minBalance": "1000000000",
            "accountRS": "NXT-3BCV-8Q5G-9NP6-576DP",
            "name": "CRDTS owners poll",
            "options": [
                "Yes",
                "No",
                "go for fractional reserve backing"
            ],
            "finishHeight": 260218,
            "maxNumberOfOptions": 1,
            "minBalanceModel": 3,
            "account": "4227900615136683355",
            "maxRangeValue": 1
        }
    ],
    "requestProcessingTime": 0
}

Verified 8-Apr-15

20.8 Search Polls

Search for poll details given a name/description query string.

Request:

  • requestType is searchPolls
  • query is a full text query on the poll fields name (S) and description (S) in the standard Lucene syntax (optional)
  • firstIndex is a zero-based index to the first poll to retrieve (optional)
  • lastIndex is a zero-based index to the last poll to retrieve (optional)
  • includeFinished is true to include completed polls (optional)

Response:

  • polls (A) is an array of polls (refer to Get Poll for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

20.8.1 Example

Request:

http://localhost:7876/nxt?
    requestType=searchPolls&
    query=hello&
    includeFinished=true

Response:

{
    "polls": [
        {
            "minRangeValue": 0,
            "votingModel": 1,
            "description": "Hello World Poll",
            "finished": true,
            "poll": "3043888702585899321",
            "minNumberOfOptions": 1,
            "minBalance": "0",
            "accountRS": "NXT-XK4R-7VJU-6EQG-7R335",
            "name": "Poll1",
            "options": [
                "Hello",
                "World"
            ],
            "finishHeight": 255816,
            "maxNumberOfOptions": 1,
            "minBalanceModel": 1,
            "account": "5873880488492319831",
            "maxRangeValue": 1
        }
    ],
    "requestProcessingTime": 3
}

Verified 9-Apr-15

21 Утилиты

21.1 Hex Convert

Converts a text string into a UTF-8 hex string and if the text input is already a hex string, also into text.

Request:

  • requestType is hexConvert
  • string is a text string, possibly a hex string

Response:

  • binary (S) is the converted UTF-8 hex string
  • text (S) is a text string converted from string if it is a valid UTF-8 hex string
  • requestProcessingTime (N) is the API request processing time (in millisec)

21.1.1 Example

Request:

http://localhost:7876/nxt?
    requestType=hexConvert&
    string=616263

Response:

{
    "binary": "363136323633",
    "text": "abc",
    "requestProcessingTime": 1
}

Verified 19-May-15

21.2 Long Convert

Преобразовывает ID в длинное целое со знаком представление внутреннего использования.

Запрос:

  • requestType это longConvert
  • id числовой ID, в десятичной форме, но эквивалентный 8-байтовому целому без знака, как произведено хешированием SHA 256

Ответ:

  • stringId (S) числовой ID
  • longId (S) длинное целое со знаком (8 байтов), внутренне представление ID, возвращается как строка
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: Java не поддерживает тип данных целое без знака, таким образом, любой ID без знака (например ID блока) видимый в клиенте NRS представлен внутри системы как целое число со знаком.

21.2.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=longConvert&
    id=15323192282528158131

Ответ:

{
    "stringId": "15323192282528158131",
    "requestProcessingTime": 0,
    "longId": "-3123551791181393485"
}

Verified 14-DEC-14

21.3 RS Convert

Преобразует ID аккаунта в стандартном формате в формат Reed-Solomon и наоборот.

Запрос:

  • requestType это rsConvert
  • account ID аккаунта (может быть RS адрес или номер аккаунта)

Ответ:

  • accountRS (S) адрес аккаунта в формате Reed-Solomon
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)
  • account (S) ID аккаунта

21.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=rsConvert&
    account=NXT-L6FM-89WK-VK8P-FCRBB

Ответ:

{
    "accountRS": "NXT-L6FM-89WK-VK8P-FCRBB",
    "requestProcessingTime": 1,
    "account": "15323192282528158131"
}

Verified 22-DEC-14

22 Операции отладки

Все утилиты отладки требуют установки параметра nxt.enableDebugAPI=True в файле nxt.properties. Этот параметр по умолчанию отключен и не должен включаться на публичных узлах !

22.1 Clear Unconfirmed Transactions

Очищает пул неподтвержденных транзакций. Только POST.

Запрос:

  • requestType это clearUnconfirmedTransactions

Ответ:

  • done (B) принимает значение true если операция выполнена успешно
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

22.1.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=clearUnconfirmedTransactions

Ответ:

{
    "requestProcessingTime": 814,
    "done": true
}

Verified 14-DEC-14

22.2 Dump Peers

Get all active peers, optionally of a certain version.

Request:

  • requestType is dumpPeers
  • version is a version filter such as 1.5.5e (optional)

Response:

  • peers (S) is a string of peer IP addresses or DNS names, separated by semicolons
  • requestProcessingTime (N) is the API request processing time (in millisec)

22.2.1 Example

Request:

http://localhost:7876/nxt?
    requestType=dumpPeers

Response:

{
    "peers": "87.121.52.246; scripterron.dyndns.biz; ",
    "requestProcessingTime": 13
}

Verified 28-Apr-15

22.3 Full Reset

Удаление всего blockchain. Только POST.

Запрос:

  • requestType это fullReset

Ответ:

  • done (B) принимает значение true если операция выполнена успешно
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

Примечание: После успешного завершения сброса, автоматически начнется загрузка нового blockchain.

22.3.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=fullReset

Ответ:

{
    "requestProcessingTime": 4378,
    "done": true
}

Verified 14-DEC-14

22.4 Get All Broadcasted Transactions

Gets unconfirmed transactions broadcasted from this node but not yet received back from a peer, if transaction rebroadcasting is enabled.

Request:

  • requestType is GetAllBroadcastedTransactions

Response:

  • transactions (A) is an array of broadcasted unconfirmed transactions not yet received back from a peer (S)
  • requestProcessingTime (N) is the API request processing time (in millisec)

22.4.1 Example

Request:

http://localhost:7876/nxt?
    requestType=GetAllBroadcastedTransactions

Response:

{
    "requestProcessingTime": 1,
    "transactions": []
}

Verified 17-May-15

22.5 Get All Waiting Transactions

Gets unconfirmed transactions temporarily kept in memory during transaction processing.

Request:

  • requestType is getAllWaitingTransactions

Response:

  • transactions (A) is an array of unconfirmed transactions temporarily kept in memory (S)
  • requestProcessingTime (N) is the API request processing time (in millisec)

22.5.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getAllWaitingTransactions

Response:

{
    "requestProcessingTime": 1,
    "transactions": []
}

Verified 17-May-15

22.6 Get Log

Gets up to 100 of the most recent log messages from a memory buffer.

Request:

  • requestType is getLog
  • count is the number of messages to return (optional, default 100)

Response:

  • messages (A) is an array of log messages (S)
  • requestProcessingTime (N) is the API request processing time (in millisec)

22.6.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getLog&
    count=3

Response:

{
    "messages": [
        "2015-04-28 18:26:52 FINE: Known peers: 29\n",
        "2015-04-28 18:27:12 FINE: Got 0 confirmations\n",
        "2015-04-28 18:27:12 FINE: Downloaded 230 blocks\n",
    ],
    "requestProcessingTime": 0
}

Verified 28-Apr-15

22.7 Get Stack Traces

Get the stack traces of the currently running threads in reverse id order.

Request:

  • requestType is getStackTraces
  • depth is the maximum trace depth to retrieve (optional)

Response:

  • requestProcessingTime (N) is the API request processing time (in millisec)
  • locks (A) is an array of lock objects
  • threads (A) is an array of thread objects with the following fields:
    • trace (A) is an array of traces (S)
    • name (S) is the thread name
    • id (N) is the thread ID
    • state (S) is the thread state, one of WAITING, TIMED_WAITING and RUNNABLE
    • locks (A) is an array of lock objects with the following fields, if not empty:
      • trace (S)
      • depth (N)
      • name (S)
      • hash (N)

22.7.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getStackTrace

Response:

{
    "threads": [
        ⋮
        {
            "trace": [
                "java.lang.Object.wait(Native Method)",
                "java.lang.Object.wait(Object.java:502)",
                "java.lang.ref.Reference$ReferenceHandler.run(Reference.java:157)"
            ],
            "name": "Reference Handler",
            "id": 2,
            "state": "WAITING"
        }
    ],
    "requestProcessingTime": 5,
    "locks": []
}

Verified 28-Apr-15

22.8 Lucene Reindex

Выполняет принудительное перестроение поисковых индексов Lucene. Только POST.

Запрос:

  • requestType это luceneReindex

Ответ:

  • done (B) принимает значение 'true если операция выполнена успешно
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

22.8.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=luceneReindex

Ответ:

{
    "requestProcessingTime": 4480,
    "done": true
}

Verified 14-DEC-14

22.9 Pop Off Blockchain

Удаление указанного количества блоков (и связанных транзакций) из "верхней" части blockchain. Только POST.

Запрос:

  • requestType это popOff
  • numBlocks количество блоков которые будут вытолкнуты из blockchain (опционально)
  • height новая высота blockchain после выталкивания (опционально если numBlocks задан)

Примечание: Если тримминг (образка) таблиц включена (по умолчанию), последние 1440 блоков могут быть вытолкнуты.

Ответ:

  • blocks (A) массив из вытолкнутых блоков (Подробнее смотри в разделе Get Block)
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

22.9.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=popOff&
    numBlocks=1

Ответ:

{
    "blocks": [
        {
            "previousBlockHash": "5dd57ec106d9ba4cb1442017586b9df23c2c31ec5f1cb46fd3206015a96fd057",
            "payloadLength": 0,
            "totalAmountNQT": "0",
            "generationSignature": "e23740a05b65aa01a890a9ba1c9766183a328455b6e347add727a823e151db99",
            "generator": "16120433118765388429",
            "generatorPublicKey": "f35600023d42e79cbf0518a174141bce1decb13332e397553c3f62df7261414a",
            "baseTarget": "268653798",
            "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            "generatorRS": "NXT-A6NF-JE4R-XB6L-FAUFZ",
            "nextBlock": "12812496435932308379",
            "numberOfTransactions": 0,
            "blockSignature": "d9aba136c708e4f84b7ae1cf0415b25a75f9eefc8a47b1963b237ada9982a...",
            "transactions": [],
            "version": 3,
            "totalFeeNQT": "0",
            "previousBlock": "5528970115590051165",
            "block": "8125766982300698657",
            "height": 212194,
            "timestamp": 23052841
        }
    ],
    "requestProcessingTime": 109
}

Verified 14-DEC-14

22.10 Rebroadcast Unconfirmed Transactions

Rebroadcast transactions in the unconfirmed pool to peers, until received back or found in the blockchain. Rebroadcasting can be disabled by setting the nxt.enableTransactionRebroadcasting property to false. POST only.

Request:

  • requestType is RebroadcastUnconfirmedTransactions

Response:

  • done (B) is true if the operation completed successfully
  • requestProcessingTime (N) is the API request processing time (in millisec)

22.10.1 Example

Request:

http://localhost:7876/nxt?
    requestType=RebroadcastUnconfirmedTransactions

Response:

{
    "requestProcessingTime": 2,
    "done": true
}

Verified 17-May-15

22.11 Requeue Unconfirmed Transactions

Requeue unconfirmed transactions. POST only.

Request:

  • requestType is requeueUnconfirmedTransactions

Response:

  • done (B) is true if the operation completed successfully
  • requestProcessingTime (N) is the API request processing time (in millisec)

22.11.1 Example

Request:

http://localhost:7876/nxt?
    requestType=requeueUnconfirmedTransactions

Response:

{
    "requestProcessingTime": 1,
    "done": true
}

Verified 16-May-15

22.12 Scan Blockchain

Сканирование верхней части blockchain. Только POST.

Запрос:

  • requestType это scan
  • numBlocks количество верхних blockchain блоков для сканирования (опционально)
  • height высота, выше которой должен быть отсканирован blockchain (опционально если numBlocks представлен)
  • validate установите true если подписи должны быть вновь верифицированы а блоки и транзакции проверены (опционально)

Примечание: таблицы производных объектов откатываются и восстанавливаются, при повторном сканировании существующего blockchain. Запрос, для повторно сканирования больше чем 1440 блоков, когда обрезка таблиц включена, сделает полное пересканирование, запускающееся с высоты 0. Состояние пересканирования сохранено в базе данных, так, чтобы, если пересканирование было прервано или произошел сбои, процесс возобновилось при перезапуске.

Ответ:

  • scanTime (N) время сканирования
  • done (B) будет иметь значение true если операция завершена успешно
  • requestProcessingTime (N) время выполнения API запроса (в миллисекундах)

22.12.1 Пример

Запрос:

http://localhost:7876/nxt?
    requestType=scan

Ответ:

{
    "scanTime": 8,
    "requestProcessingTime": 8445,
    "done": true
}

Verified 12-Nov-14

22.13 Set Logging

Sets the log level and optionally specifies communication events to be logged, without restarting the server. POST only.

Request:

  • requestType is setLogging
  • logLevel is one of ERROR, WARN, INFO or DEBUG with each level in the list including all of the previous levels (optional, default is INFO)
  • communicationEvent is one of multiple communication (HTTP) events to be logged, from the list: EXCEPTION, HTTP-ERROR, HTTP-OK (optional)
  • communicationEvent is one of multiple communication events (optional)

Note: The initial log level is set by the nxt.level logging property, currently FINE (equivalent to DEBUG).

Response:

  • loggingUpdated (B) is true if the operation completed successfully

22.13.1 Example

Request:

http://localhost:7876/nxt?
    requestType=setLogging

Response:

{
    "loggingUpdated": true
}

Verified 16-May-15

22.14 Shutdown

Shutdown the server. POST only.


Request:

  • requestType is shutdown
  • scan is true to truncate the derived tables and schedule a full rescan with validation on the next start (optional)

Response:

  • shutdown (B) is true if the operation completed successfully
  • requestProcessingTime (N) is the API request processing time (in millisec)

22.14.1 Example

Request:

http://localhost:7876/nxt?
    requestType=shutdown

Response:

{
    "requestProcessingTime": 2,
    "shutdown": true
}

Verified 28-Apr-15

22.15 Trim Derived Tables

Trigger a derived tables trim, and a prunable tables pruning. POST only.


Request:

  • requestType is trimDerivedTables

Response:

  • done (B) is true if the operation completed successfully
  • requestProcessingTime (N) is the API request processing time (in millisec)

22.15.1 Example

Request:

http://localhost:7876/nxt?
    requestType=trimDerivedTables

Response:

{
    "requestProcessingTime": 394,
    "done": true
}

Verified 12-May-15