Главная Вход

ZHCash API Documentation
getnewaddress

Запросить новый адрес кошелька и его приватный ключ

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

Мы не сможем никогда восстановить ваши приватные ключи!

Параметры запроса:

Параметр Значение
Тип GET

Передаваемые значения:

Параметр Тип Значение
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Параметр Тип Значение
status string Статус
address string Адрес кошелька
priv_key string Приватный ключ

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X GET https://apibox.online/api/zhc/getnewaddress -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c'

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

 {
 "status": "ok",
 "address": "Zar3tCaQTnnWjkn93dyS9BCsX8tG5r2yG7",
 "priv_key": "KysYzfrDwMrgnYgbErAwCwmTFTL5VAKjo3GWFZTX1cCeGh1xKfyN"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "API Token error!"
 }

privtomnemonic

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

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
priv_key string Приватный ключ
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
address string Адрес кошелька
mnemonic string Мнемоническая фраза

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/privtomnemonic -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "priv_key=KysYzfrDwMrgnYgbErAwCwmTFTL5VAKjo3GWFZTX1cCeGh1xKfyN"

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

 {
 "status": "ok",
 "address": "Zar3tCaQTnnWjkn93dyS9BCsX8tG5r2yG7",
 "mnemonic": "branch natural tree king demand yearn disguise something leaf peace mumble spring expect deadly nail surely usually afraid dawn strip happen acid kingdom quick"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Invalid private key!"
 }

mnemonictopriv

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

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
mnemonic string Мнемоническая фраза
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
address string Адрес кошелька
priv_key string Приватный ключ

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/mnemonictopriv -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "mnemonic=branch natural tree king demand yearn disguise something leaf peace mumble spring expect deadly nail surely usually afraid dawn strip happen acid kingdom quick"

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

 {
 "status": "ok",
 "address": "Zar3tCaQTnnWjkn93dyS9BCsX8tG5r2yG7",
 "priv_key": "KysYzfrDwMrgnYgbErAwCwmTFTL5VAKjo3GWFZTX1cCeGh1xKfyN"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Invalid mnemonic!"
 }

getaddressbalance

Запросить баланс адреса

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
address string Адрес кошелька
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
balance fload Баланс кошелька
tokens_zrc20 array Массив токенов ZRC20
transactions integer Количество транзакций

Массив tokens_zrc20:

Параметр Тип Значение
contract string ID контракта
description string Описание токена
symbol string Символ
decimal integer Размерность
balance float Баланс

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/getaddressbalance -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "address=ZDYHuu6JnJjmaSFjaVMAsosXfCxjSYcTzB"

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

 {
 "status": "ok",
 "balance": 74.24672,
 "tokens_zrc20":
  [
   {
    "contract": "fccf9197203c2e86b63027e0366be67825e4a60e",
    "description": "ZH Mobile Test Token",
    "symbol": "ZMTT",
    "decimal": 8,
    "balance": 10.0
   }
  ],
 "transactions": 56
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Reached requests limit for API Token!"
 }

getaddresstxs

Запросить список транзакций адреса

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
address string Адрес кошелька
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
txs array Массив транзакций

Массив txs:

Параметр Тип Значение
- string ID транзакции

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/getaddresstxs -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "address=ZDYHuu6JnJjmaSFjaVMAsosXfCxjSYcTzB"

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

 {
 "status": "ok",
 "txs":
  [
   "ddedc9601604807b0f256889b2e6d3f3f14460c84f6b62768d4427cf8f44e33b",
   "51cea94289360f83402f0901ab82aa96ce10ccf95f39287bbe6f64c18db5a019",
   "fd017dc528e726b7cc090d7bb9505efe6e77c07ac24f073cda84bfdd7b5bd316"
  ]
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Invalid address!"
 }

gettransaction

Запросить транзакцию по TX ID

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
tx_id string ID транзакции
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
hash string Хеш транзакции
block_height integer Номер блока
block_hash string Хеш блока
inputs array Массив источников
outputs array Массив назначений
is_stake boolean Стейк?
timestamp timestamp Время
confirmations integer Подтверждений
fees string Комисии
timestamp integer Timestamp

Массив inputs:

Параметр Тип Значение
prev_tx string ID транзакции
output_index integer Индекс выхода
address string Адрес источника
value string Сумма

Массив outputs:

Параметр Тип Значение
address string Адрес назначения
value string Сумма

Примечание:

value - значение указано в Satoshi (Zeroshi)

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/gettransaction -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "tx_id=fb964ec92cc270820d2035ebde70783b95de1c91961f34e1599075e78ae85ebb"

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

 {
 "status": "ok",
 "hash": "fb964ec92cc270820d2035ebde70783b95de1c91961f34e1599075e78ae85ebb",
 "block_height": 768238,
 "block_hash": "c8f44293cfe8690f0be85edfbcd324eb5afe2d10900faf5793d4688e08362773",
 "timestamp": 1673804992,
 "inputs":
  [
   {
    "prev_tx": "25dc3abab01da5c543b72eadfba6c2eb1603465673e149874eb1e939966353ed",
    "output_index": 0,
    "address": "ZJty7dGbH5qCaQR2Xx3ija6PSAd2Fpy8Y4",
    "value": "23629031937807"
   },
   {
    "prev_tx": "736e2122e08f250a34e183bb4d8a8ca304927272cdf15b0e1472e6cff372899d",
    "output_index": 1,
    "address": "ZHHN8UX64JvDcw29w3Xsq1ezAk5xXPGZ6Q",
    "value": "26732563234"
   }
  ],
 "outputs":
  [
   {
    "address": "ZGtzXYhBYfg1hQw3ksU45qjMpAtqCncnCA",
    "value": "21676537574353"
   },
   {
    "address": "ZGiM7TYgjDicZd9XtXtquJmd4p4Ww3MSGp",
    "value": "1952494273421"
   }
  ],
 "is_stake": false,
 "confirmations": 3016,
 "fees": "90033"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Reached second requests limit for API Token!"
 }

getaddressutxo

Запросить список UTXO транзакций адреса

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
address string Адрес кошелька
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
utxos array Массив транзакций

Массив utxo:

Параметр Тип Значение
tx_id string ID транзакции
output_index integer Индекс выхода
address string Адрес кошелька
value string Сумма
is_stake boolean Стейк?
block_height integer Номер блока
confirmations integer Подтверждения

Примечание:

value - значение указано в Satoshi (Zeroshi)

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/getaddressutxo -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "address=ZDYHuu6JnJjmaSFjaVMAsosXfCxjSYcTzB"

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

 {
 "status": "ok",
 "utxo":
  [
   {
    "tx_id": "25dc3abab01da5c543b72eadfba6c2eb1603465673e149874eb1e939966353ed",
    "output_index": 1,
    "address": "ZJty7dGbH5qCaQR2Xx3ija6PSAd2Fpy8Y4",
    "value": "23629031937807",
    "is_stake": false,
    "block_height": 394484,
    "confirmations": 376777
   }
  ],
  [
   {
    "tx_id": "c841fb0dca3b66b5d3ca5bfe84e479a04cc0ce3a069abf72c29005e60c8bc8ab",
    "output_index": 0,
    "address": "ZEtgfkao4yhARr7isRFq79Xeyn4N4F8i2W",
    "value": "32258014516",
    "is_stake": false,
    "block_height": 396488,
    "confirmations": 374773
   }
  ]
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "TX not found!"
 }

sendtoaddress

Создать транзакцию

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
from_address string Адрес отправителя
to_address string Адрес получателя
amount float Сумма
priv_key string Приватный ключ
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
tx_id string ID транзакции

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/sendtoaddress -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "from_address=ZJpXeKNsaopNMuaanYs5NR8UAVR2t6fEhy&to_address=ZDYHuu6JnJjmaSFjaVMAsosXfCxjSYcTzB&amount=18.3426&priv_key=L2wSJnm2xnQx9rCdwnk551YuF5w7dAijiFEQYMRhPG5AZAzQEWkK"

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

 {
 "status": "ok",
 "tx_id": "25dc3abab01da5c543b72eadfba6c2eb1603465673e149874eb1e939966353ed"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Insufficient address balance!"
 }

checkvalidaddress

Проверить валидность адреса

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
address string Адрес
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
valid boolean true/false

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/checkvalidaddress -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "address=ZDYHuu6JnJjmaSFjaVMAsosXfCxjSYcTzB"

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

 {
 "status": "ok",
 "valid": true
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Reached requests limit for API Token!"
 }

addresstohex

Получить HEX из адреса

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
address string Адрес
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
hex string HEX адреса

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/addresstohex -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "address=ZJpXeKNsaopNMuaanYs5NR8UAVR2t6fEhy"

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

 {
 "status": "ok",
 "hex": "4a60b918ed8aab2af6551ae8d86f371407f5e4df"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Invalid address!"
 }

hextoaddress

Получить адрес из HEX

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
hex string HEX
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
address string Адрес

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/hextoaddress -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "hex=4a60b918ed8aab2af6551ae8d86f371407f5e4df"

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

 {
 "status": "ok",
 "address": "ZJpXeKNsaopNMuaanYs5NR8UAVR2t6fEhy"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Invalid HEX!"
 }

sendrawtx

Отправить RAW транзакцию

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
raw_tx string RAW транзакция
X-API-Token string API токен

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
tx_id string ID транзакции

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/sendrawtx -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "raw_tx=0200000002f8b6f99609f38e32a2a2ff1b22a46c10e2b3db4041c .. fdb1fa835ecd927cb6227d9dcacdb6c3c58e88ac6dd30b00"

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

 {
 "status": "ok",
 "tx_id": "67577361b31e606a9572d5b815e7cc4dbe96d792971e520fe8eb156caa7cef77"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Invalid raw transaction!"
 }

sendtoken

Создать транзакцию токена (ZRC20 или ZRC721)

Важно!
Для отправки ZRC20 токенов в параметре amount_or_id указывается сумма перевода токенов.
Для отправки ZRC721 в параметре amount_or_id указывается ID токена (NFT ID).

Параметры запроса:

Параметр Значение
Тип POST

Передаваемые значения:

Параметр Тип Значение
contract string ID контракта
from_address string Адрес отправителя
to_address string Адрес получателя
amount_or_id float Сумма или ID токена
priv_key string Приватный ключ
X-API-Token string API токен
gaz integer Количество газа (в Сатоши), например 1 ZHC = 100000000 Сатоши

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

Параметр Значение
Формат ответа JSON

Возвращаемые значения:

Ключ Тип Значение
status string Статус
tx_id string ID транзакции

Статусы ответа:

ok - ответ не содержит ошибок,

error - ошибка, описание ошибки смотрите в параметре ответа reason.

Пример запроса:

# curl -X POST https://apibox.online/api/zhc/sendtoken -H 'X-API-Token: e625bfa59a0a9831433f03c7f42a562c' --data "contract=ca1733809ad1aa456349ba2977d9c9694e50c69d&from_address=ZKHyJWSbNwzqEyrXyK2G2Qfmrq7annKZbq&to_address=ZJUmf1YFwbiDmq15r4y3ym54RQ3x269nFP&amount_or_id=5.3372&priv_key=L2wSJnm2xnQx9rCdwnk551YuF5w7dAijiFEQYMRhPG5AZAzQEWkK"

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

 {
 "status": "ok",
 "tx_id": "a27fe0ad1f86c2a61c944745f55652e3724404d8493606f798b2eaaf00840dab"
 }

Пример ошибки:

 {
 "status": "error",
 "reason": "Insufficient address balance!"
 }

APIBOX.online - 2022