Bisq public webservice APIs: Version: bisq-webservice-api-0.9.14 currencies

depth

hloc

markets

offers

ticker

trades

volumes Error responses are documented Error responses are documented here

/api/currencies Provides list of available currencies for a given base currency. Sample Request https://bisq.markets/api/currencies Sample Response { "AED": { "code": "AED", "name": "United Arab Emirates Dirham", "precision": 8, "type": "fiat" }, "AIB": { "code": "AIB", "name": "Advanced Internet Blocks", "precision": 8, "type": "crypto" }, ... } Parameters param desc required values default basecurrency base currency identifier No BTC type type of currencies to include in results No crypto | fiat | all all format format of return data No json | jsonpretty jsonpretty Notes In practice, the same currencies are available for every basecurrency so this API can be called just once, omitting the basecurrency parameter.

/api/depth Provides list of open offer prices for a single market. Sample Request https://bisq.markets/api/depth?market=xmr_btc Sample Response { "xmr_btc": { "buys": [ "0.01432700", "0.01403166", "0.01403018", ], "sells": [ "0.01523659", "0.01523956", ] } } Parameters param desc required values default market market identifier Yes format format of return data No json | jsonpretty jsonpretty See Also offers

/api/hloc Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart. Sample Request https://bisq.markets/api/hloc?market=xmr_btc Sample Response [ { "period_start": 1463875200, "open": "0.00198039", "high": "0.00198039", "low": "0.00180809", "close": "0.00180809", "volume_left": "528.73200000", "volume_right": "1.04300000", "avg": "0.00197264" }, ... { "period_start": 1472342400, "open": "0.00982318", "high": "0.01911520", "low": "0.00982318", "close": "0.01530002", "volume_left": "3412.86880000", "volume_right": "47.21000000", "avg": "0.01383294" } ] Parameters param desc required values default market market identifier Yes interval length of time blocks to summarize. auto will pick appropriate interval based on total time range No minute | half_hour | hour | half_day | day | week | month | year | auto auto timestamp_from start time, in seconds since 1970 No 2016-01-01 timestamp_to end time, in seconds since 1970 No now format format of return data. csv provides the most compact format. No csv | json | jsonpretty jsonpretty

/api/markets Provides list of available markets. Sample Request https://bisq.markets/api/markets Sample Response { "1cr_btc": { "pair": "1cr_btc", "lname": "1CRedit", "rname": "Bitcoin", "lsymbol": "1CR", "rsymbol": "BTC", "lprecision": 8, "rprecision": 8, "ltype": "crypto", "rtype": "crypto", "name": "1CRedit\/Bitcoin" }, "btc_aud": { "pair": "btc_aud", "lname": "Bitcoin", "rname": "Australian Dollar", "lsymbol": "BTC", "rsymbol": "AUD", "lprecision": 8, "rprecision": 2, "ltype": "crypto", "rtype": "fiat", "name": "Bitcoin\/Australian Dollar" }, ... } Parameters param desc required values default format format of return data No json | jsonpretty jsonpretty

/api/offers Provides list of open offer details for a single market. Sample Request https://bisq.markets/api/offers?market=xmr_btc Sample Response { "xmr_btc": { "buys": [ { "offer_id": "b2ab53d4-8ffd-4138-aa8a-c7143d7fb123_0.4.9.4", "offer_date": 1472239477119, "direction": "BUY", "min_amount": "0.10000000", "amount": "6.77840000", "price": "0.01475266", "volume": "0.10000000", "payment_method": "BLOCK_CHAINS", "offer_fee_txid": "64ae7b5863c509ed0cb5ef9ec3ec4a197b4f77705fc7b2d3b82fb96bc3f3e872" }, ... ], "sells": [ { "offer_id": "6a31771b-3c1b-49f4-b403-12f8749646fa_0.4.9.4", "offer_date": 1472570540023, "direction": "SELL", "min_amount": "0.40000000", "amount": "25.54280000", "price": "0.01565994", "volume": "0.40000000", "payment_method": "BLOCK_CHAINS", "offer_fee_txid": "ee0bd1d55ba37bf14de59fd6a42263200b6485d2d5aff493ffeb82513c0b2637" }, ... ] } } Sample Request https://bisq.markets/api/offers?market=xmr_btc&direction=BUY Sample Response { "xmr_btc": { "buys": [ { "offer_id": "b2ab53d4-8ffd-4138-aa8a-c7143d7fb123_0.4.9.4", "offer_date": 1472239477119, "direction": "BUY", "min_amount": "0.10000000", "amount": "6.68520000", "price": "0.01495824", "volume": "0.10000000", "payment_method": "BLOCK_CHAINS" "offer_fee_txid": "64ae7b5863c509ed0cb5ef9ec3ec4a197b4f77705fc7b2d3b82fb96bc3f3e872" }, ... ], "sells": null } } Parameters param desc required values default market market identifier Yes direction offer direction, omit or set null for both No BUY | SELL null format format of return data No json | jsonpretty jsonpretty Notes payment_method in response will be one of: OK_PAY, PERFECT_MONEY, SEPA, NATIONAL_BANK, SAME_BANK, SPECIFIC_BANKS, SWISH, ALI_PAY, CLEAR_X_CHANGE, US_POSTAL_MONEY_ORDER, CASH_DEPOSIT, BLOCK_CHAINS

payment_method values are defined in this file: https://github.com/bitsquare/bitsquare/blob/master/core/src/main/java/io/bitsquare/payment/PaymentMethod.java

offer_fee_txid in response is the offer fee transaction ID in the bitcoin block chain

offer_date in response is provided in milliseconds since 1970, not seconds. To get seconds, divide by 1000 See Also depth

/api/ticker Provides 24 hour price ticker for single market or all markets Sample Request https://bisq.markets/api/ticker?market=btc_eur Sample Response { "btc_eur": { "last": "524.17550000", "high": "529.56210000", "low": "510.20000000", "volume_left": "2.76560000", "volume_right": "1454.42950000", "buy": "513.88580000", "sell": "529.17120000" } } Sample Request https://bisq.markets/api/ticker Sample Response { "1cr_btc": null, "btc_aud": { "last": "728.89000000", "high": "728.89000000", "low": "728.89000000", "volume_left": 0, "volume_right": 0, "buy": null, "sell": null }, "btc_eur": { "last": "524.17550000", "high": "529.56210000", "low": "510.20000000", "volume_left": "2.76560000", "volume_right": "1454.42950000", "buy": "513.88580000", "sell": "529.17120000" }, "xmr_btc": { "last": "0.01437401", "high": "0.01530723", "low": "0.01437401", "volume_left": "269.79720000", "volume_right": "4.00000000", "buy": "0.01427006", "sell": "0.01545144" } } Parameters param desc required values default market market identifier No format format of return data No json | jsonpretty jsonpretty Notes the response data can indicate the following market states: never traded, traded prior to 24 hours, traded within 24 hours

a null value for a market key indicates 'never traded'

volume_left or volume_right is 0 indicates 'traded prior to 24 hours'

volume_left or volume_right is > 0 indicates 'traded within 24 hours'

buy represents the highest buy offer at present, sell represents the lowest sell offer at present

either buy or sell may be null if there are not presently any respective offers

/api/trades Provides list of completed trades for a single market. Sample Request https://bisq.markets/api/trades?market=btc_eur&limit=2 Sample Response [ { "direction": "SELL", "price": "2375.72500000", "amount": "0.05000000", "volume": "118.78620000", "payment_method": "SEPA", "trade_id": "BLBJHGL-b644851d-f822-418a-8035-955f7a02eff9-051", "trade_date": 1501095828824 }, { "direction": "SELL", "price": "2148.50230000", "amount": "0.20000000", "volume": "429.70040000", "payment_method": "SEPA", "trade_id": "dcwyx9-1a89dece-5039-4ff7-89c9-7ed52b84bc88-051", "trade_date": 1501088841011 } ] Parameters param desc required values default market market identifier Yes <market pair> | all format format of return data No json | jsonpretty jsonpretty timestamp_from start time, in seconds since 1970 No 2016-01-01 timestamp_to end time, in seconds since 1970 No now trade_id_from identifies first trade to include No trade_id_to identifies last trade to include No direction trade direction: buy or sell. omit or leave null for both. No buy | sell limit maximum trades to return. max is 2000. No 100 sort Sort by date No asc | desc desc Notes trade_date in response is provided in milliseconds since 1970, not seconds. To get seconds, divide by 1000

if the market parameter is "all" then up to limit trades will be returned, date sorted, across all markets. Also a "market" field is added to each trade result.

this api will return a maximum of 2000 trades per call

if trade_id_from or trade_id_to is used and a matching trade is not found for each, then no results are returned

The Bisq app does not presently use a trade_id internally. The trade_id in this api is actually the bisq offerId.

Possible values for payment_method can change over time. For most current, see PaymentMethod.java

/api/volumes Provides periodic volume data in terms of base currency for one or all markets. Sample Request https://bisq.markets/api/volumes?basecurrency=BTC Sample Response [ { "period_start": 1451606400, "volume": "1128.38570000", "num_trades": 2009 }, { "period_start": 1483228800, "volume": "1322.77960000", "num_trades": 2376 } ] Parameters param desc optional values default basecurrency base currency identifier. Yes market market identifier. Yes interval length of time blocks to summarize. auto will pick appropriate interval based on total time range No minute | half_hour | hour | half_day | day | week | month | year | auto auto timestamp_from start time, in seconds since 1970 No 2016-01-01 timestamp_to end time, in seconds since 1970 No now format format of return data. csv provides the most compact format. No csv | json | jsonpretty jsonpretty Notes A Base currency is a blockchain (eg Bitcoin) that is traded against other currencies utilizing the base currency's multisig capability. eg XMR/BTC, LTC/BTC, BTC/USD, and BTC/EUR all use the base currency BTC. In contrast, XMR/LTC, BTC/LTC, LTC/EUR, LTC/USD all use the base currency LTC.

Either basecurrency or market param must be specified.

basecurrency must be supported by Bisq app.

As of 2017-07-24, supported basecurrency are BTC, DOGE, LTC, DASH