Bitcoin RESTful API

We are opened to create new special API interfaces for you.
Please contact us via email: support@bitaps.com or skype:

Bitaps support

Overview

The Bitaps Bitcoin REST API uses HTTP methods and a RESTful endpoint structure. You have to format requests in JSON and the APIs return JSON-formatted responses. All requests over secure HTTPS protocol only.

 

To construct a REST call, combine:

• The HTTP method
• The full URI to the resource
• HTTP headers, if required
• The JSON-formatted payload, if required

The REST API endpoint URL: https://bitaps.com

Errors

Bitaps uses standard HTTP status codes when returning errors. Additionally, we provide details about errors in the body of the response in the following format:

{
  "error_code": {error code},
  "message": "{error description}",
  "details": "{additional details if available}"
}

HTTP status codes:

200	Request successfully executed
400	Bad request
401	Unauthorized request
402	Failed request
403	Forbidden
404	Resource was not found
50x	Server error

Query example:

1. <?php
2.   echo 'HTTP status code:' . get_http_response_code ('https://bitaps.com/api/ticker');
   
3. ?>

1. curl https://bitaps.com/api/ticker

1. import requests
3. response = requests.get("https://bitaps.com/api/ticker")
4. print(response.text)

Execute

Conditions

Using Bitaps API is opened for everyone, no registration, no restrictions, no any keys. All application interfaces are opened to use.

Each customer have to observe and bear the law responsibility at the local, federal and global level, the legislation does not violate ethical principles and practices. We fully disclaim liability for the content and the work of connected resources to us. These resources are not controlled by us and our services opened for public use.

We will not share or disclose information about customers, because we do not have the registration of users and their data. All transactions are transparent and available for a detailed view in any Bitcoin explorer with complete node. Bitcoin blockchain database is distributed worldwide.

Architecture of Bitcoin blockchain network is not able to block, cancel, return or roll back transactions on the network.

Please refer to the Privacy policy page.

Fee

We take fee from two interfaces only:

• Accepting Bitcoin payments to Created payment address
• Accepting Bitcoin payments to Created smartcontract
• Accepting Bitcoin payments to Created smartcontract hot wallet

Bitaps takes fixed commission for each processed payment 0.0002 BTC.

We not take fee from amounts less then 100000 Satoshi.

Smartcontract takes fee onetime only.

All fees will be sent to 15qvBdqSWQCuLQPXVoWViG2GvjeARmpYPw.

 

 

Payments

Work with Redeem code

Create Redeem Code

Redeem code is like a Bitcoin wallet. You can receive payments to generated Redeem Code Address and transfer money by query.

Use Get query to create Redeem Code:

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

Parameters:

[confirmations]

number of accepted confirmations (optional field, default 1)

Range from 1 up to 6.

Response:

As a response generated 3 values: receiving Address, Redeem Code and Invoice.

Address is a Bitcoin address to receive payments.

Invoice could be sent to customer and also used for payment form. Invoice is used to view payments and transactions.

Redeem Code is used to send Bitcoin whole or part of money from this code to any other Bitcoin addresses by query.

Response example:

{
  "address": "1CZgyfDsA5Bob2wVyTbCxSGXwSAEur4LYB",
  "redeem_code": "BTCvNqa8knrVkGyYmrfMTRtU77xrnPWiiH8n8accdEm9W1EHsRbCz",
  "invoice": "invPvfHny5QnffugyKgwYvUeXjCUgz4ywhxzANDcTHa7amWLKbjnb"
} Store all three values and keep "redeem_code" in safe place ! Because it's an important code to control your money.
Please do not send amount less then 5000 Satoshi to redeem code, otherwise transaction miners fee will take almost full amount.

Query example:

1. <?php
2.   $confirmations = 3; // the desired number of confirmations
3.   $data = file_get_contents("https://bitaps.com/api/create/redeemcode?confirmations=". $confirmations);
   
4.   $respond = json_decode($data,true);
5.   $address = $respond["address"]; // Bitcoin address to receive payments
   
6.   $redeem_code = $respond["redeem_code"]; //Redeem Code for sending payments
   
7.   $invoice = $respond["invoice"]; // Invoice to view payments and transactions
   
8. ?>

1. curl https://bitaps.com/api/create/redeemcode?confirmations=3

1. import requests
3. parameters = {"confirmations": 3,}
4. response = requests.get("https://bitaps.com/api/create/redeemcode", params=parameters)
5. print(response.text)

Variables	Required	Experiment with a value
Confirmations Number of accepted confirmations. Range 1-10, default 3.	Optional
		Execute

Get Redeem Code info

Request:

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

Parameters:

{redeemcode}

Redeem Code

Response:

Function returns next fields: receiver address, current balance, pending balance(unconfirmed), paid out amount.

Response:

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

Query example:

1. <?php
2.   function post_api($url, $postfields) {
3.     $ch = curl_init();
4.     curl_setopt($ch, CURLOPT_URL, $url);
5.     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
6.     curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
7.     curl_setopt($ch, CURLOPT_POST, 1);
8.     curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
9.     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
10.     $result = curl_exec($ch);
11.     return $result;
12.   }
13.   $redeemcode = "BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq";
14.   
15.   $postfields = json_encode(array('redeemcode'=> $redeemcode));
16.   $data = post_api("https://bitaps.com/api/get/redeemcode/info", $postfields);
17.   echo $data;
18.   $respond = json_decode($data,true);
19.   $address = $respond["address"]; // Redeem code receiver address
20.   $balance = $respond["balance"]; // Current balance
21.   $pending_balance = $respond["pending_balance"]; // Pending balance (unconfirmed)
22.   $paid_out = $respond["paid_out"]; // Paid out amount
23. ?>

1. curl --data '{"redeemcode":"BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq"}' https://bitaps.com/api/get/redeemcode/info
   

1. import requests
2. import json
4. url = 'https://bitaps.com/api/get/redeemcode/info'
5. parameters = {'redeemcode': 'BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq'}
6. response = requests.post(url, data=json.dumps(parameters))
7. print(response.text)

Variables	Required	Experiment with a value
Redeem Code Your Redeem Code	Required
		Execute

Sending Bitcoins from Redeem code

Query example:

1. <?php
2.   function post_api($url, $postfields) {
3.     $ch = curl_init();
4.     curl_setopt($ch, CURLOPT_URL, $url);
5.     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
6.     curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
7.     curl_setopt($ch, CURLOPT_POST, 1);
8.     curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
9.     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
10.     $result = curl_exec($ch);
11.     return $result;
12.   }
13.   $redeemcode = "BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq";
14.   $address = "39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9";
15.   $amount = "All available";
16.   
17.   $postfields = json_encode(array('redeemcode'=> $redeemcode, 'address'=> $address, 'amount'=>$amount ));
    
18.   $data = post_api("https://bitaps.com/api/use/redeemcode", $postfields);
19.   echo $data;
20.   $respond = json_decode($data,true);
21.   $tx_hash = $respond["tx_hash"]; //Transfer transaction hash
22. ?>

1. curl --data '{"redeemcode":"BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq","amount":"All available","address":"39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9"}' https://bitaps.com/api/use/redeemcode
   

1. import requests
2. import json
4. url = 'https://bitaps.com/api/use/redeemcode'
5. parameters = {'redeemcode': 'BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq',
6. 'address': '39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9',
7. 'amount': 'All available'}
8. response = requests.post(url, data=json.dumps(parameters))
9. print(response.text)

Variables	Required	Experiment with a value
Redeem Code Your Redeem Code	Required
Receiver address Bitcoin address where confirmed payments will be transferred	Required
Amount "amount" or "All available". Amount in Satoshi. In case if amount = "All available", the remaining balance will be sent to specified address.	Required
		Execute

Mass payment from Redeem code

Query example:

1. <?php
2.   function post_api($url, $postfields) {
3.     $ch = curl_init();
4.     curl_setopt($ch, CURLOPT_URL, $url);
5.     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
6.     curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
7.     curl_setopt($ch, CURLOPT_POST, 1);
8.     curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
9.     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
10.     $result = curl_exec($ch);
11.     return $result;
12.   }
13.   $redeemcode = "BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq";
14.   $data = "Bitaps.com";
15.   
16.   $rules = [
17.     array('address'=>'39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9', 'amount'=> 30000),
18.     array('address'=>'1NtWuDrj5MSB1dioLKYX7oAy4S9XnDrWj7', 'amount'=> 40000),
19.     array('address'=>'1EctJ88N6xsVhiSQLYHTqd9amkW57SPwpx', 'amount'=> 50000)
20.   ];
21.   
22.   $postfields = json_encode(array('redeemcode'=> $redeemcode, 'data'=> bin2hex($data),'payment_list'=> $rules ));
23.   $data = post_api("https://bitaps.com/api/use/redeemcode/list", $postfields);
24.   echo $data;
25.   $respond = json_decode($data,true);
26.   $tx_hash = $respond["tx_hash"]; //Transfer transaction hash
27. ?>

1. $H=$(hexdump<<<"Bitaps.com" | sed "s/ *//g;s/^.\{7\}//;s/\(..\)\(..\)/\2\1/g" | tr -d "\n";)
2. curl --data '{"redeemcode":"BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq","data":"'$H'", "payment_list": [{"address":"39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9","amount":"30000"},{"address":"1NtWuDrj5MSB1dioLKYX7oAy4S9XnDrWj7","amount":"40000"},{"address":"1EctJ88N6xsVhiSQLYHTqd9amkW57SPwpx","amount":"50000"}]}' https://bitaps.com/api/use/redeemcode/list

1. import requests
2. import binascii
3. import json
5. url = 'https://bitaps.com/api/use/redeemcode/list'
6. parameters = {'redeemcode': 'BTCuoC8AGRbHjEss347c4KoQrdzqyJwDSdAxbjAoC4tyAbxTAhBuq',
7. 'data': 'binascii.hexlify("Bitaps.com".encode())',
8. "payment_list": [{
9. 'address': '39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9', 'amount': '30000'},
10. 'address': '1NtWuDrj5MSB1dioLKYX7oAy4S9XnDrWj7', 'amount': '40000'},
11. 'address': '1EctJ88N6xsVhiSQLYHTqd9amkW57SPwpx', 'amount': '50000'}]}
12. response = requests.post(url, data=json.dumps(parameters))
13. print(response.text)

Variables	Required	Experiment with a value
Redeem Code Your Redeem Code	Required
Receiver address 1 Bitcoin receiver address	Required
Amount 1 Amount in Satoshi	Required
Receiver address 2 Bitcoin receiver address	Optional
Amount 2 Amount in Satoshi	Optional
Receiver address 3 Bitcoin receiver address	Optional
Amount 3 Amount in Satoshi	Optional
Data Transaction message (OP_Return)	Optional
		Execute

Accept payments

Create payment address

Main task in processing bitcoin payments is generate and monitoring an unique address for each new user or invoice. Once payment received and confirmed, API server forward bitcoins to main merchant address, cold storage or exchange to foreign currency on markets. Bitaps takes fixed commission for each processed payment 0.0002 BTC. Bitaps fee will be sent to 1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P. Minimal amount for processing 30 000 Satoshi. You can use this interface for each order separately or as an constant Bitcoin address attached to customers account.

Create an address by type: Many payments at any amount.

Simple requests:

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

Parameters:

{payout_address}	Merchant's Bitcoin address where confirmed payments will be transferred
{callback}	Urlencoded callback URL
[confirmations]	Number of accepted confirmations (optional field, default 3)
[fee_level]	Network fee level (optional field, default low)

Response:

Query returns: Address, Payment Code and Invoice.
Address is a Bitcoin address to receive payments.
Payment Code is a private information and merchant should keep it in secret. This Code need for verification of callbacks.
Invoice could be sent to customer and also used for payment form.

Response example:

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

All three response parametrs you can find in our Block Explorer via search field or open as URL:

https://bitaps.com/14aT7ELki1pVWtryd5brMGqsFySWgjy8je

https://bitaps.com/PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu

Query example:

1. <?php
2.   $payout_address = "39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9";
3.   $confirmations = 3;
4.   $fee_level = "low";
5.   $callback = urlencode("http://www.test.me/addbalance.php?user=118");
6.   $data = file_get_contents("https://bitaps.com/api/create/payment/". $payout_address. "/" . $callback . "?confirmations=" . $confirmations. "&fee_level=" . $fee_level);
7.   $respond = json_decode($data,true);
8.   $address = $respond["address"]; // Bitcoin address to receive payments
   
9.   $payment_code = $respond["payment_code"]; //Payment Code
10.   $invoice = $respond["invoice"]; // Invoice to view payments and transactions
11. ?>

1. rawurlencode() {
2. local string="${1}"
3. local strlen=${#string}
4. local encoded=""
5. local pos c o
6. for (( pos=0 ; pos<strlen ; pos++ )); do
7.   c=${string:$pos:1}
8.   case "$c" in
9.     [-_.~a-zA-Z0-9] ) o="${c}" ;;
10.     * ) printf -v o '%%%02x' "'$c"
11.   esac
12.   encoded+="${o}"
13. done
14. REPLY="${encoded}"
15. }
16.  
17. rawurlencode "http://www.test.me/addbalance.php?user=118"
18. curl "https://bitaps.com/api/create/payment/39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9/${REPLY}?confirmations=3&fee_level=low"

1. import requests
2. import urllib
4. address = '39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9'
5. callback = urllib.parse.urlencode({"r":"http://www.test.me/addbalance.php?user=118"})[2:]
6. parameters = {"confirmations": 3,"fee_level":"low",}
7. url = 'https://bitaps.com/api/create/payment/%s/%s' % (address, callback)
8. response = requests.get(url, params=parameters)
9. print(response.text)

Variables	Required	Experiment with a value
Payout address Your Bitcoin address where confirmed payments will be transferred	Required
Callback URL Your website URL with specified receiver page and optional extra GET parametrs	Required
Confirmations Number of accepted confirmations. Range 1-10, default 3.	Optional
Fee level Network fee level (optional field, default low).	Optional	low medium high
		Execute

Create smartcontract - payment to recipients list

That interface works like a "Create payment address", but received payment will be paid to list of addresses and rules. Amount can be splitted up to 20 addresses by exact amount in Satoshi or by percent (quota). Each calculation is made of the remaining amount by cascade.

If one of the rules is needed more than the remaining amount, then this rule will be skipped and proceeds to the next on the list. For example If you want to transfer 100000000 (1 BTC) to address A and rest amount 100% to address B, but sender sent 50000000 (0.5 BTC). First rule will be skipped, because 0.5 BTC is less then 1BTC and this rule does not work. As a result - full amount will be transferred to address B.

We strongly recommend always add last rule to transfer 100%!

Be careful: In case you not specify last item in list with quota 100% rest amount will be added to transaction miner fee.

Bitaps take 0.0002 BTC processing fee one time and execute it firstly.

 

Examples of rules:

If you want to pay 50% to address A, 1 Bitcoin of rest amount to address B, 25% to address C and 100% of rest amount to address D, use next construction: [{"address":A,"quota":50}, {"address":B,"amount":100000000}, {"address":C,"quota":25}, {"address":D,"quota":100}].

Request:

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

GET parametrs:

{callback}	Urlencoded callback URL
[confirmations]	Number of accepted confirmations (optional field, default 3)
[fee_level]	Miner fee level (optional field, default low)

POST parametrs:

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

Response:

Query returns: Address, Payment Code and Invoice.
Address is a Bitcoin address to receive payments.
Payment Code is a private information and merchant should keep it in secret. This Code need for verification of callbacks.
Invoice could be sent to customer and also used for payment form.

 

Every transaction confirmation response doing callback to link as described in section Processing the callback.

Response example:

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

All three response parametrs you can find in our Block Explorer via search field or open as URL:

https://bitaps.com/14aT7ELki1pVWtryd5brMGqsFySWgjy8je

https://bitaps.com/PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu

Query example:

1. <?php
2.   function post_api($url, $postfields) {
3.     $ch = curl_init();
4.     curl_setopt($ch, CURLOPT_URL, $url);
5.     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
6.     curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
7.     curl_setopt($ch, CURLOPT_POST, 1);
8.     curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
9.     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
10.     $result = curl_exec($ch);
11.     return $result;
12.   }
13.  
14.   $confirmations = 3;
15.   $callback = urlencode("http://www.test.me/addbalance.php?user=118");
16.   $fee = "low";
17.   $rules = [
18.     array('address'=>'18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov', 'amount'=> 20000),
19.     array('address'=>'39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9', 'quota'=> 20),
20.     array('address'=>'1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P', 'quota'=> 100)
21.   ];
22.   
23.   $postfields = json_encode(array('type'=>"payment_list", 'payment_list'=> $rules ));
24.   $data = post_api("https://bitaps.com/api/create/payment/smartcontract/". $callback . "?confirmations=" . $confirmations . "&fee_level=" . $fee, $postfields);
25.   echo $data;
26.   $respond = json_decode($data,true);
27.   $address = $respond["address"]; // Bitcoin address to receive payments
    
28.   $payment_code = $respond["payment_code"]; //Payment Code
29.   $invoice = $respond["invoice"]; // Invoice to view payments and transactions
30. ?>

1. rawurlencode() {
2. local string="${1}"
3. local strlen=${#string}
4. local encoded=""
5. local pos c o
7. for (( pos=0 ; pos<strlen ; pos++ )); do
8. c=${string:$pos:1}
9. case "$c" in
10. [-_.~a-zA-Z0-9] ) o="${c}" ;;
11. * ) printf -v o '%%%02x' "'$c"
12. esac
13. encoded+="${o}"
14. done 
15. REPLY="${encoded}"
16. }
18. rawurlencode "http://www.test.me/addbalance.php?user=118"
19. curl --data '{"type": "payment_list","payment_list": [{"address": "18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov","amount": 20000},{"address": "39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9","quota":20},{"address": "1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P","quota":100}]}' https://bitaps.com/api/create/payment/smartcontract/${REPLY}?confirmations=3&fee_level=low

1. import requests
2. import json
3. import urllib
5. callback = urllib.parse.urlencode({"r":"http://www.test.me/addbalance.php?user=118"})[2:]
6. parameters = {'confirmations': '3',}
7. url = 'https://bitaps.com/api/create/payment/smartcontract/%s' % callback
8. parameters = {"confirmations": 3,"fee_level":"low",
9. "payment_list": [{"address": "18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov","amount": 20000},
10. {"address": "39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9","quota": 20},
11. {"address": "1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P","quota": 100}]}
12. response = requests.post(url, params=parameters, data=json.dumps(parameters))
13. print(response.text)

Variables	Required	Experiment with a value
Hot wallet Bitcoin address where confirmed payments will be transferred	Required	amount (in Satoshi) quota (%)
Cold storage Bitcoin address where confirmed payments will be transferred	Required	amount (in Satoshi) quota (%)
Payout address №3 Bitcoin address where confirmed payments will be transferred	Required	amount (in Satoshi) quota (%)
Callback URL Your website URL with specified receiver page and optional extra GET parametrs	Required
Confirmations Number of accepted confirmations. Range 1-10, default 3.	Optional
Fee level Network fee level (optional field, default low).	Optional	low medium high
		Execute

Create smartcontract - Hot wallet

That interface works like a "Create payment address", but received payment will be separated to hot wallet and cold storage of bitcoins.

For example, you need quick pay in your project and supply hot wallet balance for fast payout. Remained amount will be transferred to treasure, cold storage or trade account.

Hot wallet balance regulated by quota or specified amount. Quota is a percent between hot and cold wallets balances. We check balances on both wallets and distribute payment with same proportion.

Bitaps take 0.0002 BTC processing fee one time and execute it firstly.

Example 1

Your smrartcontract supply hot wallet balance 10 BTC, rest amount will be transferred to cold storage.

Currently Hot wallet have 5 BTC only.
Customer sent 3 BTC.
As a result, all these money will be transafered to Hot wallet, becausse 5+3 less then required 10 BTC.

 

Example 2

Same situation, but customer sending 7 BTC.
Smartcontract will distribute 5 BTC up to 10 BTC to Hot wallet, and will transfer remained 2 BTC to cold storage.

 

Example 3

Smart contract have to supply Hot wallet balance 10 BTC.

Currently Hot wallet is full and have 10 BTC balance.

Customer send 8 BTC.
Smartcontract will check Hot wallet balance and will transfer all 8 BTC to cold storage.

 

Request:

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

GET parametrs:

{callback}	Urlencoded callback URL
[confirmations]	Number of accepted confirmations (optional field, default 3)
[fee_level]	Miner fee level (optional field, default low)

POST parametrs:

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

Response:

Query returns: Address, Payment Code and Invoice.
Address is a Bitcoin address to receive payments.
Payment Code is a private information and merchant should keep it in secret. This Code need for verification of callbacks.
Invoice could be sent to customer and also used for payment form.

 

Every transaction confirmation response doing callback to link as described in section Processing the callback.

Response example:

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

All three response parametrs you can find in our Block Explorer via search field or open as URL:

https://bitaps.com/14aT7ELki1pVWtryd5brMGqsFySWgjy8je

https://bitaps.com/PMTvvdRdFBPvY1KrDeRxSuwr4nDcMVBenbX2rB2zRYHBHbGRYK5Lu

Query example:

1. <?php
2.   function post_api($url, $postfields) {
3.     $ch = curl_init();
4.     curl_setopt($ch, CURLOPT_URL, $url);
5.     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
6.     curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
7.     curl_setopt($ch, CURLOPT_POST, 1);
8.     curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
9.     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
10.     $result = curl_exec($ch);
11.     return $result;
12.   }
13.  
14.   $confirmations = 3;
15.   $callback = urlencode("http://www.test.me/addbalance.php?user=118");
16.   $fee = "low";
17.   
18.   $postfields = json_encode(array('type'=>"hot_wallet", 'hot_wallet'=>'18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov',
19.   'cold_storage'=>'39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9', 'hot_wallet_quota'=> 20 ));
20.   $data = post_api("https://bitaps.com/api/create/payment/smartcontract/". $callback . "?confirmations=" . $confirmations . "&fee_level=" . $fee, $postfields);
21.   echo $data;
22.   $respond = json_decode($data,true);
23.   $address = $respond["address"]; // Bitcoin address to receive payments
    
24.   $payment_code = $respond["payment_code"]; //Payment Code
25.   $invoice = $respond["invoice"]; // Invoice to view payments and transactions
26. ?>

1. rawurlencode() {
2. local string="${1}"
3. local strlen=${#string}
4. local encoded=""
5. local pos c o
7. for (( pos=0 ; pos<strlen ; pos++ )); do
8. c=${string:$pos:1}
9. case "$c" in
10. [-_.~a-zA-Z0-9] ) o="${c}" ;;
11. * ) printf -v o '%%%02x' "'$c"
12. esac
13. encoded+="${o}"
14. done 
15. REPLY="${encoded}"
16. }
18. rawurlencode "http://www.test.me/addbalance.php?user=118"
19. curl --data '{"type": "hot_wallet","hot_wallet": "18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov", "cold_storage": "39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9","hot_wallet_quota":20}' https://bitaps.com/api/create/payment/smartcontract/${REPLY}?confirmations=3&fee_level=low

1. import requests
2. import json
3. import urllib
5. callback = urllib.parse.urlencode({"r":"http://www.test.me/addbalance.php?user=118"})[2:]
6. get_parameters = {'confirmations': '3','fee_level': 'low'}
7. url = 'https://bitaps.com/api/create/payment/smartcontract/%s' % callback
8. post_parameters = {"type": "hot_wallet",
9. "hot_wallet": "18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov",
10. "cold_storage": "39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9",
11. "hot_wallet_quota": 20}
12. response = requests.post(url, params=get_parameters, data=json.dumps(post_parameters))
13. print(response.text)

Variables	Required	Experiment with a value
Hot wallet Bitcoin address where confirmed payments will be transferred	Required
Quota or amount Choose quota or specified amount for hot wallet	Required	hot wallet amount (in Satoshi) hot wallet quota (%)
Cold storage Bitcoin address where confirmed payments will be transferred	Required
Callback URL Your website URL with specified receiver page and optional extra GET parametrs	Required
Confirmations Number of accepted confirmations. Range 1-10, default 3.	Optional
Fee level Network fee level (optional field, default low).	Optional	low medium high
		Execute

Create smartcontract - payment distribution

That interface works like a "Create payment address", but received payment will be paid to list of addresses. Amount will be splitted up to 20 addresses by percent (quota).

If the sum of all shares is not 100%, then the shares are summed up and recalculated proportionally to the total amount.

Bitaps take 0.0002 BTC processing fee one time and execute it firstly.

 

See examples below (calculated without Bitcoin network and Bitaps fee):

Example 1

Payout 10 Btc to three addresses 15%, 50% and 35%. The sum of all shares 100%.

First address will get: 1.5 Btc.

Second: 5 Btc

Third: 3.5 Btc

 

Example 2

Payout 10 Btc to three addresses 10%, 20% and 30%. The sum of all shares 60%, but should be 100%.

In this case, service will sum all shares and takes their amount for 100%.

First address will get: 10 * 100 /(10+20+30) / 10 Btc = 1.66666667 Btc (rounding last digit)

Second: 20 * 100 /(10+20+30) / 10 Btc = 3.33333333 Btc

Third: 30 * 100 /(10+20+30 / 10 Btc) = 5 Btc

 

Example 3

Payout 10 Btc to three addresses 10%, 70% and 50%. The sum of all shares 130%, but should be 100%.

In this case, service will sum all shares and takes their amount for 100%.

First address will get: 10 * 100 /(10+70+50) / 10 Btc = 0,76923077 Btc (rounding last digit)

Second: 70 * 100 /(10+70+50) / 10 Btc = 5,38461538 Btc

Third: 50 * 100 /(10+70+50) / 10 Btc = 3,84615385 Btc

 

Request:

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

GET parametrs:

{callback}	Urlencoded callback URL
[confirmations]	Number of accepted confirmations (optional field, default 3)
[fee_level]	Miner fee level (optional field, default low)

POST parametrs:

{
  "type": "payment_distribution",
  "payment_distribution": [
    {"address": {address},
     "quota": {quota}},
    ... # up to 20 addresses
    ]
}

Response:

Query returns: Address, Payment Code and Invoice.
Address is a Bitcoin address to receive payments.
Payment Code is a private information and merchant should keep it in secret. This Code need for verification of callbacks.
Invoice could be sent to customer and also used for payment form.

 

Every transaction confirmation response doing callback to link as described in section Processing the callback.

Response example:

{
  "address": "1DVKXx53VBxrKdYbme6FQu9H1D7FuwYrH6",
  "payment_code": "PMTuxqSYWxUz2iXh4SWqEzR7dpkexN1ge6PDTYm28T3Qm8GisANq2",
  "invoice": "invPo4aFBGDXuRaWD2RfnEgWLQXiQ3qrueADCTkrnmgbxqLCF2hkR"
}

All three response parametrs you can find in our Block Explorer via search field or open as URL:

https://bitaps.com/1DVKXx53VBxrKdYbme6FQu9H1D7FuwYrH6

https://bitaps.com/PMTuxqSYWxUz2iXh4SWqEzR7dpkexN1ge6PDTYm28T3Qm8GisANq2

Query example:

1. <?php
2.   function post_api($url, $postfields) {
3.     $ch = curl_init();
4.     curl_setopt($ch, CURLOPT_URL, $url);
5.     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
6.     curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
7.     curl_setopt($ch, CURLOPT_POST, 1);
8.     curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields);
9.     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
10.     $result = curl_exec($ch);
11.     return $result;
12.   }
13.  
14.   $confirmations = 3;
15.   $callback = urlencode("http://www.test.me/addbalance.php?user=118");
16.   $fee = "low";
17.   $rules = [
18.     array('address'=>'18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov', 'qouta'=> 15),
19.     array('address'=>'39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9', 'qouta'=> 20),
20.     array('address'=>'1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P', 'qouta'=> 65)
21.   ];
22.   
23.   $postfields = json_encode(array('type'=>"payment_distribution", 'payment_distribution'=> $rules ));
24.   $data = post_api("https://bitaps.com/api/create/payment/smartcontract/". $callback . "?confirmations=" . $confirmations . "&fee_level=" . $fee, $postfields);
25.   echo $data;
26.   $respond = json_decode($data,true);
27.   $address = $respond["address"]; // Bitcoin address to receive payments
    
28.   $payment_code = $respond["payment_code"]; //Payment Code
29.   $invoice = $respond["invoice"]; // Invoice to view payments and transactions
30. ?>

1. rawurlencode() {
2. local string="${1}"
3. local strlen=${#string}
4. local encoded=""
5. local pos c o
7. for (( pos=0 ; pos<strlen ; pos++ )); do
8. c=${string:$pos:1}
9. case "$c" in
10. [-_.~a-zA-Z0-9] ) o="${c}" ;;
11. * ) printf -v o '%%%02x' "'$c"
12. esac
13. encoded+="${o}"
14. done 
15. REPLY="${encoded}"
16. }
18. rawurlencode "http://www.test.me/addbalance.php?user=118"
19. curl --data '{"type": "payment_distribution","payment_distribution": [{"address": "18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov","quota": 15},{"address": "39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9","quota":20},{"address": "1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P","quota":65}]}' https://bitaps.com/api/create/payment/smartcontract/${REPLY}?confirmations=3&fee_level=low'

1. import requests
2. import json
3. import urllib
5. callback = urllib.parse.urlencode({"r":"http://www.test.me/addbalance.php?user=118"})[2:]
6. url = 'https://bitaps.com/api/create/payment/smartcontract/%s' % callback
7. parameters = {"confirmations": 3,"fee_level":"low",
8. "payment_distribution": [{"address": "18fRLYWVMfQcVF2MpwYnvwmf4H9H2sPVov","quota": 15},
9. {"address": "39cjjxHTu7344mXExKb5SoDzbAoDWBpCj9","quota": 20},
10. {"address": "1TipsnxGEhPwNxhAwKouhHgTUnmmuYg9P","quota": 65}]}
11. response = requests.post(url, params=parameters, data=json.dumps(parameters))
12. print(response.text)

Variables	Type	Experiment with a value
Payout address №1 Bitcoin address where confirmed payments will be transferred	Required
Payout address №2 Bitcoin address where confirmed payments will be transferred	Required
Payout address №3 Bitcoin address where confirmed payments will be transferred	Optional
Callback URL Your website URL with specified receiver page and optional extra GET parametrs	Required
Confirmations Number of accepted confirmations. Range 1-10, default 3.	Optional
Fee level Network fee level (optional field, default low).	Optional	low medium high
		Execute

Processing the callback

Blockchain ledger API

Blocks

Get block

Request

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

Parameters:

{block_height | block_hash}

block height or block hash

Response:

{
  "height": {block height},
  "hash": {"block hash"},
  "previous_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}
}

Query example:

1. <?php
2.   $block = "420000";
3.   $data = file_get_contents("https://bitaps.com/api/block/". $block);
4.   echo $data;
5.   $respond = json_decode($data,true);
6.   $height = $respond["height"]; // Block number
   
7.   $hash = $respond["hash"]; //Block hash
   
8.   $previous_block_hash = $respond["previous_block_hash"]; // Previuos block hash
9.   $next_block_hash = $respond["next_block_hash"]; // Next block hash
   
10.   $merkleroot = $respond["merkleroot"]; // Merkle root
    
11.   $coinbase = $respond["coinbase"]; // Coinbase message
12.   $miner = $respond["miner"]; // Miner name
    
13.   $version = $respond["version"]; // Version of Block
    
14.   $transactions = $respond["transactions"]; // Quantity of transactions
15.   $size = $respond["size"]; //Block size in bytes
16.   $bits = $respond["bits"]; // Block bits
17.   $nonce = $respond["nonce"]; // Nonce number
    
18. ?>

1. curl https://bitaps.com/api/block/420000

1. import requests
3. response = requests.get("https://bitaps.com/api/block/420000)
4. print(response.text)

Variables	Required	Experiment with a value
Block height or Block hash Number of block or hash of block in blockchain network.	Required
		Execute

Get latest block

Request

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

Response:

{
  "height": {block height},
  "hash": {"block hash"},
  "previous_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}
}

Query example:

1. <?php
2.   $data = file_get_contents("https://bitaps.com/api/block/latest");
3.   echo $data;
4.   $respond = json_decode($data,true);
5.   $height = $respond["height"]; // Block number
   
6.   $hash = $respond["hash"]; //Block hash
   
7.   $previous_block_hash = $respond["previous_block_hash"]; // Previuos block hash
8.   $next_block_hash = $respond["next_block_hash"]; // Next block hash
   
9.   $merkleroot = $respond["merkleroot"]; // Merkle root
   
10.   $coinbase = $respond["coinbase"]; // Coinbase message
11.   $miner = $respond["miner"]; // Miner name
    
12.   $version = $respond["version"]; // Version of Block
    
13.   $transactions = $respond["transactions"]; // Quantity of transactions
14.   $size = $respond["size"]; //Block size in bytes
15.   $bits = $respond["bits"]; // Block bits
16.   $nonce = $respond["nonce"]; // Nonce number
    
17. ?>

1. curl https://bitaps.com/api/block/latest

1. import requests
3. response = requests.get("https://bitaps.com/api/block/latest")
4. print(response.text)

Execute

Get block transactions

Request

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

Parameters:

{block_height | block_hash}

block height or block hash

Response:

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

Query example:

1. <?php
2.   $block = "1";
3.   $data = file_get_contents("https://bitaps.com/api/block/transactions/". $block);
4.   echo $data;
5.   $respond = json_decode($data,true); // Array of transactions
6. ?>

1. curl https://bitaps.com/api/block/transactions/1

1. import requests
3. response = requests.get("https://bitaps.com/api/block/transactions/1")
4. print(response.text)

Variables	Required	Experiment with a value
Block height or Block hash Number of block or hash of block in blockchain network.	Required
		Execute

Transactions

Get transaction info

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

Parameters:

{tx_hash}

transaction hash

Response:

{
  "hash": "{transaction hash}",
  "data": "{transaction data hex}",
  "coinbase": {true | false},
  "block": {block_height} | null,
  "version": {version},
  "size": {size in bytes},
  "timestamp": {received timestamp},
  "input":
    [
      {
      "input_index": {input number},
      "sequence": {sequence},
      "hash": "{input transaction hash}",
      "out_index": {input transaction output index},
      "amount": {amount in Satoshi},
      "address": ["{address}",...],
      "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,
        }
      },
      ...
    ]
  "output":
    [
      {
      "output_index": {output index},
      "amount": {output amount},
      "address": ["{address}",...],
      "script": {
        "type": "{script type}",
        "hex": "{script hex}",
        "asm": "{script asm}",
        "pattern": "{script pattern}",
        }
      },
      ...
    ]
}

Query example:

1. <?php
2.   $tx = "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b";
3.   $data = file_get_contents("https://bitaps.com/api/transaction/". $tx);
4.   echo $data;
5.   $respond = json_decode($data,true); // Array of transactions
6. ?>

1. curl https://bitaps.com/api/transaction/4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b

1. import requests
3. response = requests.get("https://bitaps.com/api/transaction/4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b")
4. print(response.text)

Variables	Required	Experiment with a value
tx_hash Transaction hash	Required
		Execute

Get raw transaction

Request

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

Parameters:

{tx_hash}

transaction hash

Response:

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

Query example:

1. <?php
2.   $tx = "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b";
3.   $data = file_get_contents("https://bitaps.com/api/raw/transaction/". $tx);
4.   echo $data;
5.   $respond = json_decode($data,true); // Array of transactions
6.   $hash = $respond["hash"]; //Transaction hash
7.   $hex = $respond["hex"]; //Raw transaction in hex representation
8. ?>

1. curl https://bitaps.com/api/raw/transaction/4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b

1. import requests
3. response = requests.get("https://bitaps.com/api/raw/transaction/4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b")
4. print(response.text)

Variables	Required	Experiment with a value
tx_hash Transaction hash	Required
		Execute

Addresses

Get address info

Request

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

Parameters:

{address}

address

Response:

{
  "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}
}

Query example:

1. <?php
2.   $address = "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa";
3.   $data = file_get_contents("https://bitaps.com/api/address/". $address);
4.   echo $data;
5.   $respond = json_decode($data,true); // Response array
6. ?>

1. curl https://bitaps.com/api/address/1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

1. import requests
3. response = requests.get("https://bitaps.com/api/address/1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa")
4. print(response.text)

Variables	Required	Experiment with a value
address Address compressed or uncompressed. Mainchain only.	Required
		Execute

Get address transactions

Request:

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

Parameters:

{address}	address
{offset}	optional, offset list, response records limit 100, default 0
{all | sent | received | multisig}	optional, transactions type, default all
{all | confirmed | unconfirmed | invalid}	optional, transactions status, default all

Response:

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

Query example:

1. <?php
2.   $address = "1PUiNwFn6oJpYsmyR6HEyn5wiroUbjDiob";
3.   $offset = 0;
4.   $type = "all";
5.   $status = "all";
6.   $data = file_get_contents("https://bitaps.com/api/address/transactions/". $address. "/" . $offset. "/" . $type. "/" . $status);
7.   $respond = json_decode($data,true); // Array of transactions
8. ?>

1. curl https://bitaps.com/api/address/transactions/1PUiNwFn6oJpYsmyR6HEyn5wiroUbjDiob/0/all/all

1. import requests
3. response = requests.get("https://bitaps.com/api/address/transactions/1PUiNwFn6oJpYsmyR6HEyn5wiroUbjDiob/0/all/all")
4. print(response.text)

Variables	Required	Experiment with a value
address Specified address	Required
offset Offset list, response records limit 100. Default: 0	Optional
transactions type Variants: all, sent, received, multisig Default: all	Optional	all sent received multisig
current transaction status Variants: all, confirmed, unconfirmed, invalid. Default: all	Optional	all confirmed unconfirmed invalid
		Execute

Blockchain network API

Network difficulty

Get current Bitcoin network difficulty request:

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

Response:

{
  "difficulty": {difficulty}
}

Query example:

1. <?php
2.   $data = file_get_contents("https://bitaps.com/api/difficulty");
3.   echo $data;
4.   $respond = json_decode($data,true);
5.   $difficulty = $respond["difficulty"]; // Network difficulty
   
6. ?>

1. curl https://bitaps.com/api/difficulty

1. import requests
3. response = requests.get("https://bitaps.com/api/difficulty")
4. print(response.text)

Execute

Network hashrate

Get bitcoin network hashrate (last 24h) request:

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

Response:

{
  "hashrate": "{hashrate}"
}

Query example:

1. <?php
2.   $data = file_get_contents("https://bitaps.com/api/hashrate");
3.   echo $data;
4.   $respond = json_decode($data,true);
5.   $hashrate = $respond["hashrate"]; // Network hashrate for last 24h
   
6. ?>

1. curl https://bitaps.com/api/hashrate

1. import requests
3. response = requests.get("https://bitaps.com/api/hashrate")
4. print(response.text)

Execute

Average block time

Get bitcoin network average block time (last 24h) request:

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

Response:

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

Query example:

1. <?php
2.   $data = file_get_contents("https://bitaps.com/api/blocktime");
3.   echo $data;
4.   $respond = json_decode($data,true);
5.   $blocktime = $respond["blocktime"]; // Network average block time for last 24h
   
6. ?>

1. curl https://bitaps.com/api/blocktime

1. import requests
3. response = requests.get("https://bitaps.com/api/blocktime")
4. print(response.text)

Execute

Average block size

Get bitcoin network average block size (last 24h) request:

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

Response:

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

Query example:

1. <?php
2.   $data = file_get_contents("https://bitaps.com/api/blocksize");
3.   echo $data;
4.   $respond = json_decode($data,true);
5.   $blocksize = $respond["blocksize"]; // Network average block size for last 24h
   
6. ?>

1. curl https://bitaps.com/api/blocksize

1. import requests
3. response = requests.get("https://bitaps.com/api/blocksize")
4. print(response.text)

Execute

Transactions per second rate

Get bitcoin network transactions per second rate (last 24h) request:

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

Response:

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

Query example:

1. <?php
2.   $data = file_get_contents("https://bitaps.com/api/txrate");
3.   echo $data;
4.   $respond = json_decode($data,true);
5.   $txrate = $respond["txrate"]; // Network transactions per second rate for last 24h
   
6. ?>

1. curl https://bitaps.com/api/txrate

1. import requests
3. response = requests.get("https://bitaps.com/api/txrate")
4. print(response.text)

Execute

Network transaction fee

Get bitcoin network fee priority, request:

Transaction fee is calculated by statistical analysis from the last 36 blocks. Satoshi per byte.

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

Response:

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

Query example:

1. <?php
2.   $data = file_get_contents("https://bitaps.com/api/fee");
3.   echo $data;
4.   $respond = json_decode($data,true);
5.   $high_fee = $respond["high"]; // high priority fee
6.   $medium_fee = $respond["medium"]; // medium priority fee
7.   $low_fee = $respond["low"]; // low priority fee
8. ?>

1. curl https://bitaps.com/api/fee

1. import requests
3. response = requests.get("https://bitaps.com/api/fee")
4. print(response.text)

Execute

Visual API

Graphical bitcoin clients should register themselves as the handler for the "bitcoin:" URI scheme by default, if no other handler is already registered. If there is already a registered handler, they MAY prompt the user to change it once when they first run the client.

This section is non-normative and does not cover all possible syntax. Please see the BNF grammar above for the normative syntax.

[foo] means optional, <bar> are placeholders

bitcoin:<address>[?amount=<amount>][?label=<label>][?message=<message>]

Characters must be URI encoded properly.

Examples

Just the address:

 bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W  

Address with name:

 bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?label=Luke-Jr  

Request 20.30 BTC to "Luke-Jr":

 bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?amount=20.3&label=Luke-Jr  

Request 50 BTC with message:

 bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?amount=50&label=Luke-Jr&message=Donation%20for%20project%20xyz  

Some future version that has variables which are (currently) not understood and required and thus invalid:

 bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?req-somethingyoudontunderstand=50&req-somethingelseyoudontget=999  

Some future version that has variables which are (currently) not understood but not required and thus valid:

 bitcoin:175tWpb8K1S7NmH4Zx6rewF9WQrcZv245W?somethingyoudontunderstand=50&somethingelseyoudontget=999  

 

QR code must be in black and white colors. If colors are different, then recognizing speed will be low or code will be unreadable.

QR code in SVG text format

Get QR code for message or address, request:

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

Parameters:

{message}

urlencoded message, maximum 256 symbols

Response:

You will get SVG (vector graphics) text format in Base64.

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

Query example:

1. <?php
2.   $message = "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa";
3.   $data = file_get_contents("https://bitaps.com/api/qrcode/". $message);
4.   echo $data;
5.   $respond = json_decode($data,true);
6.   $qrcode = $respond["qrcode"]; // QR code in base64 encoded svg format
7. ?>

1. curl https://bitaps.com/api/qrcode/1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

1. import requests
3. response = requests.get("https://bitaps.com/api/qrcode/1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa")
4. print(response.text)

Variables	Required	Experiment with a value
QR code message Use Bitcoin address or URL. Urlencoded message, maximum 256 symbols	Required
		Execute

QR code image in PNG format

Get QR code for message or address, request:

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

Parameters:

{message}

urlencoded message, maximum 256 symbols

Response:

As a result you will get PNG image that you can include into web page or save as image file for future.

Query example:

1. <?php
2.   echo '<img src="https://bitaps.com/api/qrcode/png/'. urlencode( '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa' ) .'">' ;
3. ?>

1. curl https://bitaps.com/api/qrcode/png/1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

1. import requests
2. import urllib
4. message = urllib.parse.urlencode("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
5. response = requests.get("https://bitaps.com/api/qrcode/png/%s" % )
6. print(response.text)

Variables	Required	Experiment with a value
QR code message Use Bitcoin address or URL. Urlencoded message, maximum 256 symbols	Required
		Execute

Market API

Exchange rate

Interface return current Bitcoin exchange rate by three main exchange markets: Bitstamp.net, Bitfinex.com, Coinbase.com or average of these rates in USD. Currencies: Euro, Russian Rubles and Chinese Yean are derived from the value of the Dollar by official Moscow Exchange (http://moex.com/).

Request:

GET	https://bitaps.com/api/ticker[/{bitstamp | bitfinex | coinbase | average}]

Parameters:

{bitstamp | bitfinex | coinbase | average}

optional, market name, default = average

Response:

{
  "usd": "{usd/btc rate}",
  "fx_rates":
  {
    "eur": "{eur/btc rate}",
    "rub": "{rub/btc rate}",
    "cny": "{cny/btc rate}",
  },
  "market": "{bitstamp | bitfinex | coinbase | average}",
  "timestamp": "{timestamp}"
}

Query example:

1. <?php
2.   $market = "average";
3.   $data = file_get_contents("https://bitaps.com/api/ticker/". $market);
4.   echo $data;
5.   $respond = json_decode($data,true);
6.   $usd = $respond["usd"]; // Exchange rate Bitcoin to USD
7.   $eur = $respond["fx_rates"]["eur"]; // Exchange rate Bitcoin to EUR is derived from the value of the USD
8.   $rub = $respond["fx_rates"]["rub"]; // Exchange rate Bitcoin to RUB is derived from the value of the USD
9.   $cny = $respond["fx_rates"]["cny"]; // Exchange rate Bitcoin to CNY is derived from the value of the USD
10. ?>

1. curl https://bitaps.com/api/ticker/average

1. import requests
3. response = requests.get("https://bitaps.com/api/ticker/average")
4. print(response.text)

Variables	Required	Experiment with a value
exchange market Variants: bitstamp, bitfinex, coinbase, average Default: average	Optional	average bitstamp bitfinex coinbase
		Execute

Exchange history

Get bitcoin history exchange rate request:

GET	https://bitaps.com/api/price/history/{timstamp}/[{bitstamp | bitfinex | coinbase | average}]

Parameters:

{timestamp}	Unix timestamp
{bitstamp | bitfinex | coinbase | average}	optional, market name, default = average

Response:

{
  "usd": "{usd/btc rate}",
  "fx_rates":,
  {
    "eur": "{eur/btc rate}",
    "rub": "{rub/btc rate}",
    "cny": "{cny/btc rate}",
  },
  "market": "{bitstamp | bitfinex | coinbase | average}",
  "timestamp": "{timestamp}"
}

Query example:

1. <?php
2.   $timestamp = "1476364290";
3.   $market = "average";
4.   $data = file_get_contents("https://bitaps.com/api/price/history/". $timestamp. "/" . $market );
5.   echo $data;
6.   $respond = json_decode($data,true);
7.   $usd = $respond["usd"]; // Exchange rate Bitcoin to USD
8.   $eur = $respond["fx_rates"]["eur"]; // Exchange rate Bitcoin to EUR is derived from the value of the USD
9.   $rub = $respond["fx_rates"]["rub"]; // Exchange rate Bitcoin to RUB is derived from the value of the USD
10.   $cny = $respond["fx_rates"]["cny"]; // Exchange rate Bitcoin to CNY is derived from the value of the USD
11. ?>

1. curl https://bitaps.com/api/price/history/1476364290/average
   

1. import requests
3. response = requests.get("https://bitaps.com/api/price/history/1476364290/average")
4. print(response.text)

Variables	Required	Experiment with a value
timestamp Unix timestamp	Required
exchange market Variants: bitstamp, bitfinex, coinbase, average Default: average	Optional	average bitstamp bitfinex coinbase
		Execute