Install An Adapter
To install an adapter connecting to an exchange that is not installed by default:
- Open Settings⟶Manage plugins and install the adapter
- Under Connections⟶Configure add the new connection
- To trade, also input your API key and secret. See below for instructions.
Should you encounter a problem with an adapter, please report it in the Supported connections forum section.
See the Request a connection forum section to request new adapters.
API keys and secrets are used only to authenticate yourself with the exchange's API servers. They are not shared with any Bookmap's servers.
Install A Crypto Adapter
Functionality & Requirements
Most adapters are designated as alpha. It means that although they have been used for a while, we are still testing them and some issues might appear. Shall you encounter any problems, please, report them or request new ones in the "Supported Connections" section of our Forum.
Some of them are already available in the External Plugins Manager (Settings ⟶ Manage plugins).
Binance (Spot)
No credentials are required to observe the market data. To be able to trade:
- Create an API key & secret pair under Binance API management settings (make sure to check Enable Trading if you're going to trade).
- In Bookmap, insert them under Connections -> Configure.
See the Bookmap Binance forum section for changelog, to report issues, and request new features.
Binance Futures
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret pair under Binance API management settings (make sure to check Enable Trading and Enable Futures).
- In Bookmap, insert them under Connections -> Configure.
See the Bookmap Binance forum section for changelog, to report issues, and request new features.
Bitfinex
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret; see instructions on Bitfinex API Key Setup & Login. Check all Read check boxes. For Write check boxes, check Orders and Trading.
- In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap Bitfinex forum section for changelog, to report issues, and request new features.
BitFlyer
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret in the Bitflyer Developer page (check all Assets and Trading permissions).
- In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap BitFlyer forum section for changelog, to report issues, and request new features.
BitMEX
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret in the BitMEX API keys page (select Order key permissions).
- In Bookmap, under Connections -> Configure, insert your newly created API key to the Username field, and the API secret to the Password field.
See the Bookmap BitMEX forum section for changelog, to report issues, and request new features.
Bitstamp
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret in the Bitstamp API keys page (select all General and Orders key permissions).
- In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap Bitstamp forum section for changelog, to report issues, and request new features.
Bittrex
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret; see instructions at How to create a Bittrex API key. Toggle on READ INFO and TRADE.
- In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap Bitstamp forum section for changelog, to report issues, and request new features.
Bybit
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret; see instructions at How to create a Bybit API key. Select
API Transaction
and in theKey Permission
field chooseActive Order and Positions
. - In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
Note: If you do not bind any IP addresses to your API key, it will be valid for 3 months. After this period you will need to create a new API key. This is a limitation at the Bybit side that intends to improve security.
See the Bookmap Bybit forum section for changelog, to report issues and, request new features.
Deribit
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret in the Deribit API keys page. Set the following scopes:
account: read, trade: read_write, wallet: read, others: none
. Note that here, Client Id means API Key. - In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap Deribit forum section for changelog, to report issues, and request new features.
HitBTC
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret under HitBTC API keys settings (make sure to check Order book, History, Trading balance, and Place/cancel orders if you're going to trade).
- In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap HitBTC forum section for changelog, to report issues, and request new features.
Kraken (Spot)
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret, see instructions on How to generate an API key pair (make sure to check Query Funds, Access WebSockets API, and all checkboxes under Orders & Trades).
- In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap Kraken forum section for changelog, to report issues, and request new features.
Kraken Futures
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret, see instructions on How to generate an API key pair (make sure to check Query Funds, Access WebSockets API, and all checkboxes under Orders & Trades).
- In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap Kraken forum section for changelog, to report issues, and request new features.
KuCoin
API credentials are required to observe the market data. Trading is not supported yet.
- Create an API key, secret and passphrase under KuCoin API management settings (no need to enable the "Trade" or the "Transfer" checkboxes).
- In Bookmap, insert them under Connections -> Configure.
Note that spot and futures have separete credentials that you must create.
See the Bookmap KuCoin forum section for changelog, to report issues, and request new features.
OKEx
No credentials are required to observe the market data. Currently, trading is not supported.
See the Bookmap OKEx forum section for changelog, to report issues, and request new features.
Poloniex
No credentials are required to observe the market data. To be able to trade:
- Create an API key and secret in the Poloniex API keys page (make sure to check Enable Trading).
- In Bookmap, under Connections -> Configure, insert your newly created API key and secret.
See the Bookmap Poloniex forum section for changelog, to report issues, and request new features.