API documentation
BitWhisk provides a simple public REST API to allow you to programatically use our service in send-receive mode. The base url is https://bitwhisk.io/api. All requests use the application/json content type and go over https. All requests are GET requests and all responses come in JSON format. Always check the success flag to ensure that your API call succeeded.

We are currently restricting to 5 calls to our API procedures per minute (no burst). If you are affected by these limits, please contact our team via contact@bitwhisk.io. We reserve the right to switch to using API keys.

Below is the description of available API calls.

/discount

This is a short procedure used to define a discount on service commission for the given BitWhisk code.

Input format

ParameterRequiredDescription
coderequireda 6-digit string representing a valid BitWhisk code

Request example

https://bitwhisk.io/api/discount?code=abcdef

Response

{
    "success" : true,
    "error"   : "",
    "result"  : {
                    "discount" : 0,
                    "minServiceCommission" : 0.5
                }
}

/order

This is a procedure used to create mixing orders.

Input format

ParameterRequiredDescription
codeoptionala 6-digit string representing a valid BitWhisk code, if not present the system will generate a code for you
commissionoptionala float number with no more than four digits after a point, if not present the system will randomly choose a commission between 0.5 and 3%
minerRateoptionalan integer between 1 and 999, represents a miner's fee rate our service will use for output transactions, if not present the system will choose an optimal one
address0requireda string representing a valid Bitcoin address you will receive funds on
delay0requiredan integer between 0 and 48, representing delay time for address0
share0optionalan integer between 1 and 99, representing share of the outcome which needs to be sent to address0, if not present the system will interpret your order as containing only address0 as output address
...
address9optionala string representing a valid Bitcoin address you will receive funds on
delay9optionalan integer between 0 and 48, representing delay time for address9
share9optionalan integer between 1 and 99, representing share of the outcome which needs to be sent to address9

Request example

https://bitwhisk.io/api/order?address0=1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa&delay0=0

Response

{
    "success" : true,
    "error"   : "",
    "result"  : {
                    "minInputAmount" : 0.00046574,
                    "maxInputAmount" : 3.43162733,
                    "inputAddress" : "3LfhEyqC42on8YhbtwfPFwbZtyWGduxJ4D",
                    "code" : "abcdef",
                    "commission" : 1.2345,
                    "minerRate" : 15,
                    "letter" : {
                                    "signingBitcoinAddress" : "1BWhisku6FmdcWk776vrqb2KHs88r5oicp",
                                    "message" : "We hereby confirm that WWW.BITWHISK.IO has generated the address ...",
                                    "digitalSignature" : H/Jjp5rk+ksObPDf/epM4SjIZL5JmYcjA6ZRg6LxG/9dBdUPhcVbeGEy4MLjzBPrVQn89IKQoWkeCxoRxsfepzc="
                               }
                }
}
                

Found a bug? Have any questions or suggestions regarding our API? You may contact us any time via contact@bitwhisk.io or post to our official bitcointalk thread.