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, які вимагають ідентифікатор аккаунта, приймають або номер аккаунта або відповідну адресу у форматi 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 data can be removed from the blockchain without affecting the integrity of the blockchain. When a transaction containing prunable data is created, only the 32-byte sha256 hash of the prunable data is included in the transactionBytes, not the prunable data itself. The non-prunable signed transactionBytes are used to verify the signature and to generate the transaction's fullHash and ID; when the prunable part of the transaction is removed at a later time, none of these operations are affected.

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

Expired prunable data remains stored in the blockchain until removed at the same time derived tables are trimmed, which occurs automatically every 1000 blocks by default. Use Trim Derived Tables to remove expired prunable data immediately.

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

Currently, there are two varieties of prunable data in the Nxt system: prunable Arbitrary Messages and Tagged Data. Both varities have a maximum prunable data length of 42 kilobytes.

3.7 Файли налаштувань

Поведінка деяких викликів API залежить від налаштувань параметрів, які завантажуються з файлів в теці nxt/conf під час ініціалізації сервера Nxt. Цей каталог містить файли nxt - default.properties і logging - default.properties, обоє з яких містять параметри налаштувань за умовчанням, і містять опис самих параметрів. Деякі налаштування параметрів можуть бути отримані під час роботи сервера за допомогою API викликів Get Blockchain Status і Get State.

It is recommended not to modify default properties files because they can be overwritten during software updates. Instead, properties in the default files can be overridden by including them in optional nxt.properties and logging.properties files in the same directory. For example, a nxt.properties file can be created with the contents:

nxt.isTestnet=true

This causes the Nxt server to connect to the Testnet instead of the Mainnet.

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": "73080 c6a224062660184f10ebb7fb431d4593.".,
    "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 09-Feb-15

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 09-Feb-15

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 09-Feb-15

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 09-Feb-15

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 09-Feb-15

5.11 Get Blockchain Transactions

Get the transactions associated with an account in reverse block timestamp order.


Request:

  • requestType is getAccountTransactions
  • account is the account ID
  • timestamp is the earliest block (in seconds since the genesis block) to retrieve (optional)
  • type is the type of transactions to retrieve (optional)
  • subtype is the subtype of transactions to retrieve (optional)
  • firstIndex is a zero-based index to the first transaction to retrieve (optional)
  • lastIndex is a zero-based index to the last transaction to retrieve (optional)
  • numberOfConfirmations is the required number of confirmations per transaction (optional)
  • withMessage is true to retrieve only only transactions having a message attachment, either non-encrypted or decryptable by the account (optional)
  • phasedOnly is true to retrieve only phased transactions (optional unless nonPhasedOnly provided)
  • nonPhasedOnly is true to retrieve only nonphased transactions (optional unless phasedOnly provided)

Note: Refer to Get Constants for definitions of types and subtypes


Response:

  • transactions (A) is an array of transactions (refer to Get Transaction for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

5.11.1 Example

Request:

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

Response:

{
    "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 19-May-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 09-Feb-15

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 09-Feb-15

5.14 Get Unconfirmed Account Transactions

Повертає список непідтверджених транзакцій асоційованих з аккаунтом.

Запит:

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

Відповідь:

  • unconfirmedTransactions (A) масив містить непідтверджені транзакції (детальніше дивися в розділі Get Transaction)

5.14.1 Приклад

Запит:

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

Відповідь:

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

Verified 09-Feb-15

5.15 Search Accounts

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

Request:

  • requestType is searchAccounts
  • query is a full text query on the account fields name (S) and description (S) in the standard Lucene syntax
  • firstIndex is a zero-based index to the first account to retrieve (optional)
  • lastIndex is a zero-based index to the last account to retrieve (optional)

Response:

  • accounts (A) is an array of account objects with the following fields:
    • account (S) is the account number
    • accountRS (S) is the Reed-Solomon address of the account
    • name (S) is the name of the account
    • description (S) is the description of the account (if applicable)
  • requestProcessingTime (N) is the API request processing time (in millisec)

5.15.1 Example

Request:

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

Response:

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

Verified 29-Apr-15

5.16 Send NXT

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

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

  • requestType це sendMoney
  • amountNQT кількість (у NQT) в транзакції
  • recipient ID аккаунта одержувача
  • recipientPublicKey публічний ключ аккаунта одержувача (опцiонально, підвищує безпеку нещодавно створеного аккаунта)

Відповідь: подробиці дивися в розділі 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": "001046 aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143.".,
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "5 f0378b7390ff5a815eadd1354de533eef682f139362b153576e2207320a6.".,
        "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 03-Mar-15

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.

Запит:

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

Відповідь:

{
    "signatureHash": "15917aafd59ad9cece7dfc127ab256711d1c58a8ed1a0dc7334949ca826d8a32",
    "unsignedTransactionBytes": "0115 dfeecb013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b.".,
    "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 03-Mar-15

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": "01166 e01d4013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143.".,
    "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 03-Mar-15


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": "d 92aefbab189b6e61f890c34b06a47e14a1a2b2ce868f77a4591d2067c51d.".,
        "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 03-Mar-15

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": "011809 e60c023c0010f09c34f225d425306e5be55a49469081.".,
    "transactionJSON": {
        "senderPublicKey": "10f09c34f225d425306e5be55a4946908156072afbead4d574a512d7e086ef5c",
        "signature": "a 5088bc6469e528d884e7fd3c49afeefc8656dd59c9fa5ffeab2a17b465f6d03e77.".,
        "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 03-Mar-15


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 03-Mar-15

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 03-Mar-15

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 03-Mar-15

6.7 Get Aliases Like

Get all aliases starting with a given prefix in alias name order.

Request:

  • requestType is getAliasesLike
  • aliasPrefix is the prefix (at least 2 characters long) of the aliasName
  • firstIndex is a zero-based index to the first alias to retrieve (optional)
  • lastIndex is a zero-based index to the last alias to retrieve (optional)

Response:

  • aliases (A) is an array of alias objects (refer to Get Alias for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

6.7.1 Example

Request:

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

Response:

{
    "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 29-Apr-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 03-Mar-15

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 03-Mar-15

7.3 Get All Prunable Messages

Get all available prunable messages in reverse block timestamp order.

Request:

  • requestType is getAllPrunableMessages
  • 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)

Response:

  • prunableMessages (A) is an array of prunable messages (refer to Get Prunable Message)
  • requestProcessingTime (N) is the API request processing time (in millsec)

7.3.1 Example

Request:

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

Response:

{
    "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 15-May-15

7.4 Get Prunable Message

Get the prunable message given a transaction ID, optionally decrypting it if encrypted and if a secretPhrase is provided, if it is still available.

Request:

  • requestType is getPrunableMessage
  • transaction is the transaction ID
  • secretPhrase is the secret phrase needed for decryption (optional)

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 Example

Request:

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

Response:

{
    "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 12-May-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)

Response:

  • prunableMessages (A) is an array of prunable message objects (refer to Get Prunable Message for details)
  • requestProcessingTime (N) is the API request processing time (in millsec)

7.5.1 Example

Request:

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

Response:

{
    "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 12-May-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 03-Mar-15

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 представлене (опционально)
  • 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 03-Mar-15

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 Example

Request:

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

Response:

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

Verified 15-May-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 03-Mar-15

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": "61 e2398087b078bdba24021d909e937c2d5fe157a09fa3c82d910e7b5843e00cef2.".,
        "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 03-Mar-15

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 03-Mar-15

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 03-Mar-15

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 03-Mar-15

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 03-Mar-15

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 03-Mar-15

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 04-MAr-15

8.9 Get All Trades

Повертає усі угоди із заданою відміткою часу в порядку зворотному висоті блоку.

Запит:

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

Примітка: Якщо timestamp опущена або нуль, і жоден індекс не заданий, будуть повернені усі угоди які є в blockchain, що може привести до зависання або "падіння" вашої системи.

Відповідь:

  • 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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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 04-Mar-15

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)

Response: Refer to Get Trades.

8.20.1 Example

Request:

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

Response:

{
    "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 29-Apr-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 04-Mar-15

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": "021095 e5da013c0073080c6a224062660184f10ebb7fb431d459364a12403.".,
    "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 04-Mar-15

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": "02135 a5ed6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143.".,
    "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 05-Mar-15

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 05-Mar-15

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": "0211 c9ebda013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b.".,
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "33 d0fccf1f19d18b4ca97d2636cf62f7a801c07628d1bbb1d6084dc3ca658d.".,
        "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 05-Mar-15

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 05-Mar-15

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 05-Mar-15

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 05-Mar-15

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 05-Mar-15

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

11 Операції в Магазині Цифрових Товарів

У Клієнтському інтерфейсi Nxt, Магазин Цифрових Товарів (DGS) називається Marketplace.

11.1 DGS Delisting

Зняття з продажу раніше виставленого товару на DGS. Тільки POST.

Request: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

Відповідь: Детальніше дивися в розділі Create Transaction Response.

11.1.1 Приклад

Запит:

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

Відповідь:

{
    "signatureHash": "87dd2aa00690acaa5da4e8cd9db6ab94b5ed8bf0f8fe2c2ba6a39c57d3073105",
    "unsignedTransactionBytes": "03111852 e2013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b.".,
    "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 05-Mar-15

11.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.

11.2.1 Приклад

Запит:

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

Відповідь:

{
    "signatureHash": "f3f1f1bf30c7a6f5a7776aa23502dfe5240efe0d5c016760f8e8a152c4eb1b1b",
    "unsignedTransactionBytes": "0315 b20fe1013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b.".,
    "transactionJSON": {
        "senderPublicKey": "57fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473beec228f79ff93c",
        "signature": "b 96c42161ce38177168de5a8906ce747a5415017df5b16cdce1c015cb6e1f10b.".,
        "feeNQT": "100000000",
        "type": 3,
        "fullHash": "349926ea025b627117c05fbe3ff298e97a8efdb07f7ae552b5a91e7112c5b82b",
        "version": 1,
        "ecBlockId": "15813950788992376142",
        "signatureHash": "f3f1f1bf30c7a6f5a7776aa23502dfe5240efe0d5c016760f8e8a152c4eb1b1b",
        "attachment": {
            "goodsIsText": true,
            "discountNQT": "0",
            "purchase": "3723760852542296589",
            "goodsData": "aef 91bfe543844964b0dadc51c6fe4c624b6b0c72c23c5c61f7e626f51e15.".,
            "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": "0315b20fe1013c0057fb6f3a958e320bb49c4e81b4c2cf28b
    "fullHash": "349926ea025b627117c05fbe3ff298e97a8efdb07f7ae552b5a91e7112c5b82b",
    "transaction": "8170192742079961396"
}

Verified 06-Mar-15

11.3 DGS Feedback

Залишити відгук про куплений товар після його постачання. Тільки POST.

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

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

Відповідь: Детальніше дивися в розділі Create Transaction Response.

11.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 06-Mar-15

11.4 DGS Listing

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

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

Відповідь: Детальніше дивися в розділі Create Transaction Response. ID транзакції також ID товару.

11.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": "031092 aedf013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b.".,
    "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 06-Mar-15

11.5 DGS PriceChange

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

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

  • requestType це dgsPriceChange
  • goods ID товару
  • priceNQT нова ціна товару

Відповідь: Детальніше дивися в розділі Create Transaction Response.

11.5.1 Приклад

Запит:

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

Відповідь:

{
    "signatureHash": "aad88476935eda8ca3a9190163b83106e6ca95733ddfa274d29a0378d773cc3c",
    "unsignedTransactionBytes": "0312 cebbdf013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b.".,
    "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 06-Mar-15

11.6 DGS Purchase

Купівля товару виставленого на продаж. Тільки POST.

Request: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

Відповідь: Детальніше дивися в розділі Create Transaction Response. ID транзакції також ID ордера на купівлю.

11.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 06-Mar-15

11.7 DGS Quantity Change

Зміна кількості виставленого на продаж товару. Тільки POST.

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

Відповідь: Детальніше дивися в розділі Create Transaction Response.

11.7.1 Приклад

Запит:

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

Відповідь:

{
    "signatureHash": "5c60fc94452980f88423c3a16a74d49209d246d0f7454024c87cc76ea3221500",
    "unsignedTransactionBytes": "031334 b7df013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b.".,
    "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 06-Mar-15

11.8 DGS Refund

Повернення купівлі. Тільки POST.

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

Відповідь: Детальніше дивися в розділі Create Transaction Response.

11.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": "43 a90c1f0dde1bca84623e69b0abe0284883600d7bfb5286b3489a9ee417.".,
        "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 06-Mar-15

11.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)

Response:

  • purchases (A) is an array of purchase orders (refer to Get DGS Purchase for details)
  • requestProcessingTime (N) is the API request processing time (in millisec)

11.9.1 Example

Request:

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

Response:

{
    "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 29-Apr-15

11.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) мітка часу (у секундах з моменту створення генезисного блоку) публікації товару

11.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 06-Mar-15

11.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 запиту (у мілісекундах)

11.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 06-Mar-15

11.12 Get DGS Goods Count

Повертає кількість товарів для продажу тих, що належать вказаному продавцеві або усім продавцям.

Запит:

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

Відповідь:

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

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

11.12.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

11.13 Get DGS Goods Purchase Count

Повертає кількість завершених угод по заданому ID товару.

Запит:

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

Відповідь:

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

11.13.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

11.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 запиту (у мілісекундах)

11.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 06-Mar-15

11.15 Get DGS Pending Purchases

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

Запит:

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

Відповідь:

  • purchases (A) масив очікуючих ордерів на закупівлю (Детальніше дивися в розділі Get DGS Purchase)
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

11.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 06-Mar-15

11.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 запиту (у мілісекундах)

11.16.1 Приклад

Запит:

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

Відповідь:

{
    "seller": "7580519603555678830",
    "quantity": 1,
    "feedbackNotes": [
        {
            "data": "7086 a82f4da0708d4eaa9b16d5fc5a25c556596ea29d957d0a1dddd0a482c.".,
            "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 06-Mar-15

11.17 Get DGS Purchase Count

Повертає кількість ордерів на постачання по ID продавців і/або покупців, або усі ордери одним списком.

Запит:

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

Відповідь:

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

11.17.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

11.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 запиту (у мілісекундах)

11.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 06-Mar-15

11.19 Get DGS Tag Count

Повертає число тегів, використовуваних усіма продавцями.

Запит:

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

Відповідь:

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

11.19.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

11.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 поля відносяться до кількості різних тэгированных продуктів, незалежно від кількості кожного з них.

11.20.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

11.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.

11.21.1 Example

Request:

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

Response:

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

Verified 29-Apr-15

11.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 запиту (у мілісекундах)

11.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 06-Mar-15

12 Операції Форжинга

12.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 будуть обнулені.

12.1.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

12.2 Lease Balance

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

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

Відповідь: Детальніше дивися в розділі Create Transaction Response.

12.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 06-Mar-15

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

13.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 запиту (у мілісекундах)

13.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 06-Mar-15

13.2 Generate Hallmark

Створює клеймо вузла. Тільки POST.

Запит:

  • requestType це markHost
  • secretPhrase секретна фраза аккаунта який робить мітку для вузла
  • host IP адреса або ім'я домена вузла
  • weight вага присвоєна вузлу
  • date поточна дата у форматі YYYY-MM-DD

Примітка: Детальніше дивися в розділі Створення Клейма.

Відповідь:

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

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

13.2.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

14 Операції в Грошовій Системі

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

14.1 Can Delete Currency

Робить перевірку чи може валюта бути видалена

Запрос:

  • requestType это canDeleteCurrency
  • рахуйте ID аккаунта
  • валюта ID валюты

Відповідь:

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

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

14.1.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

14.2 Currency Buy / Sell

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

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

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

Відповідь: Детальніше дивися в розділі Create Transaction Response.

14.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 06-Mar-15

14.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.

14.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 06-Mar-15

14.4 Currency Reserve Claim

Запит/Затребування Reserve Валюти. Тільки POST.

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

  • requestType це currencyReserveClaim
  • currency ID валюти
  • units сума (у QNT) reserve валюти, щоб бути такою, що зажадалася

Примітка: Утримувачі claimable валюти може зажадати заблоковані NQT назад, таким чином зменшуючи об'єм валюти.

Відповідь: Детальніше дивися в розділі Create Transaction Response.

14.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 06-Mar-15

14.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.

14.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 06-Mar-15

14.6 Delete Currency

Видалення валюти яка може бути видалена (Детальніше дивися Як Видалити Валюту). Тільки POST.

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

  • requestType це deleteCurrency
  • currency ID валюти

Відповідь: Детальніше дивися в розділі Create Transaction Response.

14.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 06-Mar-15

14.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 запиту (у мілісекундах)

14.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 06-Mar-15

14.8 Get Account Currency Count

Повертає кількість валют випущених заданим аккаунтом.

Запит:

  • requestType це getAccountCurrencyCount
  • account ID аккаунта
  • height висота blockchain до якої застосовується відповідь (опционально, за умовчанням це поточна висота)

Відповідь:

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

14.8.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

14.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 запиту (у мілісекундах)

Примітка: Навіть минулі, невиконані запити будуть отримані.

14.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 06-Mar-15

14.10 Get All Currencies

Повертає усі валюти, в порядку зворотному даті створення.

Запит:

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

Відповідь:

  • currencies (A) масив складається з об'єктів валюти (Детальніше дивися в розділі Get Currency )
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

14.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 06-Mar-15

14.11 Get All Exchanges

Повертає усі обміни валют, в зворотному хронологічному порядку.

Запит:

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

Відповідь:

  • exchanges (A) масив об'єктів обміну (Детальніше дивися Отримати обміни)
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

14.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 06-Mar-15

14.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 запиту (у мілісекундах)

14.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 06-Mar-15

14.13 Get Currencies

Повертає опис валют по заданих значеннях ID валют.

Запит:

  • requestType це getCurrencies
  • currencies один з безлічі ID валют
  • currencies один з безлічі ID валют

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

Відповідь:

  • currencies (A) масив з об'єктів валют (Детальніше дивися Get Currency)
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

14.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 06-Mar-15

14.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 запиту (у мілісекундах)

14.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-Mar-15

14.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

14.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-Mar-15

14.16 Get Currency Account Count

Повертає кількість аккаунтів тих, що володіють заданою валютою.

Запит:

  • requestType це getCurrencyAccountCount
  • currency ID валюти
  • height висота blockchain до якої застосовується відповідь (опционально, за умовчанням це поточна висота)

Відповідь:

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

14.16.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

14.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 запиту (у мілісекундах)

14.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-Mar-15

14.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 запиту (у мілісекундах)

14.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-Mar-15

14.19 Get Currency IDs

Повертає усе ID валют в хронологічному порядку зворотному даті створення валюти.

Запит:

  • requestType це getCurrencyIds
  • firstIndex індекс (починаючи з 0) першої повертаної валюти (опционально)
  • lastIndex індекс (починаючи з 0) останньої повертаної валюти (опционально)

Відповідь:

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

14.19.1 Приклад

Запит:

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

Відповідь:

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

Verified 06-Mar-15

14.20 Get Currency Transfers

Повертає переміщення вказаній по ID валюти і/або ID аккаунта.

Запит:

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

Відповідь:

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

14.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-Mar-15

14.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 запиту (у мілісекундах)

14.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-Mar-15

14.22 Get Exchanges By Exchange Request

Повертає дані обміну валюти, по заданому ID транзакції обміну в зворотному хронологічному порядку.

Запит:

  • requestType це getExchangesByExchangeRequest
  • transaction ID транзакції запиту обміну
  • includeCurrencyInfo встановите false щоб опустити декілька пов'язаних з валютою полів

Відповідь:

  • exchanges (A) масив об'єктів обміну (Детальніше дивися в розділі Get Exchanges)
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

14.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-Mar-15

14.23 Get Exchanges By Offer

Повертає обміни валюти, по заданому ID пропозиції, в зворотному хронологічному порядку.

Запит:

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

Відповідь:

  • exchanges (A) масив об'єктів обміну (Детальніше дивися в розділі Get Exchanges)
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

14.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-Mar-15

14.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.)

14.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-Mar-15

14.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 запиту (у мілісекундах)

14.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 08-Mar-15

14.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 валюти.

14.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,
    "transactionByte": "05100f8308023c0010f09c34f225d425306e5be55a49469081560.".,
    "fullHash": "6c08c076d4617e5a4be6f027c9b3e47ddb0e92fab87032d631546051dbdbfe8c",
    "transaction": "6520756875632314476"
}

Verified 08-Mar-15

14.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 пропозиції.

14.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": "b 204a7d9622ac6b99936447a4314fac1c2f0c67e45f4021f4b1949755c081802a34.".,
        "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 08-Mar-15

14.28 Search Currencies

Повертає валюти тi, що мають код що відповідає заданому запиту в порядку зворотної релевантности.

Запит:

  • requestType це searchCurrencies
  • query повний текстовий запит по полю валюти code в стандартному синтаксисі 2_9_4/queryparsersyntax.html#Overview Lucene
  • firstIndex індекс (починаючи з 0) першої повертаної валюти (опционально)
  • lastIndex індекс (починаючи з 0) останньої повертаної валюти (опционально)
  • includeCounts встановите false якщо поля починаються з numberOf... мають бути опущені (опционально)

Відповідь:

  • currencies (A) масив з об'єктів валют (Детальніше дивися Get Currency)
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

14.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 08-Mar-15

14.29 Transfer Currency

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

Запит: Інформацію про загальні параметри дивися в розділі Create Transaction Request.

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

Відповідь: Детальніше дивися розділ Create Transaction Response.

14.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 08-Mar-15

15 Networking Operations

15.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.

Request:

  • requestType is addPeer
  • peer is the IP address or domain name of the peer (plus optional port)

Response: refer to Get Peer

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

15.1.1 Example

Request:

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

Response:

{
    "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 26-Jan-15

15.2 Blacklist Peer

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

Request:

  • requestType is blacklistPeer
  • peer is the IP address or domain name of the peer (plus optional port)

Response:

  • done (B) is true if the peer is blacklisted
  • requestProcessingTime (N) is the API request processing time (in millisec)

15.2.1 Example

Request:

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

Response:

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

Verified 26-Jan-15

15.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)

15.3.1 Example

Request:

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

Response:

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

Verified 19-May-15

15.4 Get My Info

Повертає ім'я хоста і адресу вказаного вузла.

Запит:

  • requestType це getMyInfo

Відповідь:

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

15.4.1 Приклад

Запит:

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

Відповідь:

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

Verified 08-Mar-15

15.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 запиту (у мілісекундах)

15.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 08-Mar-15

15.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 запиту (у мілісекундах)

15.6.1 Приклад

Запит:

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

Відповідь:

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

Verified 08-Mar-15

16 Phasing Operations

Phasing is released for testing with version 1.5.0e and is currently only functional on the Testnet.

16.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.

Response: Refer to Create Transaction Response.

16.1.1 Example

Request:

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

Response:

{
    "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 17-Apr-15

16.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.

Response: Refer to Create Transaction Response.

16.2.1 Example

Request:

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

Response:

{
    "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 16-Apr-15

16.3 Get Account Phased Transaction Count

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

Request:

  • requestType is getAccountPhasedTransactionCount
  • account is the account ID

Response:

  • numberOfPhasedTransactions (N) is the number of pending phased transactions
  • requestProcessingTime (N) is the API request processing time (in millisec)

16.3.1 Example

Request:

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

Response:

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

Verified 17-Apr-15

16.4 Get Account Phased Transactions

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

Request:

  • requestType is getAccountPhasedTransactions
  • account is the account ID
  • 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.

16.4.1 Example

Request:

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

Response:

{
    "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 17-Apr-15

16.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)

Response: Refer to Get Transaction for details.

16.5.1 Example

Request:

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

Response:

{
    "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 18-Apr-15

16.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)

Response: Refer to Get Transaction for details.

16.6.1 Example

Request:

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

Response:

{
    "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 18-Apr-15

16.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

16.7.1 Example

Request:

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

Response:

{
    "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 15-Apr-15

16.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)

16.8.1 Example

Request:

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

Response:

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

Verified 17-Apr-15

16.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)

Response: Refer to Get Phasing Poll Vote

16.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

16.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.

16.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

16.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.

16.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

17 Операції з Інформацією про Сервер

17.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)

17.1.1 Example

Request:

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

Response:

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

Verified 16-May-15

17.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)

17.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

17.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 запиту (у мілісекундах)

17.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 08-Mar-15

17.4 Get Constants

Отримує усі константи визначені в системі.

Запит:

  • requestType це getConstants

Відповідь:

  • maxBlockPayloadLength (N) максимальна довжина корисного навантаження блоку (у байтах)
  • genesisAccountId (S) генезисный аккаунт
  • genesisBlockId (S) ID генезисного блоку
  • transactionTypes (A) масив певних типів і підтипів транзакцій (див. приклад нижче),
  • peerStates (A) масив з певними статусами вузлів (див. приклад нижче)
  • maxArbitraryMessageLength (N) максимальна довга (у байтах) довільного повідомлення
  • currencyTypes (A) масив певних типів валюти (див. приклад нижче)

17.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 08-Mar-15

17.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)

17.5.1 Example

Request:

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

Response:

{
    "plugins": [
        "hello_world"
    ],
    "requestProcessingTime": 9
}

Verified 28-Apr-15

17.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 (Магазин Цифрових Товарів)

17.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 08-Mar-15

17.7 Get Time

Отримує поточний час.

Запит:

  • requestType це getTime

Відповідь:

  • time (N) поточний час (у секундах з моменту створення генезисного блоку).
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

17.7.1 Приклад

Запит:

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

Відповідь:

{
    "time": 31184078,
    "requestProcessingTime": 1
}

Verified 08-Mar-15

18 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.

18.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.

18.1.1 Example

Request:

http://localhost:7876/nxt?
    requestType=downloadTaggedData&
    transaction=9169681701986886056

Response: Downloaded file named nxt with contents:

d4f167249340d6d746f49441b8ccdb1bd3521feb

Verified 18-May-15

18.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.

18.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

18.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)

18.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

18.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)

18.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

18.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)

18.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

18.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)

18.6.1 Example

Request:

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

Response:

{
    "numberOfDataTags": 3,
    "requestProcessingTime": 2
}

Verified 18-May-15

18.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)

18.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

18.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)

18.8.1 Example

Request:

http://localhost:7876/nxt?
    requestType=getDataTagsLike&
    tagPrefix=sci

Response:

{
    "requestProcessingTime": 9,
    "tags": [
        {
            "count": 1,
            "tag": "scifi"
        }
    ]
}

Verified 18-May-15

18.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.

18.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

18.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)

18.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

18.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.

18.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

18.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.

18.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

19 Операції з Токенами

19.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 облікового запису.

19.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 08-Mar-15

19.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 може бути перевірений авторизованим власником відкритого ключа використовуючи Декодування Токена

19.2.1 Приклад

Запит:

http://localhost:7876/nxt?
    requestType=generateToken&
    secretPhrase=IWontTellYou&
    website=iwonttellyou.com

Відповідь:

{
    "requestProcessingTime": 3,
    "token": "ikt6vuqnjiq0mckepv1b90ae11ev5e987d3jm53cjvrihgnerpjk6f7p3o.".
}

Verified 08-Mar-15

20 Операції з Транзакціями

20.1 Broadcast Transaction

Транслювати (передати) транзакцію в мережу. Тільки POST.

Запит:

  • requestType це broadcastTransaction
  • transactionBytes байткод підписаної транзакції (опционально)
  • transactionJSON об'єкт транзакції (опционально, якщо заданий transactionBytes)

Відповідь:

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

20.1.1 Приклад

Запит:

http://localhost:7876/nxt?
    requestType=broadcastTransaction&
    transactionBytes=001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143...

Відповідь:

{
    "requestProcessingTime": 4,
    "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1",
    "transaction": "15200507403046301754"
}

Замітка: Якщо транзакція вже була передана, наступне інформаційне повідомлення з'являється на виході консолі і файлі журналу : Угода 15200507403046301754 вже в blockchain (чи в кулі непідтверджених транзакцій), і не буде передана знову.

Verified 08-Mar-15

20.2 Calculate Full Hash

Розраховує повний хэш пранзакции.

Запит:

  • requestType це calculateFullHash
  • unsignedTransactionBytes непідписані байти транзакції
  • signatureHash SHA - 256 хэш підписи транзакції

Відповідь:

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

20.2.1 Приклад

Запит:

http://localhost:7876/nxt?
    requestType=calculateFullHash&
    unsignedTransactionBytes=001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f2...&
    signatureHash=b35eae7d2f01639810d37694138aa0a86fbbf8a9bf58c2be4f2a5b8f0f30b3f7

Відповідь:

{
    "requestProcessingTime": 1,
    "fullHash": "3a304584f20cf3d2cbbdd9698ff9a166427005ab98fbe9ca4ad6253651ee81f1"
}

Verified 08-Mar-15

20.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 транзакції не будуть отримані.

20.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 08-Mar-15

20.4 Get Transaction Bytes

Повертає байткод транзакції.

Запит:

  • requestType це getTransactionBytes
  • transaction ID транзакції

Відповідь:

  • confirmations (N) число підтверджень транзакції
  • transactionBytes (S) байти, що містилися в транзакції
  • unsignedTransactionBytes (S) непідписані байти, що містилися в транзакції
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

20.4.1 Приклад

Запит:

http://localhost:7876/nxt?
    requestType=getTransactionBytes&
    transaction=15200507403046301754

Відповідь:

{
    "unsignedTransactionBytes": "001046 aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473.".,
    "requestProcessingTime": 66,
    "confirmations": 1019,
    "transactionBytes": "001046aac6013c0057fb6f3a958e320bb49c4e81b4c2cf28b9f25d086c143b473.".
}

Verified 08-Mar-15

20.5 Parse Transaction

Повертає об'єкт транзакції, по заданому байт-коду транзакції (підписаному або не підписаному), або проводить репарсинг об'єкту транзакції. Перевірка підпису.

Запит:

  • requestType це parseTransaction
  • transactionBytes підписаний або непідписаний байт-код транзакції (опционально)
  • transactionJSON об'єкт транзакції (опционально, якщо transactionBytes представлений)

Відповідь: Детальніше про додаткові параметри дивися в розділі Get Transaction.

  • verify (B) повертає true якщо підпис верифицирована, false інакше

20.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 08-Mar-15

20.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

20.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 08-Mar-15

21 Операції з системою голосування

Система Голосувань зараз знаходиться в стані розробки і доступна тільки в Testnet. Детальніше дивися на сторінці forum thread. Наступні виклики API є неповними, застарілими версіями.

21.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.

21.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 08-Mar-15

21.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 голосування.

21.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 08-Mar-15

Verified 7-Apr-15

21.3 Get Poll

Повертає інформацію про запрошене голосування

Запит:

  • requestType це getPoll
  • poll ID голосування, по якому необхідно отримати інформацію

Відповідь:

  • description (S) опис голосування
  • name (S) назва голосування
  • maxNumberOfOptions (N) максимальна кількість варіантів у голосування
  • optionsAreBinary (N) якщо варіанти бінарні
  • voters (A) масив тих, що проголосували (учасників) голосування
  • minNumberOfOptions (N) мінімальна кількість варіантів у голосування
  • options (A) список варіантів (пунктів голосування)

21.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 08-Mar-15

21.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.

21.4.1 Приклад

Запит:

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

Відповідь:

{
    "pollIds":
    [
        "15826354927269615782",
        "8883605113950920958"
    ]
}

Verified 08-Mar-15

21.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).

21.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

21.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).

21.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

21.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)

21.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

21.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)

21.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

22 Утиліти

22.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)

22.1.1 Example

Request:

http://localhost:7876/nxt?
    requestType=hexConvert&
    string=616263

Response:

{
    "binary": "363136323633",
    "text": "abc",
    "requestProcessingTime": 1
}

Verified 19-May-15

22.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 представлений усередині системи як ціле число зі знаком.

22.2.1 Приклад

Запит:

http://localhost:7876/nxt?
    requestType=longConvert&
    id=15323192282528158131

Відповідь:

{
    "stringId": "15323192282528158131",
    "requestProcessingTime": 0,
    "longId": "-3123551791181393485"
}

Verified 08-Mar-15

22.3 RS Convert

Перетворить ID аккаунта в стандартному форматі у формат Reed - Solomon і навпаки.

Запит:

  • requestType це rsConvert
  • account ID аккаунта (може бути RS адреса або номер аккаунта)

Відповідь:

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

22.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 08-Mar-15

23 Операції відладки

Усі утиліти відладки вимагають установки параметра nxt.enableDebugAPI=True у файлі nxt.properties. Цей параметр за умовчанням відключений і не повинен включатися на публічних вузлах !

23.1 Clear Unconfirmed Transactions

Очищає пул непідтверджених транзакцій. Тільки POST.

Запит:

  • requestType це clearUnconfirmedTransactions

Відповідь:

  • done (B) набуває значення true якщо операція виконана успішно
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

23.1.1 Приклад

Запит:

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

Відповідь:

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

Verified 08-Mar-15

23.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)

23.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

23.3 Full Reset

Видалення усього blockchain. Тільки POST.

Запит:

  • requestType це fullReset

Відповідь:

  • done (B) набуває значення true якщо операція виконана успішно
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

Примітка: Після успішного завершення скидання, автоматично почнеться завантаження нового blockchain.

23.3.1 Приклад

Запит:

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

Відповідь:

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

Verified 08-Mar-15

23.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)

23.4.1 Example

Request:

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

Response:

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

Verified 17-May-15

23.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)

23.5.1 Example

Request:

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

Response:

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

Verified 17-May-15

23.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)

23.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

23.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)

23.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

23.8 Lucene Reindex

Виконує примусове перестроювання пошукових індексів Lucene. Тільки POST.

Запит:

  • requestType це luceneReindex

Відповідь:

  • done (B) набуває значення 'true якщо операція виконана успішно
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

23.8.1 Приклад

Запит:

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

Відповідь:

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

Verified 08-Mar-15

23.9 Pop Off Blockchain

Видалення вказаної кількості блоків (і пов'язаних транзакцій) з "верхньої" частини blockchain. Тільки POST.

Запит:

  • requestType це popOff
  • numBlocks кількість блоків які виштовхнуть з blockchain (опционально)
  • height нова висота blockchain після виштовхування (опционально якщо numBlocks заданий)

Примітка: Якщо тримінг (образу) таблиць включена (за умовчанням), останні 1440 блоків можуть виштовхнути.

Відповідь:

  • blocks (A) масив з блоків (Детальніше дивися в розділі Get Block), що виштовхнули
  • requestProcessingTime (N) час виконання API запиту (у мілісекундах)

23.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 08-Mar-15

23.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)

23.10.1 Example

Request:

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

Response:

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

Verified 17-May-15

23.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)

23.11.1 Example

Request:

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

Response:

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

Verified 16-May-15

23.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 запиту (у мілісекундах)

23.12.1 Приклад

Запит:

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

Відповідь:

{
    "scanTime": 8,
    "requestProcessingTime":8445,
    "done": true
}

Verified 08-Mar-15

23.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

23.13.1 Example

Request:

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

Response:

{
    "loggingUpdated": true
}

Verified 16-May-15

23.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)

23.14.1 Example

Request:

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

Response:

{
    "requestProcessingTime": 2,
    "shutdown": true
}

Verified 28-Apr-15

23.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)

23.15.1 Example

Request:

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

Response:

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

Verified 12-May-15