LibreMoney API

LibreMoney

2. Основная часть

2.8. API (RestAPI)

Содержание

1 Описание
2 Общие сведения
3 Операции со счетом
4 Действия с Альясами
5 Системные функции для работы с произвольными сообщениями
- 5.1 Send Message
6 Операции для работы с блоками
- 6.1 Get Block
7 Операции на Бирже Активов
8 Операции с опросами

8.2 Get Poll
8.3 Get Poll IDs
8.4 Cast Vote

9 Операции для работы с серверной частью

9.1 Get Constants
9.2 Get My Info
9.3 Get Peer
9.4 Get Peers
9.5 Get State
9.6 Get Time
9.7 Get Blockchain Status

10 Операции с клеймами (hallmarks)

10.1 Decode Hallmark
10.2 Generate Hallmark

11 Операции с токенами

Decode Token
11.2 Generate Token

12 Операции с транзакциями

12.1 Broadcast Transaction
12.2 Calculate Full Hash
12.3 Get Account Transaction IDs
12.4 Get Unconfirmed Account Transaction IDs
12.5 Get Transaction
12.6 Parse Transaction
12.7 Get Transaction Bytes
12.8 Запрос
12.9 Send Lm
12.10 Sign Transation

13 ""Коды ошибок""

Описание

LibreMoney API позволяет взаимодействовать с нодами LibreMoney посредством HTTP GET/POST запросов. Ответы возвращаются в виде JSON объектов.

Все API вызовы делаются посредством общения с нодами LibreMoney по порту 1400. Во всех примерах, приведенных здесь, нода представлена, как "localhost". Все примеры и ответы отформатированы для комфортного чтения, поэтому надо помнить, что переносы строк и пробелы не используются в действительности в запросах и ответах.

Многие вызовы API ссылаются на генезис блок. Для справки, ID генезисного блока: XXXXXXXX

Со всеми API функциями можно ознакомиться а также протестировать их по адресу http://localhost:1400/test Для определенных API функций, для ознакомления и тестирования можно использовать запрос вида http://localhost:1400/test?requestType=<specificRequestType> где <specificRequestType> это имя определенной API функции которую вы хотите вызвать

Общие сведения

Все http API запросы которые создают новую транзакцию, работают с publicKey параметром (подпись осуществоляется на стороне клиента, в браузере). publicKey параметр в виде закодированного байтового массива, то операция будет подготовлена сервером и возвращена в JSON ответе как transactionBytes. Этот байтовый массив может теперь быть подписан клиентом, и затем передан обратно на сервер для широковещательной передачи используя API broadcastTransaction.

У всех вызовов API, которые требуют номер аккаунта, могут принимать номер аккаунта как в виде идентификатор учетной записи (цифровой номер аккаунта) или как адрес в формате Reed-Solomon

Операции со счетом

Get Account

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

Запрос

http://localhost:1400/api?
     requestType=getAccount&
     account=ACCOUNTNUM

Where:

ACCOUNTNUM Это ID аккаунта, по которому вы запрашиваете информацию.

Ответ

{
    "publicKey": "PUBKEY",
    "assetBalances": [
        {
            [ARRAY_OF_ASSETs]
        }
    ],
    "balance": "BALANCE",
    "accountRS": "ACCOUNTRS",
    "unconfirmedAssetBalances": [
        {
            [ARRAY_OF_UNCONFIRMED_ASSETs]
        }
    ],
    "account": "ACCOUNT",
    "effectiveBalance": EFFBALANCE,
    "unconfirmedBalance": "UNCONFBALANCE",
    "forgedBalance": "FORGEDBAL"
}

Where:

PUBKEY 64-битный публичный ключ ассоциированный с аккаунтом.
ACCOUNTRS адрес аккаунта в формате Reed-Solomon.
BALANCE: количество MilliLm которым вы владеете независимо от числа подтвержденных транзакций, связанные с этим аккаунтом
ACCOUNT учетная запись, создавшая актив
EFFBALANCE: количество MilliLm которым вы владеете и которое подтверждено более чем 1440 раз. Это эффективный баланс , который может использоваться для форжинга.
UNCONFBALANCE: баланс (в MilliLm) за вычетом всех неподтвержденных исходящих транзакций. Также не включаются неподтвержденные входящие транзакции и double-spending. Пользователь видит неподтвержденный баланс в клиенте.
FORGEDBAL баланс который используется для форжинга, в MilliLm

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAccount&
     account=7898870630272254992

Ответ:

{
    "publicKey": "ce0fc0f2fed0645f7018e251493a8af1e1ecfb444a4603902e71bfd2a4b41558",
    "assetBalances": [
        {
            "asset": "1013693125509851736",
            "balanceQNT": "48"
        }
    ],
    "balance": "1000700000000",
    "accountRS": "LMA-BK2J-ZMY4-93UY-8EM9V",
    "unconfirmedAssetBalances": [
        {
            "unconfirmedBalanceQNT": "48",
            "asset": "1013693125509851736"
        }
    ],
    "account": "7898870630272254992",
    "effectiveBalance": 9932,
    "unconfirmedBalance": "1000700000000",
    "forgedBalance": "0"
}

Verified 5/12/14

Get Account ID

Возвращает номер счета, связанный с переданной парольной фразой.

Запрос

http://localhost:1400/api?
     requestType=getAccountId&
     secretPhrase=PASSPHRASE

Где:

PASSPHRASE — парольная фраза того счета, ID которого вы хотите получить

Ответ

{
     "accountId":       "ACCOUNTNUM"
     "accountRS":       "ACCOUNTRS"
}

Where:

ACCOUNTNUM ассоциированный с аккаунтом ID.
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon.

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAccountId&
     secretPhrase=mySuperSecretPassphraseThatYouCanNeverGuess

Ответ:

{
     "accountId":       "4357314498768237104"
     "accountRS":       "LMA-UWKJ-GFEV-AGY4-5C4YS"
}

Внимание: Вы получите ERRORCODE:1, если вы делаете этот запрос не через метод POST
Проверено 14/05/14

Get Account Block IDs

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

Запрос

http://localhost:1400/api?
     requestType=getAccountBlockIds&
     account=ACCOUNT
     timestamp=TIME

Где:

ACCOUNT — номер счета, который вы хотите проверить
TIME — значение в секундах начиная с создания генезис блока, определяющее время самой ранней генерации блока, который вы бы хотели получить. Установка параметра в 0 даст ID всех блоков, сгенерированных данным аккаунтом.

Ответ

{
     "blockIds":
          [ARRAY_OF_BLOCK_IDs]
}

Примечание: результаты отсортированы в хронологическом порядке (самый ранний блок отображается первым)

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAccountBlockIds&
     account=387977119245692429
     timestamp=0

Ответ:

{
     "blockIds":
          [
               "932115710792099523"
          ]
}

Проверено 15/05/2014

Get Account Public Key

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

Запрос

http://localhost:1400/api?
     requestType=getAccountPublicKey&
     account=ACCOUNTNUM

Где:

ACCOUNTNUM — номер счета, который вы хотите проверить

Ответ

{
     "publicKey":       "PUBKEY"
}

Где:

PUBKEY — 64-битный публичный ключ, связанный с данным счетом.

Примечание: если переданный номер счета не известен, вы получите ошибку с кодом 5. Если счет существует, но с него не посылались транзакции, вы получите пустое значение: {}

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAccountPublicKey&
     account=6483973064837388393

Ответ:

{
     "publicKey":       "29592749cd26f5c1c4bf0225f8ab225f289449b4978495e6fec09d486ae2d217"
}

Проверено 14/05/14

Get Account Transaction IDs

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

Запрос

http://localhost:1400/api?
     requestType=getAccountTransactionIds&
     account=ACCOUNT&
     timestamp=TIME&
     type=TYPE&
     subtype=SUBTYPE

Где:

ACCOUNT — номер счета, который вы хотите проверить
TIME — значение в секундах начиная с создания генезис блока, определяющее время самой ранней транзакции, которую вы бы хотели получить. Установка параметра в 0 даст ID всех транзакций данного аккаунта.
TYPE (Optional) тип транзакции которую вы запрашиваете
SUBTYPE (Optional) тип суб-транзакции которую вы запрашиваете

Ответ

{
     "transactionIds":
          [ARRAY_OF_IDs]
}

Где:

ARRAY_OF_IDs — массив ID транзакций.

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

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAccountTransactionIds&
     account=25940420118693217452&
     timestamp=0

Ответ:

{
     "transactionIds":
          [
               "17484500871708980634",
               "51938275284739120529"
          ]
}

Проверено 15/05/14

Get Balance

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

Запрос

http://localhost:1400/api?
     requestType=getBalance&
     account=ACCOUNT

Где:

ACCOUNT — номер счета LibreMoney

Ответ

{
    "guaranteedBalance": "GUARANTEED_BALANCE",
    "balance": "BALANCE",
    "effectiveBalance": EFFBALANCE,
    "unconfirmedBalance": "UNCONFBALANCE",
    "forgedBalance": "0"
}

Где:

GUARANTEED_BALANCE общий баланс аккаунта соответствующего критериям. Результат выражается в MilliLm
BALANCE количество MilliLm которым вы владеете отображается в MilliLm, независимо от числа подтвержденных транзакций связанных с этими имеющимся аккаунтом.
EFFBALANCE количество которым вы владеете и которые имеют минимум 1440 подтверждений. Этот баланс Это - баланс, который используется для форжинга.
UNCONFBALANCE баланс (в MilliLm) за вычетом всех неподтвержденных исходящих транзакций. Он также не включает не подтвержденные входящие транзакции и double-spending. Пользователь видит этот неподтвержденный балансA в клиенте.
FORGEDBAL баланс который используется аккаунтом для форжинга,выражается в MilliLm

Пример

Запрос:

http://localhost:1400/api?
     requestType=getBalance&
     account=7898870630272254992

Ответ:

{
    "guaranteedBalance": "0",
    "balance": "1000700000000",
    "effectiveBalance": 9932,
    "unconfirmedBalance": "1000700000000",
    "forgedBalance": "0"
}

Проверено 14/05/14

Get Guaranteed Balance

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

Запрос

http://localhost:1400/api?
     requestType=getGuaranteedBalance&
     account=ACCOUNT&
     numberOfConfirmations=CONFIRMATIONS

Где:

ACCOUNT — номер LibreMoney аккаунта
CONFIRMATIONS — минимальное число подтверждений транзакции, позволяющее ей быть видимой при подсчете гарантированного баланса

Ответ

{
     "guaranteedBalance":       GUARANTEED_BALANCE
}

Где:

GUARANTEED_BALANCE — общий баланс счета, удовлетворяющий критериям CONFIRMATIONS. Выражается в MilliLm.

Пример

Запрос:

http://localhost:1400/api?
     requestType=getGuaranteedBalance&
     account=3847997711292454692&
     numberOfConfirmations=15

Ответ:

{
     "guaranteedBalance":       1303400000000
}

Проверено 14/05/14

Lease Balance

Передача вашего баланса в аренду другому аккаунту.

Запрос

http://localhost:1400/api?
     requestType=leaseBalance&
     period=PERIOD&
     recipient=REC&
     secretPhrase=SECRET&
     fee=FEE&
     deadline=DEADLINE&
     referencedTransaction=REFTXID&
     broadcast=BROAD

Где:

PERIOD продолжительность аренды вашего баланса, продолжительность указывается в количестве блоков.
REC аккаунт которому вы передаете в аренду свои средства
SECRET секретная фраза аккаунта передающего в аренду свои средства
FEE комиссия которую вы платите за транзакцию (в MilliLm)
DEADLINE дедлайн транзакции до получения подтверждения, определяется в минутах
REFTXID ID предыдущей транзакции на которую вы ссылаетесь. Это создает зависимые транзакции (цепочка транзакций), означая, что текущая транзакция не может быть подтверждена, пока транзакция на которую вы ссылаетесь, не подтверждена. (опционально)
BROAD если вы хотите чтобы транзакция широковещательно передавалась или нет (опционально)

Ответ

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Где:

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
HASH хеш всех полей транзакции, за исключением подписи
TX ID транзакции
BROAD статус - транзакция была передана или нет
UNTXBYTES байты транзакции с частью подписи, заменяемой нулями

Пример

Запрос:

http://localhost:1400/api?
     requestType=leaseBalance&
     period=2880&
     recipient=1562462127635514638&
     secretPhrase=123&
     fee=100000000&
     deadline=1440

Ответ:

{
     "fullHash":                 "e4d1f83e1cf26ee71d8566d00077510c4a641e04174e7ec3893d7e5aafc82e65", 
     "signatureHash":            "48cab5351b4c08ac2816b5e13e9d238fa910085a0d07a16e1c7d7986222fc444", 
     "transactionBytes":         "0400401adb00a005668683e673274c671802492d6f5...", 
     "hash":                     "9b64d859cecdf63773d0696777c2783892616f3a793794544531e4fd7b8a66b2", 
     "transaction":              "16676532673329025508", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "0400401adb00a005668683e673274c671802492d6f54cdc..." 
}

Проверено 14/05/14

Start / Stop Forging

Запуск или остановка форжинга аккаунтом, или проверка, чтобы увидеть, форжит ли учетная запись. Учетная запись форжит, когда ее секретная фраза (закрытый ключ) предоставлена серверу/узлу LibreMoney.

Запрос

http://localhost:1400/api?
     requestType=START_OR_STOP_OR_GET&
     secretPhrase=SECRET

Где:

START_OR_STOP startForging или stopForging
SECRET секретная фраза (личный ключ) для аккаунта, форжинг на котором вы хотите начать или остановить

Ответ

{
     "deadline":       DEADLINE
}

Где:

DEADLINE оценочное число секунд до генерации аккаунтом нового блока

Для "stopForging":

{
     "foundAndStopped":       TRUE_OR_FALSE
}

Пример

Запрос:

http://localhost:1400/api?
     requestType=startForging&
     secretPhrase=MySuperSecretPasswordThatIsNotActuallyPostedHereOrIsEvenRealSoDoNotEvenTryIt

Ответ:

{
     "deadline":       1036742
}

Проверено 14/05/14

Set Account Information

Установка сведений об аккаунте

Request

http://localhost:1400/api?
     requestType=setAccountInfo&
     secretPhrase=SECRET&
     name=NAME&
     description=DESCRIPT&
     publicKey=PUBKEY&	
     fee=FEE&
     deadline=DEADLINE&
     referencedTransactionFullHash=REFTXHASH&
     broadcast=BROAD

Где:

SECRET секретная фраза (приватный ключ) аккаунта
DEADLINE дедлайн для транзакции, задается в минутах
FEE комиссия за транзакцию (в MilliLm)
PUBKEY открытый ключ передающего счета для транзакции (опционально)
NAME имя которое вы хотите установить для аккаунта(опционально)
DESCIPT описание которое вы хотите дать для аккаунта(опционально)
REFTXHASH ID транзакции, на которую ссылается эта транзакция(опционально)
BROAD true или false если это должно быть передано широковещательно (опционально)

Ответ

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Where:

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
HASH хэш всех полей транзакции, за исключение подписи
TX ID транзакции
BROAD указывает была транзакция передана или нет
UNTXBYTES байты транзакции c подписью, частично замененной нулями

Пример

Запрос:

http://localhost:1400/api?
     requestType=setAccountInfo&
     secretPhrase=MySuperSecretPasswordThatIsNotActuallyPostedHereOrIsEvenRealSoDoNotEvenTryIt&
     fee=100000000&
     deadline=1440

Ответ:

{ 
     "fullHash":                 "93e8bba270eed8693f62576e13b45b45a848dd475e510fdb1e4026712829b734", 
     "signatureHash":            "5487681f5a828d379864cbbdba9b1f4f2c6f7035c8cf2f272dc323147aea5eac", 
     "transactionBytes":         "0105c84ad700a005668683e673274c671802492d6f54cdc33d247aa426e7...", 
     "hash":                     "6b6ec6ad2f06119493caca546b6561069cd5341b41884d5be068e0b1d9ce7748", 
     "transaction":              "7627108136485906579", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "0105c84ad700a005668683e673274c671802492d6f54cdc33d247aa4..." 
}

Проверено 14/05/14

Действия с Альясами

Создание/присвоение альяса

Позволяет вам создать альяс в один запрос. Если данный альяс уже существует , этот запрос присвоит новый URI псевдониму.

Запрос

http://localhost:1400/api?
     requestType=assignAlias&
     secretPhrase=SECRET&
     alias=ALIAS&
     uri=URI&
     fee=FEE&
     deadline=DEADLINE&
     publicKey=PUBKEY&
     referencedTransactionFullHash=TRANSFULLHASH&
     broadcast=BROAD

Где:

SECRET секретная фраза аккаунта
ALIAS альяс, который вы хотите создать
URI текст альяса (на пример http://www.google.com/)
FEE комиссия (в MilliLm) за транзакцию
DEADLINE дедлайн для транзакции, задается в минутах
PUBKEY 64-битный публичный ключ ассоциированный с данным аккаунтом. (опционально)
TRANSFULLHASH Если Вы хотите сослаться на другую транзакцию(опционально)
BROAD true или false если это должно быть опубликовано широковещательно (опционально)

'Ответ'

{
     "transactionId":       "TXID"
}
{ 
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Проверено 15/05/14

Пример

Запрос:

http://localhost:1400/api?
     requestType=setAlias&
     secretPhrase=123&
     aliasName=Google&
     aliasURI=http://google.com&
     fee=100000000&
     deadline=1440

Результат:

{ 
     "fullHash":                 "645853ddc55daa2c948f46520b0630d964ce0f40c0ee03515faffce6259d0bae", 
     "signatureHash":            "1e622a64292f8b1fcb1ccf155a42a37a99b89cbcaa725f1200ab55b5ec5f1ca8", 
     "transactionBytes":         "0101fe21d700a005668683e673274c671802492d6f54cdc33d247aa426e7ce...", 
     "hash":                     "580c1bb70d7bcb1eb967c4e86c6c9bfc481641dcce84300a579caf35840e662a", 
     "transaction":              "3218487988112808036", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "0101fe21d700a005668683e673274c671802492d6f54cdc33d247a..." 
}

Исправлено 22/05/14

Get alias

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

Запрос

https://localhost:1400/api?
     requestType=getAlias&
     alias=ALIAS_ID

Где:

ALIAS_ID альяс который вас интересует
ALIAS_NAME имя альяса который вас интересует

Ответ

{
     "timestamp":  TIMESTAMP, 
     "aliasName":      "ALIAS", 
     "account":    "ACCOUNT",
     "accountRS":  "ACCOUNTRS",
     "aliasURI":        "URI",
     "alias":      "ALIAS_ID"
}

Где:

TIMESTAMP метка времени, когда был создан альяс. Задается в секундах, от даты создания генезисного блока
ALIAS название альяса
ACCOUNT аккаунт, который владеет альсом
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon
URI адрес, на который указывает псевдоним
ALIAS_ID идентификатор альяса (id)

Пример

Запрос:

https://localhost:1400/api?
     requestType=getAlias&
     alias=15515279700680480368

Ответ:

{
     "timestamp": 2409343, 
     "alias":     "google", 
     "account":   "5629477397208681336",
     "accountRS": "LMA-FLVS-VRBV-LDPD-6DZ9W",
     "uri":       "http://google.com"
}

Проверено 15/05/14

Get aliases

Возвращает информацию о всех альясах для указанного аккаунта (начиная с указанной метки времени, если задано)

Запрос

https://localhost:1400/api?
     requestType=getAliases&
     account=ACCOUNT&
     timestamp=TIMESTAMP

Где:

ACCOUNT аккаунт, список альясов которого вас интересует
TIMESTAMP время начиная с которого были созданы альясы. Задается в секундах начиная с времени создания генезисного блока.

Ответ

{
     "aliases": [
     {
          "timestamp":  TIMESTAMP, 
          "aliasName":      "ALIAS", 
          "account":    "ACCOUNT",
          "accountRS":  "ACCOUNTRS",
          "aliasURI":        "URI",
          "alias":      "ALIAS_ID"
     },
     {
          ...
     }]
}

Где:

TIMESTAMP метка времени, когда был создан альяс. Задается в секундах, от даты создания генезисного блока
ALIAS название альяса
ACCOUNT аккаунт, который владеет альсом
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon
URI адрес, на который указывает псевдоним
ALIAS_ID идентификатор альяса (id)

Пример

Запрос:

https://localhost:1400/api?
     requestType=getAliases&
     account=5629477397208681336

Ответ:

{
    "aliases": [
        {
            "timestamp": 2409602,
            "aliasName": "promotion",
            "alias": "11086300057073013586",
            "aliasURI": "",
            "accountRS": "LMA-FLVS-VRBV-LDPD-6DZ9W",
            "account": "5629477397208681336"
        },
        {
            ...
        }
               ]
}

Проверено 26/05/14

Get alias ID (Не используется)

Возвращает ID определенного алиаса. Реализовано начиная с версии 0.5.4e. Функция не используется с версии клиента 1.1.4.

Запрос

https://localhost:1400/api?
     requestType=getAliasId&
     alias=ALIAS

Где:

ALIAS — альяс, ID которого вы хотите получить

Ответ

{
     "id":       "ALIAS_ID"
}

'Пример'

Запрос:

https://localhost:1400/api?
     requestType=getAliasId&
     alias=google

Ответ:

{
     "id":       "15515279700680480368"
}

Проверено 15/05/14

Get alias IDs (Не используется)

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

Запрос

https://localhost:1400/api?
     requestType=getAliasIds&
     timestamp=TIMESTAMP

Где:

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

'Ответ'

{
     "aliasIds":       [ARRAY_OF_ALIAS_IDs]
}

Проверено 14/05/14

Пример

Запрос:

https://localhost:1400/api?
     requestType=getAliasIds&
     timestamp=30000

Результат:

{
     "aliasIds":
               ["12219820415480193342",
               "2284413548488744428",
               "6882945328050210195"...]
}

Исправлено 22/05/14

Get alias URI (Не используемый)

Возвращает целевой URI альяса. Функция не используется, начиная с клиента версии 1.1.4

Запрос

http://localhost:1400/api?
     requestType=getAliasURI&
     alias=ALIAS

Где:

ALIAS альяс, целевой URI которого Вы хотели бы видеть

'Ответ'

{
     "uri":       "URI_ASSIGNED_TO_ALIAS"
}

Внимание: Возвращенный URI будет ограничен! Проверено 14/05/14

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAliasURI&
     alias=Google

Ответ:

{
     "uri":       "http:\/\/google.com"
}

Исправлено 22/05/14

List Aliases (Не испольузется)

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

Запрос

http://localhost:1400/api?
     requestType=listAccountAliases&
     account=ACCOUNT

Где:

ACCOUNT — номер аккаунта

'Ответ'

{
     "aliases": 
          [ 
               { 
                    "alias":        "ALIAS",  
                    "uri":          "URI",
                    "account":      "ACCOUNT",
                    "timestamp":    "TIMESTAMP"
               } 
          ] 
}

Пример

Запрос:

http://localhost:1400/api?
     requestType=listAccountAliases&
     account=17157779854388545959

Ответ:

{
     "aliases":
          [
               {
                    "alias":     "testalias",
                    "uri":       "1337",
                    "account":   "17157779854388545959",
                    "timestamp":  2920016
               }
          ]
}

Проверено 14/05/14

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

Send Message

Создает транзакцию с исходящим произвольным сообщением.

Запрос

http://localhost:1400/api?
     requestType=sendMessage&
     secretPhrase=SECRET&
     recipient=RECIP_ACCOUNT&
     fee=FEE&
     message=HEX_STRING&
     deadline=DEADLINE&
     referencedTransaction=REFTXID&
     broadcast=BROAD

Где:

SECRET секретная фраза аккаунта, который отправляет сообщение
RECIP_ACCOUNT номер аккаунта, которому отправляется сообщение (получателя)
HEX_STRING сообщение в hex кодировке. Механизмы шифрования сообщения не предусмотрены, оставлено для разработчиков. Длинна сообщения ограниченна 1000 байтами.
FEE комиссия (в MilliLm) за транзакцию
DEADLINE дедлайн транзакции, указывается в минутах
REFTXID ID предыдущей транзакции на которую вы ссылаетесь. Это создает зависимые транзакции (цепочка транзакций), означая, что текущая транзакция не может быть подтверждена, пока транзакция на которую вы ссылаетесь, не будет подтверждена. (опционально)
BROAD если вы хотите чтобы транзакция широковещательно передавалась или нет (опционально)

Ответ

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Где:

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
HASH хэш всех полей транзакции, за исключение подписи
TX ID транзакции
BROAD указывает была транзакция передана или нет
UNTXBYTES байты транзакции c подписью, частично замененной нулями

Проверено 15/05/14

Пример

Запрос:

http://localhost:1400/api?
     requestType=sendMessage&
     secretPhrase=MySuperSecretPasswordThatYouDoNotKnow&
     recipient=501860284368&
     message= 6602b1611f921092bdf2a89fc97148ec9684066776b83fd3&
     deadline=720&
     referencedTransaction=8815617645011985536

Ответ:

{ 
     "fullHash":                 "d56ade2c322083d76ebcdb9f9ef18d7d52c6d105f67be040cc423c7a41a47aea", 
     "signatureHash":            "458514e72f4272c789f99201c27cff611460de10fe484b474166c1199c23e754", 
     "transactionBytes":         "0100471ddb00a005668683e673274c671802492d6f54cdc33d247aa426e7cef...", 
     "hash":                     "36a0dc90736d95ad5302f078d5db6fc48e5c087b76da65944f7fe2836b73abcd", 
     "transaction":              "15529291339976829653", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "0100471ddb00a005668683e673274c671802492d6f54cdc33d247aa4..." 
}

Проверено 13/05/14

Операции для работы с блоками

Get Block

Получить данные блока.

Запрос

http://localhost:1400/api?
     requestType=getBlock&
     block=BLOCKADDRESS

Где:

BLOCKADDRESS адрес блока LibreMoney

Ответ

{
     "generatorRS": "ACCOUNTRS",
     "previousBlockHash":"32BytesRepresentedInHexadecimalForm",
     "payloadLength":PAYLOADLEN,
     "totalAmount":TOTAL,
     "generationSignature":"64BytesRepresentedInHexadecimalForm",
     "generator":"ACCOUNT",
     "baseTarget":"BASETARGET",
     "payloadHash":"32BytesRepresentedInHexadecimalForm",
     "nextBlock":"NEXTBLOCK",
     "numberOfTransactions":NUMTX,
     "blockSignature":"64BytesRepresentedInHexadecimalForm",
     "transactions":
          [
               "TRANSACTION1",
               "TRANSACTION2"
          ],
     "version":VERSION,
     "totalFee":"FEE",
     "previousBlock":"PREVBLOCK",
     "height":HEIGHT,
     "timestamp":TIME
}

Где:

HEIGHT высота блока
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon
"generator" аккаунт который сгенерировал блок.
ACCOUNT номер аккаунта.
TIME время в секундах когда блок был сгенерирован; 0 время создания генезисного блока.
NUMTX количество транзакций в этом блоке
TOTAL общее количество MilliLm в данном блоке
FEE комиссия MilliLm для данного блока
VERSION версия блока
BASETARGET целевой hash для генерации блока
Payload length = "numberOfTransactions" * 128 Bytes.
"previousBlock" адрес предыдущего блока. Параметр будет пустым для генезисного блока.
PREVBLOCK адрес предыдущего блока
"nextBlock" адрес следующего блока за текущим. Параметр будет пустым для последнего блока в blockchain.
NEXTBLOCK адрес следующего блока, за указанным
"transactions" список/массив идентификаторов (ID) транзакций представленных в этом блоке.
TRANSACTIONX идентификаторы (ID) транзакций в блоке

Пример

Запрос:

http://localhost:1400/api?
     requestType=getBlock&
     block=3081264592726137683

Ответ:

{
     "generatorRS": "LMA-25TQ-G377-8TJ9-EVPAD",
     "previousBlockHash":"d2df42de82c3fbc808715ce9738630b31bece282864fafd164b0d4cf5b0e9e3e",
     "payloadLength":256,
     "totalAmount":"16400300000000",
     "generationSignature":"5beac191d5a20b443b9fdd83cfeb3abddfb31294c1999a85c75955a4c99b3f3c",
     "generator":"14241151062656421686",
     "baseTarget":"191236740",
     "payloadHash":"fc153c1f3d18af9e5a60be42bee896b19089a4b1e391179c98c2a9d2d383275f",
     "nextBlock":"5728643978405745233",
     "numberOfTransactions":2,
     "blockSignature":"5bf8d6f39c6303815dbf591667d613175e916520052f21ffaddec818e2e4ab0cca07f17b0dea8352e837aa89e774cd95dbeb5a2bdab1f1f50f5955d1a3718375",
     "transactions":
          [
               "10431005438877942947",
               "16244324356084723003"
          ],
     "version":2,
     "totalFee":"200000000",
     "previousBlock":"14482383993582051282",
     "height":115147,
     "timestamp":12439666
}

Проверено 15/05/14

Операции на Бирже Активов

Обратите внимание - единицей биржевой операции является АКТИВ. Активом может быть что угодно - другая криптовалюта, акции и т.п.

Issue asset

Создание актива для биржи

Запрос

http://localhost:1400/api?
     requestType=issueAsset& 
     secretPhrase=SECRET& 
     name=ASSETNAME& 
     description=DESCRIPTION& 
     quantityQNT=QTY&
     decimals=DECIMALS&
     fee=FEE&
     deadline=DEADLINE& 
     referencedTransaction=REFTX&
     broadcast=BROAD

Where:

SECRET секретная фраза аккаунта создающего актив.
ASSETNAME имя актива, который вы создаете для продажи на бирже
DESCRIPTION описание актива. Этот текст должен быть URL-encoded, но может включать любые Unicode символы, и иметь максимальную длину 1000 символов. (опционально)
QTY количество единиц актива
DECIMALS количество знаков после запятой для указанного актива. Для примера, для USD это будет 2 (т.е. 1.87 USD), для Bitcoin это будет 8 (т.е. 0.00000025 BTC)
FEE комиссия (в MilliLm) за транзакцию по созданию актива. На данный момент минимальная комиссия за создание активасоставляет 1000 MilliLm
DEADLINE дедлайн до подтверждения транзакции, задается в минутах
REFTXID ID предыдущей транзакции на которую вы ссылаетесь. Это создает зависимые транзакции (цепочка транзакций), означая, что текущая транзакция не может быть подтверждена, пока транзакция на которую вы ссылаетесь, не будет подтверждена. (опционально)
BROAD если вы хотите чтобы транзакция широковещательно передавалась или нет (опционально)

Проверено 15/05/14

Ответ

В ответе возвращаются идентификаторы транзакции (ID), который является также ID актива

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Where:

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Полезно для транзакций условного депонирования
TXBYTES байткод транзакции
HASH шэх всех полей транзакции за исключением подписи
TX идентификатор (ID) транзакции
BROAD указывает была транзакция передана или нет
UNTXBYTES байты транзакции c подписью, частично замененной нулями

Исправлено 22/05/14

Пример

Запрос:

http://localhost:1400/api?
     requestType=issueAsset&
     secretPhrase=123&
     name=turtleCoin&
     description=This+is+Turtlecoin+issued+by+Tommy-Turtle&
     quantityQNT=500& 
     deadline=1440&
     fee=1000

Ответ:

{ 
     "fullHash":                 "ebccb29dc4286a4a55ad9f0a4334cd3b0df75c26fcaf4a6ee3b62832f8f1a403", 
     "signatureHash":            "adb63682ac9598b7ea951df09535ee662b4b2f977e4f8a3f1a1aa0fd1f3e3da1", 
     "transactionBytes":         "0200701fdb00a005668683e673274c671802492d6f54cdc33d247aa426e7cef83776...", 
     "hash":                     "f1fa3f7b8ca5dd38d529e9f9a052aac0f96a7e5a4ef57cdabb0e4633cb4fcd89", 
     "transaction":              "5362143131262438635", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "0200701fdb00a005668683e673274c671802492d6f54cdc33d247aa426e7ce..." 
}

Проверено 13/06/14

Get asset IDs

Получить список всех идентификаторов актива на бирже

Запрос

http://localhost:1400/api?
     requestType=getAssetIds

'Результат'

{
     "assetIds":       [ARRAY_OF_ASSET_IDs]
}

Где ARRAY_OF_ASSET_IDs - массив/список идентификаторов актива

'Пример'

Запрос:

http://localhost:1400/api?
     requestType=getAssetIds

Результат:

{
     "assetIds":
          [
               "923860986719836", 
               "46556984592384756298", 
               "87918658237693184156",
               ...
          ]
}

Проверено 15/05/14

Get asset

Позволяет получить информацию ассоциированную с ID актива

Request

http://localhost:1400/api?
     requestType=getAsset& 
     asset=ASSETID

Где:

ASSETID ID актива, который вас интересует

Response

{
     "account":          "ACCOUNT", 
     "accountRS":        "ACCOUNTRS",
     "name":             "NAME", 
     "description":      "DESCRIPTION", 
     "quantityQNT":       QTY,
     "asset":             ASSETID,
     "decimals":          DECIMALS, 
     "numberOfTrades":    NUMTRADES
}

Где:

ACCOUNT аккаунт которому принадлежит актив
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon.
NAME имя/название актива
DESCRIPTION описание актива. Данная запись может не возвращаться, если описание отсутствует.
QTY количество единиц актива
ASSETID ID актива который вас интересует
DECIMALS количество знаков после запятой для указанного актива. Для примера, для USD это будет 2 (т.е. 1.87 USD), для Bitcoin это будет 8 (т.е. 0.00000025 BTC)
NUMTRADES число сделок с этим активом

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAsset& 
     asset=46556984592384756298

Ответ:

{
     "account":           "334765832685676",
     "accountRS":         "LMA-DE2F-W76R-GL25-HMFPR",
     "name":              "cfbBTCx1", 
     "description":       "This is BTC issued by Come-from-Beyond", 
     "quantityQNT":       500,
     "asset":             46556984592384756298,
     "decimals":          6, 
     "numberOfTrades":    0
}

Проверено 15/05/14

Get assets

Получить информацию, связанную с несколькими идентификаторами активов

Запрос

http://localhost:1400/api?
     requestType=getAssets& 
     assets=ASSETID&
     assets=ASSETID&
     ...

Где:

ASSETID ID актива, который вас интереесует

Запрос

{
     "assets": [ {
          "account":          "ACCOUNT", 
          "accountRS":        "ACCOUNTRS",
          "name":             "NAME", 
          "description":      "DESCRIPTION", 
          "quantityQNT":       QTY,
          "asset":             ASSETID,
          "decimals":          DECIMALS, 
          "numberOfTrades":    NUMTRADES
     },
     {
          ...
     }]
}

Где:

ACCOUNT аккаунт которому принадлежит актив
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon.
NAME имя/название актива
DESCRIPTION описание актива. Данная запись может не возвращаться, если описание отсутствует.
QTY количество единиц актива
ASSETID ID актива который вас интересует
DECIMALS количество знаков после запятой для указанного актива. Для примера, для USD это будет 2 (т.е. 1.87 USD), для Bitcoin это будет 8 (т.е. 0.00000025 BTC)
NUMTRADES число сделок с этим активом

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAssets& 
     assets=46556984592384756298

Ответ:

{
     "assets": [ {
          "account":           "334765832685676", 
          "accountRS":         "LMA-DE2F-W76R-GL25-HMFPR",
          "name":              "cfbBTCx1", 
          "description":       "This is BTC issued by Come-from-Beyond", 
          "quantityQNT":       500,
          "asset":             46556984592384756298,
          "decimals":          6, 
          "numberOfTrades":    0
     } ]
}

Проверено 15/05/14

Get all assets

Предоставляет информацию по всем активам представленным на бирже

Запрос

http://localhost:1400/api?
     requestType=getAllAssets

Ответ

{
     "assets": 
     [ { 
          "account":           "ACCOUNT", 
          "accountRS":         "ACCOUNTRS"
          "name":              "NAME", 
          "description":       "DESCRIPTION", 
          "quantityQNT":       QTY,
          "asset":             ASSETID,
          "decimals":          DECIMALS, 
          "numberOfTrades":    NUMTRADES
     } ] 
}

Где:

ACCOUNT аккаунт которому принадлежит актив
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon.
NAME имя/название актива
DESCRIPTION описание актива. Данная запись может не возвращаться, если описание отсутствует.
QTY количество единиц актива
ASSETID ID актива который вас интересует
DECIMALS количество знаков после запятой для указанного актива. Для примера, для USD это будет 2 (т.е. 1.87 USD), для Bitcoin это будет 8 (т.е. 0.00000025 BTC)
NUMTRADES число сделок с этим активом

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAllAssets

Ответ:

{
     "assets": 
     [ { 
          "decimals":       7, 
          "numberOfTrades": 0, 
          "asset":          "3283533989023503499", 
          "quantityQNT":    "132249500000000", 
          "description":    "CCGGUQMJKOMUCLBIEGGTKCQVSBSJAZSE", 
          "name":           "GZSHFQY", 
          "account":        "14136559604731496960",
          "accountRS":      "LMA-KRDB-ZFA3-RNDV-AALNT"
       },
       { 
          "decimals":       6, 
          "numberOfTrades": 0, 
          "asset":          "5008310702202713285", 
          "quantityQNT":    "994512000000000", 
          "description":    "QESZUYEJCGBGHBVXIRC", 
          "name":           "GWNU", 
          "account":        "14136559604731496960",
          "accountRS":      "LMA-UWKJ-GFEV-AGY4-5C4YS"
       },
       ...
     ]
}

Проверено 15/05/14

Get assets by name (Не используется)

Предоставляет информацию ассоциированную с именем актива. Функция не используется начиная с версии клиента 1.1.4.

Запрос

http://localhost:1400/api?
     requestType=getAssetsByName& 
     assetName=ASSET

Где:

ASSET название актива, который вас интересует

Ответ

{
     "assets": 
     [ { 
          "account":           "ACCOUNT",
          "accountRS":         "ACCOUNTRS"
          "name":              "NAME", 
          "description":       "DESCRIPTION", 
          "quantityQNT":       QTY,
          "asset":             ASSETID,
          "decimals":          DECIMALS, 
          "numberOfTrades":    NUMTRADES
     } ] 
}

Where:

ACCOUNT аккаунт которому принадлежит актив
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon.
NAME имя/название актива
DESCRIPTION описание актива. Данная запись может не возвращаться, если описание отсутствует.
QTY количество единиц актива
ASSETID ID актива который вас интересует
DECIMALS количество знаков после запятой для указанного актива. Для примера, для USD это будет 2 (т.е. 1.87 USD), для Bitcoin это будет 8 (т.е. 0.00000025 BTC)
NUMTRADES число сделок с этим активом

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAssetsByName& 
     assetName=GZSHFQY

Ответ:

{
     "assets": 
     [ { 
          "decimals":       7, 
          "numberOfTrades": 0, 
          "asset":          "3283533989023503499", 
          "quantityQNT":    "132249500000000", 
          "description":    "CCGGUQMJKOMUCLBIEGGTKCQVSBSJAZSE", 
          "name":           "GZSHFQY", 
          "account":        "14136559604731496960",
          "accountRS":      "LMA-UWKJ-GFEV-AGY4-5C4YS"
     } ] 
}

Проверено 15/05/14

Get assets by issuer

Возвращает все активы, которые создал указанный аккаунт

Запрос

http://localhost:1400/api?
     requestType=getAssetsByIssuer& 
     account=ACCOUNT

Где:

ACCOUNT аккаунт который выпустил актив

Ответ

{
     "assets": 
     [ { 
          "account":                 "ACCOUNT", 
          "accountRS":             "ACCOUNTRS",
          "name":                    "NAME", 
          "description":           "DESCRIPTION", 
          "quantityQNT":          QTY,
          "asset":                      ASSETID,
          "decimals":                DECIMALS, 
          "numberOfTrades":    NUMTRADES
     } ] 
}

Где:

ACCOUNT аккаунт которому принадлежит актив
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon.
NAME имя/название актива
DESCRIPTION описание актива. Данная запись может не возвращаться, если описание отсутствует.
QTY количество единиц актива
ASSETID ID актива который вас интересует
DECIMALS количество знаков после запятой для указанного актива. Для примера, для USD это будет 2 (т.е. 1.87 USD), для Bitcoin это будет 8 (т.е. 0.00000025 BTC)
NUMTRADES число сделок с этим активом

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAssetsByIssuer& 
     account=1562462127635514638

Ответ:

{
     "assets": 
     [ { 
          "decimals":             7, 
          "numberOfTrades": 0, 
          "asset":                   "3283533989023503499", 
          "quantityQNT":        "132249500000000", 
          "description":          "CCGGUQMJKOMUCLBIEGGTKCQVSBSJAZSE", 
          "name":                   "GZSHFQY", 
          "accountRS":            "LMA-GKAG-2VGD-U473-3VRDD",
          "account":                "1562462127635514638"
     } ] 
}

Проверено 15/05/14

Get all trades

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

Запрос

http://localhost:1400/api?
     requestType=getAllTrades& 
     timestamp=TIME

Где:

TIME задается в секундах, от времени создания генезисного блока. Установка параметра в 0 вернет все сделки (опционально)

Ответ

{
     "trades": [
     { 
          "timestamp":   TIME, 
          "price":    "PRICE", 
          "asset":       "ASSETID", 
          "quantityQNT": "QTY", 
          "block":       "BLOCK", 
          "askOrder":    "ASK", 
          "bidOrder":    "BID" 
     },
     {
          ...
     }
     ]
}

Где:

TIME время заданное в секундахis от момента создания генезисного блока
ASSETID ID актива
QTY количество ордеров
PRICE цена, выраженная в MilliLm
BLOCK блок сделки
ASK ID ордера на покупку
BID ID ордера на продажу

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAllTrades

Ответ:

{
     "trades": [ 
     { 
          "timestamp":   13530463, 
          "price":    "2500000000", 
          "asset":       "13920592454636198263", 
          "quantityQNT": "2", 
          "block":       "1942829179466651543", 
          "askOrder":    "16791208091984728819", 
          "bidOrder":    "12730658526877674075" 
     },
     {
          ...
     }
     ]
}

Проверено 15/05/14

Get trades

ПОлучить все торговые операции по активу с указанным ID

Запрос

http://localhost:1400/api?
     requestType=getTrades& 
     asset=ASSETID&
     firstIndex=RANGE_START
     lastIndex=RANGE_END

Где:

ASSETID ID актива который вас интересует
RANGE_START порядковый номер самой ранней торговой операции, которую вы хотите увидеть. Если не указанно, то по умолчанию 0
RANGE_END порядковый номер последней торговой операции которую вы хотите видеть. Если не указанно, то по умолчанию устанавливается 2³²-1

Ответ

{
     "trades": [
     { 
          "timestamp":   TIME, 
          "price":    "PRICE", 
          "asset":       "ASSETID", 
          "quantityQNT": "QTY", 
          "block":       "BLOCK", 
          "askOrder":    "ASK", 
          "bidOrder":    "BID" 
     },
     {
          ...
     }
     ]
}

Где:

TIME is the time expressed in seconds since the genesis block of the trade
ASSETID ID актива
QTY количество ордеров
PRICE цена, указывается в MilliLm
BLOCK блок сделки
ASK ID ордера на покупку
BID ID ордера на продажу

Пример

Запрос:

http://localhost:1400/api?
     requestType=getTrades& 
     asset=14269709746849295412&
     firstIndex=0

Ответ:

{
     "trades": [
     { 
          "timestamp":   13386268, 
          "price":    "100000000", 
          "asset":       "13388701969217905199", 
          "quantityQNT": "12", 
          "block":       "15363991879367428772", 
          "askOrder":    "9028610672087970547", 
          "bidOrder":    "7785235474459518056" 
     },
     {
          ...
     }
     ] 
}

Проверено 15/05/14

Transfer asset

Функция для передачи определенного количества актива с одного аккаунта на другой

Запрос

http://localhost:1400/api?
     requestType=transferAsset&
     secretPhrase=SECRET&
     recipient=ACCOUNT& 
     asset=ASSETID&
     comment=COMMENT&
     quantityQNT=QTY&
     fee=FEE&
     deadline=DEADLINE& 
     referencedTransaction=REFTXID&
     broadcast=BROAD

Где:

SECRET секретная фраза аккаунта который осуществляет передачу актива
RECIPIENT аккаунт получателя
ASSETID идентификатор (ID) актива который будет передаваться
QTY количество единиц актива которое будет передаваться
COMMENT комментарий к перемещению (опционально)
FEE объем комиссии за эту транзакция, в MilliLm
DEADLINE время в минутах, в течении которого транзакция должна быть подтверждена в сети.
REFTX Идентификатор (ID)предыдущей транзакции на которую ссылается данная транзакция. Это значит, что создается цепочка зависимых транзакций, и текущая транзакция не может быть подтверждена, пока транзакция, на которую ссылаются, не будет подтверждена (опционально)
BROAD если вы хотите чтобы транзакция широковещательно передавалась или нет (опционально)

Ответ

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Где

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
HASH хэш всех полей транзакции, за исключение подписи
TX ID транзакции
BROAD указывает была транзакция передана или нет
UNTXBYTES байты транзакции c подписью, частично замененной нулями

Пример

Запрос:

http://localhost:1400/api?
     requestType=transferAsset&
     secretPhrase=123&
     recipient=81623458239475&
     asset=46556984592384756298&
     quantityQNT=45&
     fee=100000000&
     deadline=1440

Ответ:

{ 
     "fullHash":                 "9bd14e7a93d228a85e82a98071f1bd96c158dda856311722e6feafb1a36e71e2", 
     "signatureHash":            "540a2963aac95e63c5e4d13b452be02160e5ecd9cb1c3e8306eed4b47975b9ba", 
     "transactionBytes":         "0201f120db00a005668683e673274c671802492d6f54cdc33d247a...", 
     "hash":                     "8633ca65458bb9895ef53c3875ff59dd4b85ddf922dcaae3f276796932d33731", 
     "transaction":              "12117166328294330779", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "0201f120db00a005668683e673274c671802492d6f54cdc33d2..." 
}

Проверено 15/05/14

Place order

Размещает на бирже заявку на "покупку" или "продажу" актива

Запрос

http://localhost:1400/api?
     requestType=BID_OR_ASK&
     secretPhrase=SECRET&
     asset=ASSETID&
     quantityQNT=QTY&
     price=PRICE&
     fee=FEE&
     deadline=DEADLINE&
     referencedTransaction=REFTXID&
     broadcast=BROAD

Где:

BID_OR_ASK тип размещаемой заявки "placeAskOrder" (купить) or "placeBidOrder"(продать)
SECRET секретная фраза от аккаунта, который создает транзакцию
ASSETID идентификатор (ID) актива на который формируется запрос
QTY количество единиц актива на который формируется запрос
PRICE цена покупки/продажи, измеряется в MilliLm (т.е. "1456" это "1.456 Lm")
FEE комиссия за эту транзакцию, в MilliLm
DEADLINE время в минутах, в течении которого данная транзакция должна быть подтверждена в сети.
REFTX Идентификатор (ID)предыдущей транзакции на которую ссылается данная транзакция. Это значит, что создается цепочка зависимых транзакций, и текущая транзакция не может быть подтверждена, пока транзакция, на которую ссылаются, не будет подтверждена (опционально)
BROAD если вы хотите чтобы транзакция широковещательно передавалась или нет (опционально)

'Ответ'

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Где:

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
HASH хеш всех полей транзакции, за исключением подписи
TX ID транзакции
BROAD статус - транзакция была передана или нет
UNTXBYTES байты транзакции с частью подписи, заменяемой нулями

Пример

Запрос:

http://localhost:1400/api?
     requestType=placeBidOrder&
     secretPhrase=123&
     asset=46556984592384756298&
     quantityQNT=70&
     price=145&
     fee=100000000&
     deadline=1440&
     referencedTransaction=65374835678

Ответ:

{
     "fullHash":                 "a797ff58c5ed5c6f53c708dbe137812495c6af0eb280a3d001bb1917eb6a5561", 
     "signatureHash":            "751c9df738e1894ef550bf9e0725188168d4febf48a4da51b1efafaaa840dbcb", 
     "transactionBytes":         "02035d0fdb00a005668683e673274c671802492d6f54cdc33d247aa426e7cef83776...", 
     "hash":                     "4785247b3238fda4fe53d47bc8a97a2b3acf974a02854792b59b092f3473eecd", 
     "transaction":              "8024550067924866983", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "02035d0fdb00a005668683e673274c671802492d6f54cdc33d247aa426e7cef..." 
}

Проверено 15/05/14

Get order IDs

Получить идентификаторы (ID) заявок на покупку/продажу определенного актива

Запрос

http://localhost:1400/api?
     requestType=GET_BID_OR_ASK&
     asset=ASSETID

Где:

GET_BID_OR_ASK тип операции "getAskOrderIds" или "getBidOrderIds"
ASSETID ID актива, ордера по которому вы желаете получить

'Результат'

Возвращает массив (список) ордеров покупки/продажи:

{
     "GET_BID_OR_ASK": [ARRAY_OF_ORDER_IDs]
}

Где:

GET_BID_OR_ASK тип операции "getAskOrderIds" или "getBidOrderIds"

'Пример'

Запрос:

http://localhost:1400/api?
     requestType=getAskOrderIds
     asset=14269709746849295412

Ответ:

{
     "askOrderIds":
          [
               "3467356724512", 
               "824756987236452"
          ]
}

Проверено 16/05/14

Get orders

Возвращает все ордера на покупку/продажу, по указанному активу

Запрос

http://localhost:1400/api?
     requestType=GET_BID_OR_ASK&
     asset=ASSETID&
     limit=LIMIT

Где:

GET_BID_OR_ASK может быть "getAskOrders" или "getAskOrders"
ASSETID идентификатор (ID) актива, информация по которому вас интересует
LIMIT определяет сколько ордеров необходимо отобразить, если не указанно, должен отобразить их все.

Проверено 18/05/14

Ответ

Возвращает массив ордеров покупки/продажи:

{
     "GET_BID_OR_ASK": [ARRAY_OF_ORDERs]
}

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAskOrders
     asset=15680163033397272955

Ответ:

{
    "askOrders": [
        {
            "height": 90703,
            "price": "78932342",
            "asset": "15680163033397272955",
            "order": "4529944714996630823",
            "quantityQNT": "20",
            "accountRS": "LMA-JNYK-TP3W-VDBB-9FRVB",
            "account": "8425933418718057425",
            "type": "ask"
        },
        {
            "height": 77415,
            "price": "99000000",
            "asset": "15680163033397272955",
            "order": "3158651792442050495",
            "quantityQNT": "39",
            "accountRS": "LMA-AMPQ-B6ZZ-S8TL-EFDBH",
            "account": "14386024746077933238",
            "type": "ask"
        },
        {
            "height": 78822,
            "price": "150000000",
            "asset": "15680163033397272955",
            "order": "954178876942447633",
            "quantityQNT": "1",
            "accountRS": "LMA-FVXE-SLB6-KL5V-A2Q75",
            "account": "9337862827899547564",
            "type": "ask"
        }
    ]
}

Исправлено 22/05/14

Get current account order IDs

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

Запрос

http://localhost:1400/api?
     requestType=GET_BID_OR_ASK&
     account=ACCOUNT&
     asset=ASSETID

Где:

GET_BID_OR_ASK может быть "getAccountCurrentAskOrderIds" или "getAccountCurrentBidOrderIds"
ACCOUNT номер аккаунта ордера которого вы хотите получить.
ASSETID идентификатор (ID) актива ордера с которым вы хотите получить.

Ответ

Возвращает массив из всех идентификаторов (ID) запросов/предложений:

{
     "GET_BID_OR_ASK_IDs": 
          [ARRAY_OF_ORDER_IDs]
}

Где:

GET_BID_OR_ASK_IDs может быть "askOrderIds" или "bidOrderIds"

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAccountCurrentAskOrderIds&
     account=1189524830352486657&
     asset=2438729719254516952

Ответ:

{
     "askOrderIds":
          [
               "3467356725412", 
               "824756987456452
          ]
}

Get order

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

Запрос

http://localhost:1400/api?
     requestType=GET_BID_OR_ASK&
     order=ORDERID

Где:

GET_BID_OR_ASK может быть "getAskOrder" или "getBidOrder"
ORDERID Идентификатор (ID) ордера, который вас интересует

Ответ

{
     "account":       "ACCOUNT",
     "accountRS":     "ACCOUNTRS",
     "height":        HEIGHT,
     "asset":         "ASSETID", 
     "quantityQNT":   QTY, 
     "price":      PRICE,
     "order":         "ORDER",
     "type":          "TYPE"
}

Где:

ACCOUNT номер аккаунта ассоциированный с ордером
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon.
ASSETID идентификатор (ID) актива в ордере
QTY количество актива в ордере
PRICE цена, указана в MilliLm
HEIGHT высота блока
ORDER номер ордера
TYPE тип ордера (покупка/продажа)

Пример

Запрос:

http://localhost:1400/api?
     requestType=getBidOrder&
     order=17936094171153028796

Ответ:

{
     "height":        90703, 
     "price":      "78932342", 
     "asset":         "15680163033397272955", 
     "order":         "17936094171153028796", 
     "quantityQNT":   "20", 
     "account":       "8425933418718057425",
     "accountRS":     "LMA-7HL4-WMNR-XGFL-ASVHV", 
     "type":          "ask"
}

Проверено 15/05/14

Get all open orders

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

Запрос

http://localhost:1400/api?
     requestType=getAllOpenOrders

Ответ

{
     "height":        HEIGHT,
     "account":       "ACCOUNT",
     "accountRS":     "ACCOUNTRS",
     "asset":         "ASSETID",
     "order":         "ORDER",
     "quantityQNT":   QTY, 
     "price":      PRICE,
     "type":          TYPE
}

Где:

ACCOUNT номер аккаунта связанный с ордером
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon
ASSETID идентификатор (ID) актива
QTY количеств актива в ордере
PRICE цена, задается в MilliLm
TYPE тип ордера (т.е. покупка, продажа)
HEIGHT высота блока

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAllOpenOrders

Ответ:

{ 
     "openOrders": 
     [ { 
          "height":      90703, 
          "price":    "78932342", 
          "asset":       "15680163033397272955", 
          "order":       "17936094171153028796", 
          "quantityQNT": "20", 
          "account":     "8425933418718057425", 
          "accountRS":   "LMA-2UKS-7VYN-Q73Y-EKE8Y",
          "type":        "ask" 
     }, 
     {
          ...
     }
     ]
}

Проверено 15/05/14

Cancel order

Отмена ранее созданного ордера

Запрос

http://localhost:1400/api?
     requestType=BID_OR_ASK&
     secretPhrase=SECRET&
     order=ORDERID&
     fee=FEE&
     deadline=DEADLINE&
     referencedTransaction=REFTXID&
     broadcast=BROAD

Где:

BID_OR_ASK указание типа операции "cancelAskOrder" или "cancelBidOrder"
SECRET секретная фраза от аккаунта создавшего транзакцию
ORDERID идентификатор(ID) ордера, который необходимо отменить
FEE размер комиссии за данную транзакцию
DEADLINE время (в минутах)в течении которого транзакция должна быть подтверждена
REFTXID идентификатор транзакции (ID) на которую ссылается текущая транзакция. Используется если создана зависимая транзакция и означает, что текущая транзакция не может быть подтверждена, если транзакция, на которую ссылаются еще не подтверждена. Опциональный параметр.
BROAD если вы хотите чтобы транзакция широковещательно передавалась или нет (опционально)

'Ответ'

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
HASH хеш всех полей транзакции, за исключением подписи
TX ID транзакции
BROAD статус - транзакция была передана или нет
UNTXBYTES байты транзакции с частью подписи, заменяемой нулями

Пример

Запрос:

http://localhost:1400/api?
     requestType=cancelAskOrder&
     secretPhrase=123&
     order=3467356724512& 
     fee=100000000&
     deadline=1440

Ответ:

{
     "fullHash":                 "e9c821547e851998f05ef39a39dc196b27f5e3069c1bf516fffaf53359304cc4", 
     "signatureHash":            "a5bf7481f5ad02be69f5fff7cd73c3dd7e443a4335721511e9e79198bc6f0324", 
     "transactionBytes":         "02051316db00a005668683e673274c671802492d6f54cdc33d247aa...", 
     "hash":                     "10ffcff771db618ca243b561943e09fd4098ade100efb2dc68f7861705f6262d", 
     "transaction":              "10959937945806686441", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "02051316db00a005668683e673274c671802492d6f54cdc33d247aa426e7c..." 
}

Проверено 15/05/14

Операции с опросами

Create Poll

Создать новый опрос

Запрос

http://localhost:1400/api?
     requestType=createPoll& 
     name=NAME&
     description=DESCRIP&
     minNumberOfOptions=MINOPTIONS&
     maxNumberOfOptions=MAXOPTIONS&
     optionsAreBinary=BINARY&
     option1=OPTION1&
     option2=OPTION2&
     option3=OPTION3&
     secretPhrase=SECRET&
     fee=FEE&
     deadline=DEADLINE&
     referencedTransactionFullHash=REFTXHASH&
     broadcast=BROAD

Где:

DESCRIP описание опроса
NAME название опроса
MINOPTIONS минимальное число вариантов для опроса
MAXOPTIONS максимальное число вариантов для опроса
OPTION1 название первой опции (OPTIONS 2 & 3 опционально)
SECRET секретная фраза (private key) аккаунта
DEADLINE дедлайн транзакции, задается в минутах
FEE комиссия за транзакцию (в MilliLm)
BINARY указатель бинарности опций (опционально)
REFTXHASH Идентификатор (ID)предыдущей транзакции на которую ссылается данная транзакция (опционально)
BROAD true или false если должна быть широковещаиельная передача (опционально)

Ответ

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Где:

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
HASH хеш всех полей транзакции, за исключением подписи
TX ID транзакции
BROAD статус - транзакция была передана или нет
UNTXBYTES байты транзакции с частью подписи, заменяемой нулями

Проверено 18/05/14

Пример

Запрос:

http://localhost:1400/api?
     requestType=createPoll& 
     name=Testing123&
     description=Testing&
     minNumberOfOptions=1&
     maxNumberOfOptions=1&
     option1=yes&
     option2=no&
     secretPhrase=MySuperSecretPasswordThatIsNotActuallyPostedHereOrIsEvenRealSoDoNotEvenTryIt&
     fee=100000000&
     deadline=1440

Ответ:

{ 
     "fullHash":                 "7ef9e19d0c7943002fd98a7ae08f1b4a1d473c67796f89225b167fd4913ce73f", 
     "signatureHash":            "a76722be0652d5c88cb7292d1cb04ea299eaea74c35ad726e868d08799946c38", 
     "transactionBytes":         "010234fbda00a005668683e673274c671802492d6f54cdc33d247aa426e...", 
     "hash":                     "940383ff1bf177d4e4fee05c78865b12ace2570152c64570219dfc0aa10c246b", 
     "transaction":              "18991918535014782", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "010234fbda00a005668683e673274c671802492d6f54cdc33d247..." 
}

Проверено 13/06/14

Get Poll

Получить информацию о заданном опросе

Запрос

http://localhost:1400/api?
     requestType=getPoll& 
     poll=POLL

Где:

POLL идентификатор (id) опроса который вас интересует

Ответ

{ 
     "description":        "DESCRIP", 
     "name":               "NAME", 
     "maxNumberOfOptions": MAXOPTIONS, 
     "optionsAreBinary":   BINARY, 
     "voters":             [VOTERS], 
     "minNumberOfOptions": MINOPTIONS, 
     "options":            [OPTIONS] 
}

Where:

DESCRIP описание опроса
NAME название опроса
MAXOPTIONS максимальное количество опций опроса
BINARY указатель что опции бинарные
VOTERS количество голосующих в опросе
MINOPTIONS минимальное количество опций опроса
OPTIONS список опций

Пример

Request:

http://localhost:1400/api?
     requestType=getPoll& 
     poll=15826354927269615782

Response:

{ 
     "description":        "Does this work?", 
     "name":               "Test", 
     "maxNumberOfOptions": 1, 
     "optionsAreBinary":   false, 
     "voters":             [], 
     "minNumberOfOptions": 1, 
     "options":            [ "Yes", "No", "I don't know" ] 
}

Проверено 18/05/14

Get Poll IDs

Возвращает ID (идентификаторы) всех голосований

Запрос

http://localhost:1400/api?
     requestType=getPollIds

Ответ

{ 
     "pollIds": 
     [ 
          "POLLID", 
          ...
     ]
}

Где:

POLLID ID голосования

Пример

Запрос:

http://localhost:1400/api?
     requestType=getPollIds

Ответ:

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

Проверено 15/05/14

Cast Vote

Проголосовать в опросе

Запрос

http://localhost:1400/api?
     requestType=castVote& 
     poll=NAME&
     vote1=VOTE1&
     vote2=VOTE2&
     vote3=VOTE3&
     secretPhrase=SECRET&
     fee=FEE&
     deadline=DEADLINE&
     referencedTransactionFullHash=REFTXHASH&
     broadcast=BROAD

Где:

NAME название голосования в котором вы желаете принять участие, проголосовать
VOTE1 ваш голос (VOTE 2 & 3 опционально, если голосование допускает множественные опции)
SECRET секретная фраза (private key) вашего аккаунта
DEADLINE дедлайн транзакции, задается в минутах
FEE комиссия за транзакцию (в MilliLm)
REFTXHASH Идентификатор (ID)предыдущей транзакции на которую ссылается данная транзакция (опционально)
BROAD если вы хотите чтобы транзакция широковещательно передавалась или нет (опционально)

Ответ

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "hash":                     "HASH", 
     "transaction":              "TX", 
     "broadcasted":              BROAD, 
     "unsignedTransactionBytes": "UNTXBYTES" 
}

Where:

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
HASH хеш всех полей транзакции, за исключением подписи
TX ID транзакции
BROAD статус - транзакция была передана или нет
UNTXBYTES байты транзакции с частью подписи, заменяемой нулями

Проверено 18/05/14

Пример

Запрос:

http://localhost:1400/api?
     requestType=castVote& 
     poll=18991918535014782&
     vote1=yes&
     secretPhrase=MySuperSecretPasswordThatIsNotActuallyPostedHereOrIsEvenRealSoDoNotEvenTryIt&
     fee=100000000&
     deadline=1440

Ответ:

{ 
     "fullHash":                 "637ea3215258adef61f7fc5a90eff6435d1a7ad8c3790d5855c6943b9aff1daf", 
     "signatureHash":            "a6745e26165e9c7870c85bd174348e4e72c825378cfb71760e04f08e30879fa6", 
     "transactionBytes":         "010314feda00a005668683e673274c671802492d6f54cdc33...", 
     "hash":                     "10ee68836162f6a8e2559a6dbcbc41c4db4b7441e6ff321f01b268d761c6916d", 
     "transaction":              "17270557255810645603", 
     "broadcasted":              true, 
     "unsignedTransactionBytes": "010314feda00a005668683e673274c671802492d6f54cdc33d247aa426e7..." 
}

Проверено 13/06/14

Операции для работы с серверной частью

Get Constants

Запрос на получение списка всех констант, используемых сервером, и их текущих значений.

Request

http://localhost:1400/api?
     requestType=getConstants

Запрос

{
     "maxBlockPayloadLength":40800,
     "genesisAccountId":"GENESISACC",
     "genesisBlockId":"GENESISBLK",
     "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":"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}
          ]
}

Где:

GENESISACC генезис аккаунт
GENESISBLK генезис блок

Пример

Запрос:

http://localhost:1400/api?
     requestType=getConstants

Ответ:

{
     "maxBlockPayloadLength":40800,
     "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":"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
}

Проверено 15/05/14

Get My Info

возвращает данные сервера - хост и адрес.

Запрос

http://localhost:1400/api?
     requestType=getMyInfo

Ответ

{
     "host":       "HOSTNAME",
     "address":       "ADDRESS"
}

Где:

HOSTNAME - имя хоста сервера
ADDRESS - адрес сервера

Пример

Запрос:

http://localhost:1400/api?
     requestType=getMyInfo

Ответ:

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

Проверено 18/05/14

Get Peer

получает данные о заданном узле (peer)

Запрос

http://localhost:1400/api?
     requestType=getPeer&
     peer=PEERNAME

Где:

PEERNAME - имя узла (peer) о котором вы желаете запросить информацию.

Ответ:

Информация возвращается в том виде и объеме, который хранится на сервере узла в файле web.xml file !

{
     "platform":          "PLATFORM",
     "blacklisted":       BLACKLIST,
     "shareAddress":      SHAREADD
     "application":       "LIBREMONEY",
     "weight":            WEIGHT,
     "hallmark":          "HALLMARK",
     "state":             1,
     "announcedAddress":  "ANNOUNCED",
     "downloadedVolume":  DLBYTES,
     "version":           "VERSION",
     "uploadedVolume":    ULBYTES
}

Где:

PLATFORM строка описывающая платформу указанного сервера
WEIGHT вес узла
BLACKLIST указывает включен узел в blacklisted или нет
SHAREADD указывает является ли узел общедоступным (shared)
HALLMARK строка в формате hex, описывающая hallmark узла (если он установлен)
STATE определяет состояние узла. 1 - активный узел; 0 - известный узел.
ANNOUNCED имя, которое узел сообщает сети (может быть имя DNS, IP-адрес или любая другая строка)
VERSION версия программного обеспечения, работающего на узле
DLBYTES and ULBYTES количество байтов, загруженных и выгруженных узлом

Проверено 18/05/14

Пример

Запрос:

http://localhost:1400/api?
     requestType=getPeer&
     peer=23.88.104.217

Ответ:

{
     hallmark":           "ea53f569819ad8c40d62dd7e4c1f4895b2a3...",
     "downloadedVolume":  115001,
     "blacklisted":       false,
     "announcedAddress":  "mode.libremoney.org",
     "application":       "LIBREMONEY",
     "weight":            911527,
     "uploadedVolume":    4707,
     "state":             1,
     "version":           "0.9.9",
     "platform":          "lm.now.im",
     "shareAddress":      true
}

Проверено 15/05/14

Get Peers

Возвращает все известные вашему клиенту узлы (peers), не зависимо от их состояния на данный момент.

Запрос

http://localhost:1400/api?
     requestType=getPeers

Результат:

Массив имен/адресов узлов:

{
     "peers":
          [
               "PEER",
               "PEER",
               "PEER"...
          ]
}

Пример

Запрос:

http://localhost:1400/api?
     requestType=getPeers

Ответ:

{
     "peers":
     [
          "188.226.176.151",
          "88.202.37.38",
          "87.211.164.253"...
     ]
}

Проверено 18/05/14

Get State

Возвращает информацию о статусе/состоянии запрашиваемого сервера

Запрос

http://localhost:1400/api?
     requestType=getState

Ответ

{
     "numberOfPolls":             NUMPOLLS,
     "numberOfVotes":             NUMVOTES,
     "numberOfTrades":            NUMTRADES,
     "lastBlock":                 "LASTBLOCKID",
     "numberOfAliases":           NUMALIASES,
     "lastBlockchainFeeder":      "FEEDERPEER",
     "numberOfBlocks":            HEIGHT,
     "numberOfPeers":             NUMPEERS
     "totalMemory":               CURMEMORY,
     "freeMemory":                FREEMEMORY,
     "maxMemory":                 MAXMEMORY,
     "numberOfTransactions":      NUMTRANS,
     "numberOfUnlockedAccounts":  NUMUSERS,
     "version":                   "VERSION",
     "numberOfOrders":            NUMORDERS,
     "totalEffectiveBalance":  EFFECTIVEBALANCE
     "time":                      TIME,
     "availableProcessors":       NUMPROCESSORS,
     "numberOfAssets":            NUMASSETS,
     "cumulativeDifficulty":      "CUMEDIFF"
     "numberOfAccounts":          NUMACCOUNTS
}

Где:

LASTBLOCKID идентификатор (ID) последнего полученного блока
NUMALIASES количество известных алиасов в сети
FEEDERPEER опубликованное имя узла фидера в последнем блоке
HEIGHT высота блока
NUMPEERS количество узлов в сети
CURMEMORY общий объем памяти используемой узлом (в Байтах)
FREEMEMORY общий объем свободной памяти на узле (в Байтах)
MAXMEMORY максимальный объем памяти, доступной для использования на узле (в Байтах)
NUMTRANS число транзакций в blockchain
NUMUSERS число разблокированных аккаунтов на этом узле
NUMPOLLS количество опросов на этом узле
NUMTRADES количество сделок на этом узле
NUMVOTES количество голосов (для опросов) на этом узле
NUMORDERS количество ордеров на узле
EFFECTIVEBALANCE эффективный баланс, актуальный для сети, указанный в LibreMoney-узлах
NUMPROCESSORS количество процессоров на данном узле
NUMASSETS число счетов на узле
CUMEDIFF текущий, накопительный уровень сложности форжинга
NUMACCOUNTS количество аккаунтов в blockchain

Пример

Запрос:

http://localhost:1400/api?
     requestType=getState

Ответ:

{
     "numberOfPeers":868,
     "numberOfPolls":0,
     "numberOfVotes":0,
     "availableProcessors":4,
     "totalEffectiveBalance":991634266,
     "numberOfAccounts":33172,
     "numberOfUnlockedAccounts":0,
     "numberOfBlocks":126493,
     "numberOfOrders":0,
     "numberOfTransactions":182379,
     "version":"1.0.0",
     "maxMemory":477626368,
     "lastBlock":"4329081735143326181",
     "totalMemory":466092032,
     "numberOfAliases":85657,
     "cumulativeDifficulty":"3936422822105943",
     "numberOfTrades":0,
     "time":13671770,
     "numberOfAssets":0,
     "lastBlockchainFeeder":"cubie-solar.mjke.de",
     "freeMemory":135007384
}

Проверено 15/05/14

Get Time

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

Запрос

http://localhost:1400/api?
     requestType=getTime

Ответ

{
     "time":       TIME
}

Где:

TIME количество секунд прошедших с момента генерации генезисного блока.

Пример

Запрос:

http://localhost:1400/api?
     requestType=getTime

Ответ:

{
     "time":       417
}

Проверено 21/06/14

Get Blockchain Status

Получить текущий статус blockchain

Запрос

http://localhost:1400/api?
     requestType=getBlockchainStatus

Ответ

{
    "lastBlock": "LASTBLK",
    "lastBlockchainFeederHeight": LASTHEIGHT,
    "time": TIME,
    "lastBlockchainFeeder": "FEEDERPEER",
    "numberOfBlocks": NUMBLKS,
    "isScanning": SCAN,
    "cumulativeDifficulty": "CUMDIF",
    "version": "VER"
}

Where:

LASTBLK последний блок в blockchain
LASTHEIGHT высота последнего блока
TIME число секунд начиная с момента генерации генезисного блока.
FEEDERPEER опубликованное имя хоста фидера последнего блока
NUMBLKS общее количество блоков
SCAN возвращает статус blockchain - происходит сейчас сканирование или нет.
CUMDIF текущая сложность форжинга
VER версия LibreMoneyNode который сейчас выполняется

Пример

Запрос:

http://localhost:1400/api?
     requestType=getBlockchainStatus

Ответ:

{
    "lastBlock": "3153685344875873318",
    "lastBlockchainFeederHeight": 95337,
    "time": 14604616,
    "lastBlockchainFeeder": "192.241.223.132",
    "numberOfBlocks": 95339,
    "isScanning": false,
    "cumulativeDifficulty": "2406110597084752",
    "version": "1.1.0"
}

Проверено 18/05/14

Операции с клеймами (hallmarks)

Decode Hallmark

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

Запрос

http://localhost:1400/api?
     requestType=decodeHallmark&
     hallmark=HEXSTRING

Где:

HEXSTRING — значение клейма

Ответ

{
     "valid":        VALID,
     "weight":       WEIGHT,
     "host":         "HOSTIP",
     "account":      "ACCOUNT",
     "accountRS":    "ACCOUNTRS",
     "date":         "DATE"
}

Где:

VALID — либо true (истина), либо false (ложь)
WEIGHT — вес, присвоенный клейму
HOSTIP — IP-адрес или имя домена, ассоциированные с клеймом
ACCOUNT — номер аккаунта, ассоциированный с клеймом
ACCOUNT номер аккаунта ассоциированный с заданным клеймом
ACCOUNTRS адрес аккаунта в кодировке Reed-Solomon
DATE — дата создания клейма, в формате yyyy-mm-dd

Пример

Запрос:

http://127.0.0.1:1400/api?
     requestType=decodeHallmark&
     hallmark=d67f03a47cd91fc...8b9e30f371a9fcc8f

Ответ:

{
     "valid":      true,
     "weight":     1000,
     "host":       "162.23.47.189",
     "account":    "LMA-5EGB-HKFP-NQUT-DKYFH",
     "accountRS":  "ACCOUNTRS",
     "date":       "2013-12-09"
}

Проверено 15/05/14

Generate Hallmark

Генерирует клеймо узла.

Запрос

http://localhost:1400/api?
     requestType=markHost&
     secretPhrase=MY_SECRET&
     host=MY_HOST&
     weight=WEIGHT&
     date=CURRENT_DATE

Где:

MY_SECRET — секретная фраза аккаунта, для которого на ноде создается клеймо. Должна быть URL-encoded.
MY_HOST — имя хоста для узла, которую вы хотите "заклеймить"
WEIGHT — вес, который вы хотели бы назначить ноде. Если на одном и том же аккаунте "заклеймены" более, чем одна нода, этот вес будет определен как (этот_вес/сумма_всех_весов)
CURRENT_DATE — сегодняшняя дата, в формате yyyy-mm-dd

Ответ

{
     "hallmark":       "HEXSTRING"
}

Где:

HEXSTRING — строка с закодированным клеймом (1856 байт)

Пример

Запрос:

http://localhost:1400/api?
     requestType=markHost&
     secretPhrase=MySuperSecretPasswordThatIsNotEasy&
     host=node23.nodesrus.com&
     weight=100&
     date=2014-01-01

Ответ:

{
     "hallmark":       "d67f03a47cd91fc1...fd49f66b462daa1f14ae8"
}

Проверено 18/05/14

Операции с токенами

Decode Token

Декодирует токен авторизации. Используется для авторизации аккаунта на указанном веб-сайте, без необходимости передачи секретной фразы.

Запрос

http://localhost:1400/api?
     requestType=decodeToken&
     website=WEBSITE&
     token=AUTHSTRING

Где:

WEBSITE — URL веб-сайта, где необходима авторизация по токену. По принятому соглашению не содержит часть "http://" URL'а.
AUTHSTRING — закодированная строка авторизации

Ответ

{
     "account":       "ACCOUNT", 
     "timestamp":     TIME, 
     "valid":         BOOLEAN
}

Где:

ACCOUNT — номер аккаунта LibreMoney, ассоциированный с токеном
TIME — время в секундах начиная с о времени создания блока генезиса, определяющее время создания токена
BOOLEAN — либо "true" (истина), либо "false" (ложь), показывает валиден ли токен

Пример

Запрос:

http://localhost:1400/api?
     requestType=decodeToken&
     website=www.domain.com&
     token=StringOf160Chars

Ответ:

{
     "account":       "398532577100249608", 
     "timestamp":     622, 
     "valid":         true 
}

Проверено 18/05/14

Generate Token

Создаёт токен (ключ) авторизации. Используется для авторизации аккаунта на определенном веб-сайте без необходимости передачи секретной фразы.

Запрос

http://localhost:1400/api?
     requestType=generateToken&
     secretPhrase=SECRET&
     website=WEBSITE

Где:

SECRET - ключевая фраза (private key) аккаунта, который создаёт токен.
WEBSITE - URL веб-сайта, на котором проходит авторизация. По соглашению не содержит часть "http://" URL'а.

Ответ

 
{ 
  "token": StringOf160Chars 
}

Пример

Запрос:

http://localhost:1400/api?
     requestType=generateToken&
     secretPhrase=ItWasABrightColdDayInAprilAndTheClocksWereStrikingThirteen&
     website=www.genesisblock.com

Ответ:

{
     "token":       "7dstcbs4fnbq614faea405ga3dj...etb0n9f0k6uvlku4d751kftqlb128t4"
}

Проверено 18/05/14

Операции с транзакциями

Broadcast Transaction

Широковещательная передачи транзакции в сеть

Запрос

http://localhost:1400/api?
     requestType=broadcastTransaction&
     transactionBytes=TX_BYTECODE

Где:

TX_BYTECODE - байткод транзакции

Ответ

{
     "transaction":       "TRANSACTION_ID"
}

Пример

Запрос:

http://localhost:1400/api?
     requestType=broadcastTransaction&
     transactionBytes= 000022e22800e8036653833f4272604d...

Ответ:

{
     "transaction":       "17484500871708980634"
}

Внимание: Вы можете получить ошибку '"error": "Double spending transaction"' если транзакция уже была транслирована в сеть

Проверено 18/05/14

Calculate Full Hash

Вычислить полный хэш транзакции

Запрос

http://localhost:1400/api?
     requestType=calculateFullHash&
     unsignedTransactionBytes=UNTXBYTES&
     signatureHash=SIGHASH

Где:

UNTXBYTES неподписанные байты, содержавшиеся в транзакции
SIGHASH sha256 хэш подписи транзакции. Применяется для операций условного депонирования

Ответ

{
     "fullHash": "FULLHASH" 
}

Пример

Запрос:

http://localhost:1400/api?
     requestType=calculateFullHash&
     unsignedTransactionBytes=01016e23d700a005668683e673274c67...&
     signatureHash=07afbcfb72b4fa91d8e22f8f47950404270edc1d250d2c6edad7a58679fbe1cf

Ответ:

{ 
     "fullHash": "cc98e57a065610d17c6ba6a6406e4930b9a740bf1737847ab2e96e3733233984" 
}

Проверено 15/05/14

Get Account Transaction IDs

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

Запрос

http://localhost:1400/api?
     requestType=getAccountTransactionIds&
     account=ACCOUNT&
     timestamp=TIME

Где:

ACCOUNT - номер аккаунта по которому вы запрашиваете информацию
TIME - время в секундах, с момента генерации генезисного блока

Ответ

{
     "transactionIds":
          [ARRAY_OF_IDs]
}

Где:

ARRAY_OF_IDs - список (массив) идентификаторов транзакций, связанных с указанным аккаунтом

Пример

Запрос:

http://localhost:1400/api?
     requestType=getAccountTransactionIds&
     account=6331110009135084386&
     timestamp=0

Ответ:

{
     "transactionIds":
          [
               "17484500871708980634"
          ]
}

Get Unconfirmed Account Transaction IDs

Получить список идентификаторов неподтвержденных транзакций связанных с заданным LibreMoney аккаунтом

Запрос

http://localhost:1400/api?
     requestType=getUnconfirmedTransactionIds&
     account=ACCOUNT

Где:

ACCOUNT номер аккаунта, список идентификаторов неподтвержденных транзакций которого, вы хотите получить

Ответ

{
     "unconfirmedTransactionIds":
          [ARRAY_OF_IDs]
}

Где:

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

Пример

Запрос:

http://localhost:1400/api?
     requestType=getUnconfirmedTransactionIds&
     account=6331110009135084386

Ответ:

{
     "unconfirmedTransactionIds":
          [
               "17484500871708980634"
          ]
}

Проверено 18/05/14

Get Transaction

Возвращает данные заданной транзакции. Может задаваться любым параметром: ID транзакции, hash, или fullhash транзакции.

Запрос

http://localhost:1400/api?
     requestType=getTransaction&
     transaction=TRANSID&
     hash=HASH&
     fullHash=FULLHASH

Где:

TRANSID ID транзакции LibreMoney
HASH hash транзакции
FULLHASH fullhash транзакции

Ответ

{
     "sender":          "SENDERACCOUNT",
     "senderRS":        "SENDERACCOUNTRS",
     "fee":          "FEE",
     "amount":       "AMOUNT",
     "timestamp":       TIME,
     "referencedTransaction":       REFTX,
     "confirmations":   CONFIRMS,
     "subtype":         SUBTYPE,
     "block":           "BLOCKID",
     "senderPublicKey": "PUBKEY",
     "type":            TYPE,
     "deadline":        DEADLINE,
     "signature":       "SIGNATURE",
     "recipient":       "RECIPACCOUNT",
     "recipientRS":     "RECIPACCOUNTRS",
     "fullHash":        "FULLHASH", 
     "signatureHash":   "SIGHASH", 
     "hash":            "HASH", 
     "transaction":     "TRANSID", 
     "attachment":
     {
          ATTACHMENT
     }
}

Где:

SENDERACCOUNT номер аккаунта отправителя
SENDERACCOUNTRS адрес отправителя в кодировке Reed-Solomon
FEE комиссия (в MilliLm) за данную транзакцию
AMOUNT количество MilliLm в данной транзакции
TIME время транзакции, измеряется в количестве секунд от времени создания генезисного блока
REFTX Идентификатор (ID)предыдущей транзакции на которую ссылается данная транзакция. Должно быть "0" iесли отсутствует транзакция на которую ссылается данная.
CONFIRMS количество подтверждений транзакции
TYPE тип транзакции:
- 0 обыкновенная транзакция
- 1 альяс или произвольное сообщение в составе транзакции
- 2 если это транзакция биржи активов
SUBTYPE субтип транзакции:
- Для альясов/произвольных сообщений:
  - 0 транзакция произвольного сообщения
  - 1 транзакция альяса
- Для биржи активов:
  - 0 выпуск актива
  - 1 трансфер актива
  - 2 запрос на размещение заказа на покупку
  - 3 запрос на размещение заказа на продажу
  - 4 отмена ордера на покупку
  - 5 отмена ордера на продажу
BLOCKID ID идентификатор блока содержащий данную транзакцию
ATTACHMENT суб-бъект, представляющий любые дополнительные данные, необходимые для транзакции. Будет присутствовать только если применимо к транзакции.
PUBKEY публичный ключ отправляющего аккаунта для транзакции
DEADLINE дедлайн транзакции, указывается в минутах
SIGNATURE цифровая подпись транзакции transaction
SIGHASH хэш sha256 подписи транзакции. Используется для условного операций депонирования.
RECIPACCOUNT номер аккаунта получателя
RECIPACCOUNTRS адрес получателя в кодировке Reed-Solomon

Внимание: Данные о неподтвержденной транзакции не содержат параметров "block" и/или "confirmations". Данные double-spending транзакций не возвращаются.

Пример

Запрос:

http://localhost:1400/api?
     requestType=getTransaction&
     transaction=16244659048134841060

Ответ:

{
     "sender":       "14336428216306750617",
     "senderRS":     "LMA-6DWM-GFYD-A7PS-72P3P",
     "fee":       "100000000",
     "amount":       "0",
     "timestamp":       7376798,
     "referencedTransaction":       "0",
     "confirmations":       6,
     "subtype":       1,
     "block":       "16385359704305994802",
     "blockTimestamp":       7376860,
     "attachment":
     {
          "alias":"LmApi",
          "uri":"http:\/\/libremoney.org/"
     },
     "senderPublicKey":       "64f103fbf0cc41045b1544cda6624eecfb8212b021fba22029a461c4b40c5d79",
     "type":       1,
     "deadline":       1,
     "signature":       "0cdf64cb06ea21396180a6f201b6a...",
     "recipient":       "1739068987193023818",
     "recipientRS":     "LMA-BK2J-ZMY4-93UY-8EM9V",
     "fullHash": "a3c47c4a2e60c2907efc9c4b9310066cabdf3e2137e67814aa57cb960ad2dfe1", 
     "signatureHash": "95cc276d1608dc0c14942a5efc82ccc701a56e873746ef1bfd37995c37ef5991", 
     "hash": "15a86f71e1ac267dce35791cefafb71460f458920784ea0d10894844f05894b0", 
     "transaction": "10431005438877942947"
}

Проверено 15/05/14

Parse Transaction

Получает данные транзакции

Запрос

http://localhost:1400/api?
     requestType=parseTransaction&
     transactionBytes=TRANSBYTES

Где:

TRANSBYTES байты LibreMoney транзакции

Ответ

{
     "sender":          "SENDERACCOUNT",
     "senderRS":        "SENDERACCOUNTRS",
     "fee":          "FEE",
     "amount":       "AMOUNT",
     "timestamp":       TIME,
     "referencedTransaction":       REFTX,
     "confirmations":   CONFIRMS,
     "subtype":         SUBTYPE,
     "block":           "BLOCKID",
     "senderPublicKey": "PUBKEY",
     "type":            TYPE,
     "deadline":        DEADLINE,
     "signature":       "SIGNATURE",
     "recipient":       "RECIPACCOUNT",
     "recipientRS":     "RECIPACCOUNTRS",
     "fullHash":        "FULLHASH", 
     "signatureHash":   "SIGHASH", 
     "hash":            "HASH", 
     "transaction":     "TRANSID", 
     "attachment":
     {
          ATTACHMENT
     }
}

Где:

SENDERACCOUNT номер аккаунта отправителя
SENDERACCOUNTRS адрес отправителя в кодировке Reed-Solomon
FEE комиссия (в MilliLm) за данную транзакцию
AMOUNT количество MilliLm в данной транзакции
TIME время транзакции, измеряется в количестве секунд от времени создания генезисного блока
REFTX Идентификатор (ID)предыдущей транзакции на которую ссылается данная транзакция. Должно быть "0" iесли отсутствует транзакция на которую ссылается данная.
CONFIRMS количество подтверждений транзакции
TYPE тип транзакции:
- 0 обыкновенная транзакция
- 1 альяс или произвольное сообщение в составе транзакции
- 2 если это транзакция биржи активов
SUBTYPE субтип транзакции:
- Для альясов/произвольных сообщений:
  - 0 транзакция произвольного сообщения
  - 1 транзакция альяса
- Для биржи активов:
  - 0 выпуск актива
  - 1 трансфер актива
  - 2 запрос на размещение заказа на покупку
  - 3 запрос на размещение заказа на продажу
  - 4 отмена ордера на покупку
  - 5 отмена ордера на продажу
BLOCKID ID идентификатор блока содержащий данную транзакцию
ATTACHMENT суб-бъект, представляющий любые дополнительные данные, необходимые для транзакции. Будет присутствовать только если применимо к транзакции.
PUBKEY публичный ключ отправляющего аккаунта для транзакции
DEADLINE дедлайн транзакции, указывается в минутах
SIGNATURE цифровая подпись транзакции transaction
SIGHASH хэш sha256 подписи транзакции. Используется для условного операций депонирования.
RECIPACCOUNT номер аккаунта получателя
RECIPACCOUNTRS адрес получателя в кодировке Reed-Solomon

Внимание: Данные о неподтвержденной транзакции не содержат параметров "block" и/или "confirmations". Данные double-spending транзакций не возвращаются.

Пример

Запрос:

http://localhost:1400/api?
     requestType=parseTransaction&
     transactionBytes=000022e22800e8036653833f4272604d5d3ef39...

Ответ:

{
     "sender":       "14336428216306750617",
     "senderRS":     "LMA-6DWM-GFYD-A7PS-72P3P",
     "fee":       "100000000",
     "amount":       "0",
     "timestamp":       7376798,
     "referencedTransaction":       "0",
     "confirmations":       6,
     "subtype":       1,
     "block":       "16385359704305994802",
     "blockTimestamp":       7376860,
     "senderPublicKey":       "64f103fbf0cc41045b1544cda6624eecfb8212b021fba22029a461c4b40c5d79",
     "type":       1,
     "deadline":       1,
     "signature":       "0cdf64cb06ea21396180a6f201b6a...",
     "recipient":       "1739068987193023818",
     "recipientRS":     "LMA-BK2J-ZMY4-93UY-8EM9V",
     "fullHash": "a3c47c4a2e60c2907efc9c4b9310066cabdf3e2137e67814aa57cb960ad2dfe1", 
     "signatureHash": "95cc276d1608dc0c14942a5efc82ccc701a56e873746ef1bfd37995c37ef5991", 
     "hash": "15a86f71e1ac267dce35791cefafb71460f458920784ea0d10894844f05894b0", 
     "transaction": "10431005438877942947"
}

Проверено 15/05/14

Get Transaction Bytes

Возвращает байт-код транзакции.

Запрос

http://localhost:1400/api?
     requestType=getTransactionBytes&
     transaction=TXID

Где:

TXID - идентификатор транзакции (ID)

Ответ

{
     "confirmations":            CONFS,
     "transactionBytes":         "BYTECODE",
     "unsignedTransactionBytes": "UNBYTECODE"
}

Где:

CONFS количество подтверждений транзакции
BYTECODE запрашиваемый байт-код транзакции
BYTECODE неподписанные байты, включенные в транзакцию

Пример

Запрос:

http://localhost:1400/api?
     requestType=getTransactionBytes&
     transaction=17484500871708980634

Ответ:

{
     "confirmations":       4462,
     "transactionBytes":         "000022e22800e8036653833f4272604d5...",
     "unsignedTransactionBytes": "000022e22800e8036653833f42..." 
}

Проверено 18/05/14

Send Lm

Переслать указанное количество MilliLm на указанный аккаунт.

Запрос

http://localhost:1400/api?
     requestType=sendMoney&
     secretPhrase=SECRET&
     recipient=RECIPACCOUNT& 
     amount=AMOUNT& 
     fee=FEE& 
     deadline=DEADLINE& 
     referencedTransaction=REFTRANSACTION&
     publicKey=PUBKEY

Где:

SECRET - секретная фраза/пароль для аккаунта с которого будут отправлены средства
RECIPACCOUNT - аккаунт получателя
AMOUNT - Количество MilliLm передаваемых в данной транзакции
FEE - комиссия (в MilliLm) для этой транзакции
DEADLINE - deadline для транзакции, в минутах
REFTRANSACTION - опционально: ссылка на идентификатор (ID) предыдущей транзакции (основная транзакция не подтвердится, пока не подтвердилась предыдущая)
PUBKEY 64-битный публичный ключ ассоциированный с аккаунтом и дополняет поле SECRET.

Ответ

{ 
     "transaction":        "TRANSACTIONID" 
}

Где:

TRANSACTIONID - идентификатор только что созданной транзакции.

'Внимание! "deadline" указывается в минутах. "referencedTransaction" не обязательный параметр, может не использоваться.

Пример

Запрос:

http://localhost:1400/api?
     requestType=sendMoney&
     secretPhrase=IWontTellYou&
     recipient=398532577100249608&
     amount=1500&
     fee=5&
     deadline=900&
     referencedTransaction=13689168149259791567

Результат:

{ 
     "transaction":        "16244659048134841060" 
}

Проверено 18/05/14

Sign Transation

Рассчитать полный хэш (full hash), хэш подписи (signature hash), и транзакцию из неподписанной транзакции

Request

http://localhost:1400/api?
     requestType=signTransaction&
     unsignedTransactionBytes=UNTXBYTES&
     secretPhrase=SECRET

Где:

UNTXBYTES неподписанные байты в транзакции
SECRET секретная фраза аккаунта

Ответ

{
     "fullHash":                 "FULLHASH", 
     "signatureHash":            "SIGHASH", 
     "transactionBytes":         "TXBYTES", 
     "transaction":              "TX", 
     "verify":                   "VERIFY"
}

Где:

FULLHASH полный хэш транзакции
SIGHASH sha256 хэш подписи транзакции. Используется для транзакций условного депонирования
TXBYTES байткод транзакции
TX ID транзакции
VERIFY если верифицировано (true/false)

Пример

Запрос:

http://localhost:1400/api?
     requestType=signTransaction&
     unsignedTransactionBytes=01016e23d700a005668683e673274c67...&
     secretPhrase=0123456789

Ответ:

{ 
     "fullHash":         "d56ade2c322083d76ebcdb9f9ef18d7d52c6d105f67be040cc423c7a41a47aea", 
     "signatureHash":    "458514e72f4272c789f99201c27cff611460de10fe484b474166c1199c23e754", 
     "transactionBytes": "0100471ddb00a005668683e673274c67180240...", 
     "transaction":      "15529291339976829653", 
     "verify":           true 
}

Проверено 15/05/14

""Коды ошибок""

Код ошибки: 1 - Incorrect request. Неверный запрос. Скорее всего вы допустили ошибку при написании/копировании запроса.

Внимательно смотрите запрос к серверу http://localhost:1400/api?requestType=здесь_должна_быть_введена_корректная_функция системы&...

Код ошибки: 2 - Blockchain not up to date. Blockchain не обновлен, т.е. находится в неактуальном состоянии.

Код ошибки: 3 - Parameter not specified. Параметр не определен. Скорее всего вы указали в запросе параметр, которого не должно быть (лишний, некорректный)

Код ошибки: 4 - Incorrect parameter. Некорректный параметр. Т.е. вы ввели неправильные данные, например вместо числа - цифру. Будьте внимательны при вводе данных!

Код ошибки: 5 - Unknown object (block, transaction, etc.) Неизвестный объект (блок, транзакция...). В случае если это аккаунт, это может говорить также и о том, что данный аккаунт не активен (т.е. с ним не производилось никаких операций по перемещению средств)

Код ошибки: 6 - Not enough funds. Недостаточно средств. Скорее всего вы указали в операции больше средств чем у вас есть, или что-то не учли (например комиссию)