w Bitcoin Blockchain RESTfull API.


Биткоин RESTful API

Если вам необходимы API функции, которых у нас нет, свяжитесь с нами.
Электронная почта: support@bitaps.com или Skype:
Bitaps support

Введение

Bitaps Биткоин REST API использует HTTP методы и архитектуру RESTful для передачи состояния приложения. Для передачи запросов необходимо отправлять данные в JSON формате и API возвращает результат в таком же формате. Весь обмен данными происходит только через безопасный протокол HTTPS.

 

Что бы вызвать REST запрос, комбинируйте:

Адрес для обращения к REST API: https://bitaps.com

Ошибки

Bitaps использует стандартные коды HTTP, когда возвращает статус об ошибке. Дополнительно мы можем предоставлять подробности об ошибке, прямо в ответе сервера в следующем формате:

{
  "error_code": {код ошибки},
  "message": "{описание ошибки}",
  "details": "{дополнительная информация, если доступна}"
}

Список кодов состояния HTTP:

200 Запрос успешно выполнен
400 Неверный запрос
401 Запрос не авторизован
402 Ошибочный запрос
403 Запрещено
404 Ресурс не найден
50x Ошибка сервера

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

Выполнить

Условия использования

Для использования любых интерфейсов нашего сервиса, не требуется регистрация, чьё либо подтверждение или получение каких либо ключей.

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

Каждый клиент должен соблюдать и самостоятельно нести ответственность на местном, федеральном и общемировом уровне законодательства, не нарушать этические принципы и порядки. Мы полностью снимаем с себя ответственность за содержание и работу, подключённых к нам ресурсов, так как они нам не подконтрольны, а наши услуги в свободном доступе.

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

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

Подробнее с условиями работы сервиса, вы можете ознакомиться на странице Privacy policy (English version).

Комиссия

Комиссия взимается только в двух следующих видах интерфейсов:

Комиссия сервиса составляет 0.0002 BTC с каждой обработанной транзакции, не зависимо от объёма.

Комиссия не взимается с платежей менее 100000 Сатоши.

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

Все комиссии зачисляются на адрес 1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P

 

Все остальные интерфейсы полностью бесплатны.

Платежи

Чеки (Redeem code)

Создать чек на предъявителя

Чек (Redeem code) очень похож на обычный Биткоин кошелек. Вы можете получать на его сгенерированный Биткоин адрес, проверять баланс и отправлять не обходимую вам сумму.

Используйте Get запрос что бы создать Чек (Redeem Code):

GET https://bitaps.com/api/create/redeemcode[?confirmations=1-10]

Параметры:

[confirmations] число принятых подтверждений платежа в сети Биткоин (опциональное поле, по умолчанию - 3)

Период от 1 до 6.

Результат выполнения:

Результатом выполнения являются три значения: сгенерированный адрес для приёма оплаты, код платежа и счёт. Код платежа это личная информация для продавца, которая должна храниться в секрете. Счёт может быть отправлен покупателю и/или будет использован для платёжной формы.
Чек (Redeem code) используется для погашения баланса (пересылки денег) с этого чека на любой другой адрес.

Пример результата выполнения:

{
  "address": "1CZgyfDsA5Bob2wVyTbCxSGXwSAEur4LYB",
  "redeem_code": "BTCvNqa8knrVkGyYmrfMTRtU77xrnPWiiH8n8accdEm9W1EHsRbCz",
  "invoice": "invPvfHny5QnffugyKgwYvUeXjCUgz4ywhxzANDcTHa7amWLKbjnb"
}
Храните у себя все три параметра. А "redeem_code" в безопасном месте! Потому что этот код для контроля над средствами на счету.
Пожалуйста, не пополняйте чек суммами менее чем 5000 Сатоши, так как комиссия сети соизмерима с этой суммой и вам не удастся получить эти деньги.

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

Переменные Тип поля Меняйте значения и получайте результат
Confirmations

Желаемое число подтверждений сети. В пределах от 1 до 10, по умолчанию 3.

Опциональное
   
Выполнить

Получить информацию по чеку (redeem code)

Запрос:

POST https://bitaps.com/api/get/redeemcode/info

Параметры:

{redeemcode} Redeem Code

Результат выполнения: адрес получателя, текущий баланс, неподтверждённый баланс, оплаченная сумма.

Результат выполнения:

{
  "address": "{address}",
  "balance": {amount},
  "pending_balance": {amount},
  "paid_out": {amount}
}

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

Переменные Тип поля Меняйте значения и получайте результат
Redeem Code

Код чека (Redeem Code)

Обязательное
   
Выполнить

Выплата по чеку (Redeem code)

Оплатите желаемую сумму или переведите всю сумму без остатка (All available) с баланса чека.

В результате успешного выполнения сервер вернёт хэш транзакции.

Предупреждение! В случае таймаута запроса, следует вручную проверить статус транзакции. Если транзакция была успешной то биткоины уже были отправлены.

Используйте POST запрос, что бы отправить средства с чека (Redeem Code):

POST https://bitaps.com/api/use/redeemcode

Параметры:

{redeemcode} чек (Redeem Code)
{address} Биткоин адрес получателя
{amount} Укажите сумму в Сатоши или отправьте значение "All available" что бы отправить всю сумму без остатка.
{fee_level} "high", "medium", "low" уровень комиссии сети, опциональное поле, по умолчанию = "low"
{custom_fee} Можно установить собственную комиссию сети в Сатоши на байт. Если этот параметр присутствует, fee_level будет проигнорирован.

 

Результат выполнения:

{
  "tx_hash": "{transaction hash}",
}

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

Переменные Тип поля Меняйте значения и получайте результат
Redeem Code

Ваш код чека (Redeem Code)

Обязательное
Receiver address

Биткоин адрес получателя

Обязательное
Amount

Укажите сумму в Сатоши или отправьте всю сумму целиком без остатка "All available".

Обязательное
   
Выполнить

Массовые выплаты по чеку (Redeem code List)

С помощью редим кода, вы можете производить массовые выплаты по списку от 1 до 250 получателей. А так же, опционально, назначать данной транзакции сообщение с максимальной длиной 80 байт. Такое сообщение будет вечно храниться в подписи транзакции согласно протоколу Биткоин BIP 70 и BIP 74.

Лимиты интерфейса:

 

В результате успешного выполнения, сервер вернёт хэш транзакции.

Используйте POST запрос, что бы отправить средства с чека (Redeem code):

POST https://bitaps.com/api/use/redeemcode/list

Параметры:

{
  "redeemcode": {code},
  "data": {data},
  "fee_level": {fee_level},
  "payment_list":  [
    {"address": {addresss},
     "amount": {amount}},
    ... # up to 250 addresses
    ]
}

 

{redeemcode} чек (Redeem Code)
{address} Биткоин адрес получателя
{amount} Сумма в Сатоши
{data} Сообщение OP_Return, максимальная длина 80 байт, опциональное поле, по умолчанию пустое
{fee_level} "high", "medium", "low" уровень комиссии сети, опциональное поле, по умолчанию = "low"

 

Результат выполнения:

{
  "tx_hash": "{transaction hash}",
}

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

Переменные Тип поля Меняйте значения и получайте результат
Redeem Code

Ваш код чека (Redeem Code)

Обязательное
Receiver address 1

Биткоин адрес получателя

Обязательное
Amount 1

Укажите сумму в Сатоши

Обязательное
Receiver address 2

Биткоин адрес получателя

Опциональное
Amount 2

Укажите сумму в Сатоши

Опциональное
Receiver address 3

Биткоин адрес получателя

Опциональное
Amount 3

Укажите сумму в Сатоши

Опциональное
Data

Сообщение OP_Return

Опциональное
   
Выполнить

Приём платежей

Создать платёжный адрес

Главная задача в обработке Биткоин платежей это сгенерировать и мониторить уникальный адрес для каждого клиента или счёта. Как только платёж подтверждён сетью, сервер API перечисляет биткоины на указанный адрес продавца. Это может быть личный кошелек, хранилище или адрес биржи для последующего обмена в физическую валюту.
Вы можете создавать каждый раз новый адрес для оплаты или привязать адрес под клиента, если нужно постоянно пополнять разными суммами один и тот же счёт.
Комиссия сервиса составляет 0.0002 BTC с каждой обработанной транзакции, не зависимо от суммы и объёма.  Комиссия пересылается на адрес 1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P. Минимальная сумма для процессинга платежей 30 000 Сатоши. 

 

Создание адреса по типу: Много платежей любыми суммами.

Bitcoin merchant schema

Простой запрос:

GET https://bitaps.com/api/create/payment/{payout_address}/{callback}[?confirmations=0-10&fee_level={high | medium | low}]

Параметры:

{payout_address} Биткоин адрес продавца, на который будут пересылаться деньги
{callback} обратный отклик на указанную ссылку (urlencoded callback - стандарт кодирования строки URL)
[confirmations] число принятых подтверждений платежа в сети Биткоин (опциональное поле, по умолчанию - 3)
[fee_level] Уровень комиссии сети (Опциональное поле, по умолчанию low)

Результат выполнения:

Результатом выполнения являются три значения: сгенерированный адрес для приёма оплаты, код платежа и счёт. Код платежа это личная информация для продавца, которая должна храниться в секрете. Счёт может быть отправлен покупателю и/или будет использован для платёжной формы.

 

Пример результата выполнения:

{
  "address": "14aT7ELki1pVWtryd5brMGqsFySWgjy8je",
  "payment_code": "PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu",
  "invoice": "invNfFnca2Vg49dDg77exiQmqrVKCMBWsBBrB95HNZGbAwqQpNY2b"
}

Все три полученных параметра вы можете посмотреть в нашем блок эксплорере, в строке поиска или в строке браузера:

https://bitaps.com/ru/14aT7ELki1pVWtryd5brMGqsFySWgjy8je

https://bitaps.com/ru/PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu

https://bitaps.com/ru/invNfFnca2Vg49dDg77exiQmqrVKCMBWsBBrB95HNZGbAwqQpNY2b

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

Переменные Тип поля Меняйте значения и получайте результат
Payout address

Биткоин адрес продавца, на который будут пересылаться деньги

Обязательное
Callback URL

обратный отклик на указанную ссылку (urlencoded callback - стандарт кодирования строки URL)

Обязательное
Confirmations

число принятых подтверждений платежа в сети Биткоин (опциональное поле, по умолчанию - 3)

Опциональное
Fee level

Уровень комиссии сети (Опциональное поле, по умолчанию low)

Опциональное
   
Выполнить

Создать смартконтракт (оплата по списку получателей)

Интерфейс работает по тому же принципу что и "Создание платёжного адреса", но вместо одного адреса получателя можно указать список адресов и правил. Список адресов может быть до 20 получателей, а выплата в процентном соотношении или с фиксированной суммой. Каждая выплата происходит каскадом по порядку. Каждый раз остаток от предыдущих выплат берется за 100% и расчет производится от входного остатка.

 

Если в одном из правил требуется фиксированная сумма, меньшая остатка, то такое правило пропускается, и расчет переходит на следующее правило по списку. Например: если вам нужно перевести на адрес А сумму равную 1 BTC (100000000 Сатоши), а оставшуюся сумму 100% на адрес В, но отправитель прислал только 0.5 BTC (50000000 Сатоши).

Сервер проверит, что сумма для выплаты А не достаточно (0.5 меньше 1 BTC), а значит весь этот остаток перейдёт на следующую выплату - 100% на адрес В и вся сумма в 0.5 BTC отправится на адрес В.

 

Мы настоятельно рекомендуем последним правилом пересылать 100%, иначе остаток уйдёт в комиссию Биткоин сети.

Комиссия сервиса составляет 0.0002 BTC с каждой обработанной транзакции, не зависимо от суммы и объёма. Комиссия пересылается на адрес 1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P. Минимальная сумма для процессинга платежей 30 000 Сатоши

Ещё один пример выполнения правил:

Если вы хотите выплатить 50% на адрес A, 1 Биткоин из оставшейся суммы на адрес B, затем 25% на адрес C и оставшиеся 100% на адрес D, то используйте следующую конструкцию: [{"address":A,"quota":50}, {"address":B,"amount":100000000}, {"address":C,"quota":25}, {"address":D,"quota":100}].


Bitcoin smart contract

Запрос:

POST https://bitaps.com/api/create/payment/smartcontract/{callback}[?confirmations=0-10&fee_level={high | medium | low}]

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

{callback} обратный отклик на указанную ссылку (urlencoded callback - стандарт кодирования строки URL)
[confirmations] число принятых подтверждений платежа в сети Биткоин (опциональное поле, по умолчанию - 3)
[fee_level] Уровень комиссии сети (Опциональное поле, по умолчанию low)

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

{
  "type": "payment_list",
  "payment_list": [
    {"address": {addresss},
     "amount | quota": {amount} | {qouta}},
    ... # up to 20 addresses
    ]
}

Результат выполнения:

Результатом выполнения являются три значения: сгенерированный адрес для приёма оплаты, код платежа и счёт. Код платежа это личная информация для продавца, которая должна храниться в секрете. Счёт может быть отправлен покупателю и/или будет использован для платёжной формы.

 

При каждом подтверждении транзакции сети происходит колбэк на указанный вами адрес, как описано в разделе Обработка колбэков.

Пример результата выполнения:

{
  "address": "14aT7ELki1pVWtryd5brMGqsFySWgjy8je",
  "payment_code": "PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu",
  "invoice": "invNfFnca2Vg49dDg77exiQmqrVKCMBWsBBrB95HNZGbAwqQpNY2b"
}

Все три параметра вы можете запросить через строку поиска нашего Блок Эксплорера или в строке браузера:

https://bitaps.com/ru/14aT7ELki1pVWtryd5brMGqsFySWgjy8je

https://bitaps.com/ru/PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu

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

Переменные Тип поля Меняйте значения и получайте результат
Payout address №1

Первый адрес, на который будет отправлен платёж

Обязательное


Payout address №2

Второй адрес, на который будет отправлен платёж

Обязательное


Payout address №3

Третий адрес, на который будет отправлен платёж

Обязательное


Callback URL

обратный отклик на указанную ссылку (urlencoded callback - стандарт кодирования строки URL)

Обязательное
Confirmations

число принятых подтверждений платежа в сети Биткоин (опциональное поле, по умолчанию - 3)

Опциональное
Fee level

Уровень комиссии сети (Опциональное поле, по умолчанию low)

Опциональное
   
Выполнить

Создать смартконтракт (поддержание баланса на горячем кошельке)

Интерфейс работает по тому же принципу что и "Создание платёжного адреса", но деление средств происходит между горячим и холодным кошельком.

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

В случае процентного соотношения горячего к холодному кошельку, процент берётся от баланса холодного кошелька.

Комиссия сервиса составляет 0.0002 BTC с каждой обработанной транзакции, не зависимо от суммы и объёма. Комиссия пересылается на адрес 1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P. Минимальная сумма для процессинга платежей 30 000 Сатоши


Bitcoin smart contract

Пример 1

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

Текущий баланс горячего кошелька всего 5 BTC.

Клиент отправляет вам 3 BTC.

Сервис проверяет оба баланса кошельков, находит, что на горячем кошельке не достаточно средств, и переводит все 3 BTC на него. Так как там требуется поддерживать 10 BTC.

 

Пример 2

Те же условия, но клиент отправляет 7 BTC.

В этом случае сервис отправит 5 BTC на горячий кошелек, что бы достичь необходимых 10 BTC на балансе. А остальные 2 BTC отправит на указанный адрес холодного хранилища.

 

Пример 3

Смартконтракт должен поддерживать баланс горячего кошелька в 10 BTC.

Его текущий баланс 10 BTC.

Клиент отправляет 8 BTC.

Сервис проверяет баланс горячего кошелька и обнаруживает, что баланс по смартконтракту полный и отправляет все 8 BTC на адрес холодного хранилища.

 

Запрос:

POST https://bitaps.com/api/create/payment/smartcontract/{callback}[?confirmations=0-10&fee_level={high | medium | low}]

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

{callback} обратный отклик на указанную ссылку (urlencoded callback - стандарт кодирования строки URL)
[confirmations] число принятых подтверждений платежа в сети Биткоин (опциональное поле, по умолчанию - 3)
[fee_level] Уровень комиссии сети (Опциональное поле, по умолчанию low)

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

{
  "type": "hot_wallet",
  "hot_wallet": {address_1},
  "cold_storage": {address_2},
  "hot_wallet_quota | hot_wallet_amount": {quota} | {amount}
}

Результат выполнения:

Результатом выполнения являются три значения: сгенерированный адрес для приёма оплаты, код платежа и счёт. Код платежа это личная информация для продавца, которая должна храниться в секрете. Счёт может быть отправлен покупателю и/или будет использован для платёжной формы.

 

При каждом подтверждении транзакции сети происходит колбэк на указанный вами адрес, как описано в разделе Обработка колбэков.

Пример результата выполнения:

{
  "address": "14aT7ELki1pVWtryd5brMGqsFySWgjy8je",
  "payment_code": "PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu",
  "invoice": "invNfFnca2Vg49dDg77exiQmqrVKCMBWsBBrB95HNZGbAwqQpNY2b"
}

Эти параметры вы можете запросить через строку поиска нашего Блок Эксплорера или в строке браузера:

https://bitaps.com/ru/14aT7ELki1pVWtryd5brMGqsFySWgjy8je

https://bitaps.com/ru/PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu

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

Переменные Тип поля Меняйте значения и получайте результат
Bitcoin address of Hot wallet

Биткоин адрес кошелька, на котором будет поддерживаться баланс

Обязательное


Quota or amount

Выберите процентное соотношение или точную сумму, которая будет поддерживаться на горячем кошельке. Сумма в Сатоши.

Обязательное


Bitcoin address of Cold storage

Биткоин адрес холодного хранилища

Обязательное


Callback URL

обратный отклик на указанную ссылку (urlencoded callback - стандарт кодирования строки URL)

Обязательное
Confirmations

число принятых подтверждений платежа в сети Биткоин (опциональное поле, по умолчанию - 3)

Опционально
Fee level

Уровень комиссии сети (Опциональное поле, по умолчанию low)

Опционально
   
Execute

Обработка колбэков

После подтверждения платежа, Bitaps REST API произведёт обратный отклик на указанную ссылку URL.

Для подтверждения ответа на наши колбэки, ваш сервер должен вернуть Invoice в ответ, в обычном текстовом формате.

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

Bitcoin payment callback
POST your_callback_url

В каждом колбэке отправляются переменные в POST запросе:

  tx_hash={transaction hash}
  address={address}
  invoice={invoice}
  code={payment code}
  amount={amount} # Satoshi
  confirmations={confirmations}
  payout_tx_hash={transaction hash} # payout transaction hash
  payout_miner_fee={amount}
  payout_service_fee={amount}

Пример обработки колбэка:

Данные из блокчейн сети

Блоки

Получить информацию о блоке

Запрос:

GET https://bitaps.com/api/block/{block_height | block_hash}

Параметры:

{block_height | block_hash}block height or block hash

Результат выполнения:

{
  "height": {block height},
  "hash": {"block hash"},
  "previuos_block_hash": {"block hash"},
  "next_block_hash": {"block hash"},
  "merkleroot": {"merkleroot"},
  "coinbase": {"coinbase message hex"},
  "miner": {"miner name"},
  "timestamp": {timestamp},
  "version": {version},
  "transactions": {count},
  "size": {size in bytes},
  "bits": {bits},
  "nonce": {nonce}
}

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

Переменные Тип поля Меняйте значения и получайте результат
Высота блока или хэш блока

Номер блока или хэш блока в блокчейн сети

Обязательное
   
Выполнить

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

Запрос

GET https://bitaps.com/api/block/latest

Результат выполнения:

{
  "height": {block height},
  "hash": {"block hash"},
  "previuos_block_hash": {"block hash"},
  "next_block_hash": {"block hash"},
  "merkleroot": {"merkleroot"},
  "coinbase": {"coinbase message hex"},
  "miner": {"miner name"},
  "timestamp": {timestamp},
  "version": {version},
  "transactions": {count},
  "size": {size in bytes},
  "bits": {bits},
  "nonce": {nonce}
}

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

Выполнить

Получить список транзакций в блоке

Запрос

GET https://bitaps.com/api/block/transactions/{block_height | block_hash}

Параметры:

{block_height | block_hash}block height or block hash

Результат выполнения:

[
  ["{transaction}", "{block_data_hex} | null", {amount}],
  ...
]

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

Переменные Тип поля Меняйте значения и получайте результат
Высота блока или хэш блока

Номер блока или хэш блока в блокчейн сети

 

Обязательное
   
Выполнить

Транзакции

Получить информацию о транзакции

GET https://bitaps.com/api/transaction/{tx_hash}

Параметры:

{tx_hash}transaction hash

Результат выполнения:

{
  "hash": "{transaction hash}",
  "data": "{transaction data hex}",
  "coinbase": {true | false},
  "block": {block_height} | null,
  "version": {version},
  "size": {size in bytes},
  "timestamp": {received timestamp},
  "inputs":
    [
      {
      "input_index": {input number},
      "sequence": {sequence},
      "hash": "{input transaction hash}",
      "out_index": {input transaction output index},
      "amount": {amount in satoshi},
      "address": ["{addresss}",...],
      "script": null | {
        "type": "{output script type}",
        "hex": "{output script hex}",
        "asm": "{output script asm}",
        "pattern": "{output script pattern}",
        },
      "sig_script": {
        "type": "SIGSCRIPT",
        "hex": "{signature script hex}",
        "asm": "{signature script asm}",
        "pattern": "{signature script pattern}",
        },
      "reedem_script": null | {
        "type": "{redeem script hex}" | null,
        "hex": "{redeem script hex}" | null,
        "asm": "{redeem script hex}" | null,
        "pattern": "{redeem script hex}" | null,
        }
      },
      ...
    ]
  "outputs":
    [
      {
      "output_index": {output index},
      "amount": {output amount},
      "address": ["{addresss}",...],
      "script": {
        "type": "{script type}",
        "hex": "{script hex}",
        "asm": "{script asm}",
        "pattern": "{script pattern}",
        }
      },
      ...
    ]
}

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

Переменные Тип поля Меняйте значения и получайте результат
tx_hash

Хэш транзакции

Обязательное
   
Выполнить

Получить сырую транзакцию

Запрос

GET https://bitaps.com/api/raw/transaction/{tx_hash}

Параметры:

{tx_hash}transaction hash

Результат выполнения:

{
  "hash": "{transaction hash}",
  "hex": "{raw transaction in hex representation}"
}

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

Переменные Тип поля Меняйте значения и получайте результат
tx_hash

Хэш транзакции

Обязательное
   
Выполнить

Адреса

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

Запрос

GET https://bitaps.com/api/address/{address}

Параметры:

{address}address

Результат выполнения:

{
  "balance":{balance},
  "confirmed_balance":{only confirmed balance},
  "received":{total amount received},
  "sent":{total amount sent},
  "pending":{pending amount},
  "multisig_received":{count},
  "multisig_sent":{count},
  "tx_received":{count},
  "tx_sent":{count},
  "tx_multisig_received":{count},
  "tx_multisig_sent":{count},
  "tx_unconfirmed":{count},
  "tx_invalid":{count}
}

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

Переменные Тип поля Меняйте значения и получайте результат
address

Сжатый или несжатый адрес.

Обязательное
   
Выполнить

Получить список транзакций по адресу

Запрос:

GET https://bitaps.com/api/address/transactions/{address}[/{offset}[/{all | sent | received | multisig}[/{all | confirmed | unconfirmed | invalid }]]]

Параметры:

{address}address
{offset} опциональное поле, offset list, response records limit 100, По умолчанию 0
{all | sent | received | multisig}опциональное поле, transactions type, По умолчанию all
{all | confirmed | unconfirmed | invalid}опциональное поле, transactions status, По умолчанию all

Результат выполнения:

[
  [{timestamp}, "{hash}", "{data}", "{type}", "{status}", {confirmations}, {block}, {amount}],
  ...
]

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

Переменные Тип поля Меняйте значения и получайте результат
address

Указанный адрес

Обязательное
offset

Отступ в списке. Возвращается только 100 записей.
По умолчанию: 0

Опциональное
transactions type

Тип транзакции. Варианты: all (все), sent (отправленные), received (полученные), multisig (мульти-подпись)
По умолчанию: all

Опциональное
current transaction status

Текущий статус транзакции. Варианты: all (все), confirmed (подтверждённые), unconfirmed (неподтверждённые), invalid (недействительные).
По умолчанию: all (все)

Опциональное
   
Выполнить

Статистика блокчейн сети

Сложность сети

Получить текущую сложность Биткоин сети:

GET https://bitaps.com/api/difficulty

Результат выполнения:

{
  "difficulty": {difficulty}
}

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

Выполнить

Хэшрейт сети

Получить хэшрейт Биткоин сети за последние 24 часа:

GET https://bitaps.com/api/hashrate

Результат выполнения:

{
  "hashrate": "{hashrate}"
}

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

Выполнить

Среднее время расчета блока

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

GET https://bitaps.com/api/blocktime

Результат выполнения:

{
  "blocktime": {average block time, seconds}
}

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

Выполнить

Средний размер блока

Получить средний размер блока за последние 24 часа:

GET https://bitaps.com/api/blocksize

Результат выполнения:

{
  "blocksize": {average block size, bytes}
}

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

Выполнить

Количество транзакций в секунду

Получить среднее количество транзакций в секунду за последние 24 часа:

GET https://bitaps.com/api/txrate

Результат выполнения:

{
  "txrate": "{average transactions rate, tx per second}"
}

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

Выполнить

Комиссия сети

Получить три варианта стоимости комиссии сети:

Комиссия сети за транзакцию рассчитывается на основе статистического анализа из последних 36 блоков. Измеряется в сатоши на байт.

GET https://bitaps.com/api/fee

Результат выполнения:

{
  "high": "{high priority}",
  "medium": "{medium priority}",
  "low": "{low priority}"
}

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

Выполнить

Графическое API

Формат текстовой записи QR (кю ар) кода для Биткоин сети поддерживается стандартом BIP 0021. Запись может состоять из отдельного Биткоин адреса или запроса, на подобие URI запроса адресной строки в браузере.

Данная конструкция выглядит следующим образом:

bitcoin:{address}?amount={amount}&label={label}&message={message}...

Вся строка должна быть переведена в формат urlencoded.

Существуют стандартные переменные, которые поддерживаются большинством кошельков:

Опционально, можно передавать любые переменные и параметры. Если они не поддерживаются распознающим приложением, то будут проигнорированы.

Несколько примеров QR кода:

Только адрес:

bitcoin:39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9
или только адрес 39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9

Адрес с подписью:
bitcoin:39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9?label=software

Запрос 20.30 BTC для оплаты адреса с подписью "software":

bitcoin:39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9?amount=20.3&label=software

Запрос 50 BTC с сообщением 'server license' на адрес с подписью "software":

bitcoin:39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9?amount=50&label=software&message=server%20license

Пример опциональных переменных, которые не распознаются текущими кошельками и будут проигнорированы:

bitcoin:39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9?req-somethingyoudontunderstand=50&req-somethingelseyoudontget=999

 

Изображение QR кода может быть только чёрного цвета на белом фоне. Любые изменения цветов может снизить скорость распознавания или оставить код не распознанным. Это заложено в стандарте QR.

QR код в текстовом формате SVG

Получить QR код для сообщения или адреса, в формате SVG (векторная графика) в текстовом формате base64:

GET https://bitaps.com/api/qrcode/{message}

Параметры:

{message} кодированная строка сообщения (urlencoded) или Биткоин адрес, максимум 256 символов

Результат выполнения:

{
  "message": "{message}",
  "qrcode": "{base64 encoded svg}"
}

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

Переменные Тип поля Меняйте значения и получайте результат
QR code message

кодированная строка сообщения (urlencoded) или Биткоин адрес, максимум 256 символов

Обязательное
   
Выполнить

QR код изображение в формате PNG

Получить QR код для сообщения или адреса, в формате PNG:

GET https://bitaps.com/api/qrcode/png/{message}

Параметры:

{message} кодированная строка сообщения (urlencoded) или Биткоин адрес, максимум 256 символов

В результате выполнения, вы получаете изображение в формате PNG, которое сразу же можно вставлять как изображение на странице или скачать его для дальнейшего использования в виде отдельного файла.

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

Переменные Тип поля Меняйте значения и получайте результат
QR code message

кодированная строка сообщения (urlencoded) или Биткоин адрес, максимум 256 символов

Обязательное
   
Выполнить

API статистики рынка

Курс обмена

Интерфейс возвращает текущую стоимость Биткоина по трём основным биржам: Bitstamp.net, Bitfinex.com, Coinbase.com или средневзвешенный курс в Долларах США.

Валюты: Евро, Российский Рубль и Китайская Йена вычисляются путём умножения курса ММВБ (http://moex.com/) на курс биткоина в Долларах США.

Запрос: