Bisq public webservice APIs:

Version: bisq-webservice-api-0.9.11

Error responses are documented here.
/api/depth
Provides list of open offer prices for a single market.

Sample Request

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

/api/hloc
Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.

Sample Request

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

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

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

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

See Also

/api/ticker
Provides 24 hour price ticker for single market or all markets

Sample Request

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

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

/api/trades
Provides list of completed trades for a single market.

Sample Request

Sample Response

[ { "direction": "SELL", "price": "562.51610000", "amount": "0.30000000", "trade_id": "df7bd928-2940-4524-90cf-8dc5717fcad8", "trade_date": 1472947568822 }, { "direction": "SELL", "price": "552.48340000", "amount": "0.20000000", "trade_id": "e9b4f424-61b1-494a-bd1e-9142ce65b1d4", "trade_date": 1472937060362 } ]

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

/api/volumes
Provides periodic volume data in terms of base currency for one or all markets.

Sample Request

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

Error Responses

Any errors such as invalid parameters will be in the following format

{ "success": 0, "error": "market parameter missing" }