Bookmap user guide

From Bookmap
Jump to: navigation, search

UserGuide.jpeg Bookmap logo.png Bookmap trading.png Facebook.jpg

Few words about Bookmap

Bookmap trading platform visualizes the market via heatmap chart. It covers Futures, US equities, and Digital Currencies.

Contents

Introduction[edit]

System Requirements[edit]

The following hardware and software specifications are the minimal requirements for installing and using Bookmap:

  • Windows Vista, 7, 8 and 10.
  • Minimum of 1280x960 display resolution.
  • Video card of minimum 512 MB memory supporting OpenGL 3 (introduced in 2008) or higher. To check which OpenGL version your system use, you can install an OpenGL extension viewer.
  • Minimum of 4GBRAM and 1 GB free disk space.
  • Intel Core i3 (or equivalent), 2.0 GHz or above+
  • Stable internet connection. Minimal speed 1Mb/sec
  • A mouse with a middle button is required for the one-click trading add-on feature.
  • .NET 3.5

Bookmap Main Window[edit]

The Bookmap Main Window is where you control your Bookmap active data connections and your instruments subscriptions. For more details on how to run Bookmap with your platform / infrastructure and view the instruments of your choice please refer to Section 3 “Running Bookmap”. Instruments added to the main window are added as separate tabs. Each instrument can be detached from the tab display and be presented as a separate window. To add a detached chart window back to the tab display, just close the detached window. The Bookmap Main Window has some useful setups and links described below:

File Menu[edit]


Bookmap File Menu
  • Show current log under File → Show log file. This might come in handy when trying to pinpoint operational problems. Previous sessions log files are kept in the user folder under the Logs folder.
  • User Folder. This folder stores the Bookmap log files, configuration files, feed files recorded during Bookmap sessions, saved screenshots of your Bookmap chart and more. To access the user folder go to File → Open user folder.
  • Workspace. Users can save their current workspace with all of the symbols subscriptions and settings. Bookmap will always open with the last saved workspace and subscribe to all the symbols in the workspace automatically. Users can save multiple workspaces and can open specific workspaces from the File menu on the Bookmap Main Window
  • Cross Instrument Trading. Bookmap enables traders to trade a mini or micro instrument (e.g. mini DAX futures) from the chart of the major instrument (e.g. DAX futures). To view the list of available cross instruments click File → List cross instrument trading pairs.
  • Data_Recording. The data refresh feature allows users to define when to reset the inflow of data and start the accumulation of data anew. To set data refreshes click File → Refresh Bookmap.
  • Alerts. List all generated voice alerts.
  • Export. Allows you to export data and order from Bookmap to a file. You can define which data and the specific time segment to export.


Connections[edit]


The Connections menu is where you setup the platforms and data feeds to which Bookmap connect.

Settings Menu[edit]


Bookmap File Menu

  • Setup options for colors, time zone used, restore configuration, control of chart refresh rate and rendering method. When Bookmap is connected through CQG Continuum, Rithmic and S5, the setting menu will also include an Account Info item. The account info panel displays different information relating to your account, such as P&L, trades history, open positions etc.)
  • Replay startup action. Defines which data file to load when starting Bookmap in Replay mode.
  • Load Recorded Orders
  • Order Confirmation. Defines which order types require trader’s confirmation prior to order submission.
  • Configuration
  • Memory Allocation

Help Menu[edit]


Bookmap File Menu

  • Under Help tab, click the Bookmap Portal to be redirected to the members portal on the Bookmap website.
  • If you wish to use your Bookmap copy on a different machine, click Help>>Deactivate to deactivate your current license. After the license has been deactivated simply install Bookmap on another machine and enter your license key once prompted to activate Bookmap on the new machine. In addition, when you open Bookmap on a new machine while having your license active on a different machine you will be prompted to either deactivate Bookmap on the currently active machine or terminate your attempt to open Bookmap on the new machine.
  • Click the User Guide menu item to get your current version user guide.
  • Click Updates to get the latest available version of Bookmap.
  • Click Symbols for a list of symbol formatting on different platforms compatible with Bookmap

Connecting Bookmap[edit]

Both live data modes allow connection to multiple platforms / APIs (depending on the platforms available on your licenses). To connect to any given platform or API select any of the live run modes. Make sure to tick the recording checkboxes if you want to record your data and orders for later analysis on the Replay mode.

Next click Connections tab and select configure. In the configuration window select the platform you want to add to your connections, add the relevant credentials for the selected platform. If the credentials are to a demo account then make sure to tick the demo account checkbox. Finally click Add Connection. You have now set a new connection. After adding all the connection you want click OK to close the configuration window.

Connectivity Configuration























Next click the Connections tab and tick any of the connections you want activate. Once active you will be able to subscribe to any of the instruments available through any of the active connections.

Connections.jpg













To add an instrument click the + sign at the top of the Bookmap main window to open the subscription window. On the subscription window select the relevant platform and type in (or select) the instrument you want to subscribe to.

Depending on the specific instrument the subscription window may include additional setup option, such as tick size and size granularity. In addition, you can load historical data when subscribing to an instrument. The length of available historical data depends on the specific market and your Bookmap plan. Bookmap can also load data your recorded for the specific instrument so you will not lose accumulated data if you Bookmap session is unexpectedly interrupted.

When you are done with subscription setup, click Subscribe to add the chart of the selected instrument to the Bookmap main window.

Subscribe Window
















All added connections will be kept in configuration until removed by the user so the process of adding and activating a connection does not have to be repeated in subsequent sessions of Bookmap.

Automatic update[edit]

Bookmap provides autoupdate capability. When new version is released you will usually be notified about it.

Gradual rollout[edit]

There is a gradual rollout procedure usually applied to beta builds. Exact parameters for each build are tuned on per-build basis, but general idea is that new builds are not deployed to everyone at once. This way if there is a significant issue - at least it won't hit everyone at the same time. If you are experiencing issues with a beta build, one option is to make sure you have the latest version.

If you want, you can opt-in for early builds, in order to do this check Help->Update->Get new builds early. This will inform the auto update system that you want to get builds before those who did not check this box.

Bookmap Offline Activation[edit]

Bookmap is capable to operate without an internet access using offline activation. This solution is mostly relevant for brokers, banks, institutional traders, and for Bookmap Quant Solution users who have internal network under a firewall. However, as for June 2018, offline activation is available for all Bookmap users.

How to activate offline[edit]

  • Start Bookmap
  • Once the internet connection warning appears, close it and click "Click to insert license key"
  • Insert your license key (use Ctrl+V to paste), click Activate.
  • The following message should appear. Follow its instructions:
    • Find "activation request.bin" file inside C:\Bookmap\Config folder, and send it to support@bookmap.com with subject including Offline Activation.
    • Place the file "activation response.bin" that you receive from support to the same folder, and start Bookmap

Offline activation.png

External connectivity adapters[edit]

Unless you have Bookmap Quant license, Bookmap will not be able to check the signature of external connectivity adapters which are located in C:\Bookmap\API\Layer0ApiModules folder. In order to use them with offline activation, click here to download permissions.bin file and place it in the above folder. Note: When using offline activation this file needs to be updated as above every time when any of external connectivity adapters is updated.

Limitations[edit]

  • It allows offline activation for the time period, supported by the license. For instance, 1 month in case of monthly subscription.
  • Real-time data connection obviously still requires internet access at least for the adapter (in case of custom Quant or Connect solutions)
  • Internet access is needed to send feedback or error reports from Bookmap itself

Operating Bookmap[edit]

Candlestick View[edit]

Bookmap uses a candlestick view of price that can be layered over the heat map view to combine the traditional price view with that of the market depth. The combined view can assist traders accustomed to candlestick with proper orientation and can also enhance traders trading by applying multiple discipline analysis.

To display candlestick click the studies icon above the chart and select candlestick bars. Set candlesticks attributes by clicking the candlesticks box in the studies panel and configure the relevant parameters on the right side of the studies panel. Available parameters are:

  • OHLC display based on trades or combination of trades and bid ask prices
  • Candlestick bar width and candlestick interval.
  • Layering of VWAP information relating to the candlestick specific time period

Bookmap with candlestick overlaid on the market depth heat map

Settings and Features[edit]

Chart contrast[edit]

Bookmap Contrast Configuration

An internal algorithm automatically adjusts the contrast of the order book heat map based on the maximum size on the order book and the distribution of pending orders at the different price levels.

Users can also determine how often Bookmap will adjust the heat map contrast. It can be set at predefined frequencies and at every time the chart recenters. To control these settings click the contrast icon above the chart and check the adjustment options you want to use.

In addition, users can control the contrast and brightness of the display by using the applicable sliders on the contrast settings window. For more control over the heat map display user can control white and black cut off and also define the degree of discernibility of price levels with relatively large number of pending orders.

White and black cut off define the sizes which will be displayed with a solid color reserved for representing the highest (and lowest) liquidity sizes on the order book (e.g. white or black in case of a gray scale heat map). The values of the cut off can be controlled by either a percentage slider or by manually entering an exact number of contracts. When the you enter an exact size of contracts Bookmap will assign a solid color to any price level with an equal or greater (or smaller) number of pending contracts, while price levels with smaller (or bigger) sizes will be assigned with varying color shades according to their relative size. If you use the percentage slider instead, Bookmap will assign a solid color to any value at or above (or below) the percentile you selected on the slider (e.g. if 95% is selected for the white cut-off in a gray scale heat map, Bookmap will assign a white color to the top 5% sizes in the order book; if 5% is set for the black cut-off, Bookmap will assign a black color to the bottom 5% sizes in the order book). Note that while exact size is an absolute value the sizes represented by percentile values keep changing as the order book changes.

Black cut off slider can be placed on the toolbar to save the need for using the contrast window. Check the Black cut off on toolbar to display the slider on the toolbar.

The slider Large Size Highlight controls the range of gray shade assigned to price levels with relatively larger size of pending orders. Use the higher end of the slider to make the differences between these price levels and other levels more distinguishable. This can help traders put more emphasis and focus on the more liquid levels in the order book.

Heat map Vertical Filter[edit]

Heat map Settings

To enable more flexibility in consuming the heat map at zoomed out (especially extreme zoom out) views, Bookmap enables users to apply a vertical filter to the heat map. To access the vertical filter options click the studies icon above the chart and select Heat map. The vertical filter setting will be on the right side of the window.

Choosing None will display the heat map without filters, whatever the zoom level is. Choosing Smoothing will apply a smoothing Gaussian filter to the heat map with whatever sigma pixel value the user defines. When choosing Auto, Bookmap will apply a Gaussian filter automatically based on the zoom level used.

Extended Order Book - by checking or unchecking the "Show extended Order Book" checkbox, users can also select whether or not to display an extended view of the order book. When checked, Bookmap will show price levels that are out of the exchange transmitted range. The values used for these extended levels will be the last transmitted values of these levels during the session.

Aggregate Order Book - normally, the heat map will display the size of each price level separately. When checking the "Aggregate Order Book" checkbox, the heat map will switch to accumulated display. Each price level will display the aggregate number of pending orders at that price level together with the total number of pending orders at all the preceding price levels.

Heat map with no vertical filter

Heat map with Gaussian filter

Heat map with aggregated order book


Depth Reset Configuration[edit]

The exchanges transmit data of limited number of price levels above and below the best ask and best bid. This is referred to as the market depth active range. The active range varies between exchanges and symbols. Since most data providers do not transmit the value of the active range Bookmap uses an internal algorithm to calculate the active range based on data update patterns. In addition, in contrast to most order book applications, Bookmap keeps record of the last update of out-of-range price levels and displays these values on the current order book (COB column) as well as on the heat map. This allows traders to keep track of the last known size of out of range price levels.
By using the Depth reset configuration, traders can control both the calculation of the active range and the display duration of inactive range, which will mostly be those that are out of range hence lacking exchange updates.
To access the depth reset configuration click the studies icon above the chart and select Heat map. The configuration options will be on the right side of the window: Keep all check boxes unchecked for no depth reset. Bookmap will keep displaying the last update of each price level.

Choose Reset inactive and set the number of minutes for the reset interval. Bookmap will reset price levels out of the active range for which no update was received during the last set number of minutes.

Choose Reset at the end of day to reset depth data of the out-of-active-range price levels at the end of the regular session. Note that this option is only available when connecting to a data provider that provides indication of the end of the trading session. Currently this applies only when Bookmap is connected to Rithmic. Click Reset Now to manually reset price levels that are out of the current active range.

To override the Bookmap calculated value of the Exchange active range, check the Override order book depth and set a lower number of levels to be considered as the active range. The active range will be marked with 2 horizontal lines on the COB column.

VWAP[edit]

To draw a VWAP line on the chart click the studies icon above the chart and check the VWAP checkbox. You can set the line color and reset interval for the VWAP line.

VWAP Configuration Panel


POC[edit]

The point of control (POC) is the price level that had the largest size of a measured activity during the sampled period. For example, if the measured activity is traded volume, POC will the price level at which the largest aggregate volume size was traded during the sampled period.
Bookmap supports POC indication for the Volume, Trade Counter and Quote Counter columns. The POC line is drawn on the chart and is session based (i.e. it cannot be activated when the column is based on the visible chart range). To draw the POC line, right click any of the 3 supported columns and select Format Column. On the column configuration window check the “Show POC on Chart” checkbox.

POC configuration window


Voice Alerts[edit]

Voice alerts are available for Iceberg detector and for large trade alerts. Both can be found under the studies panel. Click studies icon above the chart and choose either Iceberg Detector or Large Trade Alert and set the voice alerts on the right side of the panel.

Voice alerts.jpg


Drag Mode and Zoom in-out[edit]

  • To zoom in Bookmap chart, click the and buttons or use the mouse scrolling wheel.
  • Use the icon in the toolbar to scroll the chart sideways. When drag mode is active the hand icon will have a concaved depression . To switch off drag mode and go back to current price, click the hand icon once more to deselect it.
  • While in drag mode users can scroll back as far as the start of their Bookmap session, depending on memory capacity. Left click and hold the mouse while scrolling left and right. The arrows keys can also be used to scroll. Each arrow key stroke moves the chart 1 pixel in each direction. Using the arrow keys while holding the shift key will scroll the chart 10 pixels in the relevant direction.
  • While in drag mode, users can also zoom in and out to view specific details within the historical order book. When zooming in using the scrolling wheel Bookmap will keep the chart centered on the cursor location. Traders can also use the zoom in and out icons while in drag mode. In this case Bookmap will keep the presentation anchored to the middle point of the current chart view. To switch off the drag mode just click again the hand icon above the chart.
  • Users can also manipulate the time and prices axis by left click and hold and moving the mouse cursor left or right (time axis) or up and down (price axis).

Time Slices[edit]

The Bookmap chart includes dotted vertical lines marking the area between major two time stamps on the time axis. The length of time between vertical lines is dependent on the actual time range of the chart. To quickly set the chart range, click the stopwatch icon above the chart and choose the desired range. Note that this setting will also affect any synched charts.

Bookmap Time Slice Options


Snapshot Generator and Social Network Sharing[edit]

Use either the icon above the chart or ctrl+S to take a screenshot of your current Bookmap chart view. Snapshots are automatically saved to the user folder. The default path is C:\Bookmap\Screenshots.
Clicking the icon will also give you the option to share your screenshot in twitter or facebook.

Saving and Sharing Snapshots


Color Settings[edit]

Custom color settings can be set for all Bookmap elements. Click the Setting menu and select Color Settings. Settings. Click Color Settings

Locate the item you want to change and select the desired color or click the eye drop button to select any color available on your computer screen. Click “Save as” to save your color selections. Click “import” to import previously saved color profiles. To reset default colors, click the specific “Restore” color button or Restore All”.

Color Settings Panel


Information bar and tool tip[edit]

The information bar at the bottom of the chart provides accurate data on the number of pending orders and the number of contract executed at every point on the chart. Simply hover with the mouse curser over a specific price level and time (left of the vertical timeline) to get the information on the number of pending contract. Similarly, the Information Bar can also display the volume of each transaction by hovering over an individual volume dot with the mouse cursor. Be sure to carefully position your mouse pointer on the center of the dot to view the VWAP of the specific transaction.

Information bar and tool tip display of specific bid size, volume size


The data displayed in the information bar can also be displayed with a tool tip over the Bookmap chart. To display the tooltip click the icon above the chart and place the cursor over any point in the chart for which you want to display detailed information.

Limitations:

As noted by default Bookmap keeps records of the order book size at each price level and displays it with the relevant gray shade. Whenever a certain price level goes out of the price range transmitted by the relevant exchange (for example, CME transmits only the best 10 levels of bid and ask), Bookmap will continue displaying the last transmitted size at the out-of- range price level and will update the size once this price level returns to the transmitted range. This allows traders to estimate market depth even beyond the exchange transmitted range, however please note that it is only an estimation (or more accurately, a record of the last transmitted size)of size. Users can override this default behavior and opt to reset out of range levels or only display depth for the active range. See Heat map Vertical Filter for details.

Crosshair and Drawing Tools[edit]

Click the icon above the chart to switch to crosshair cursor. Click the icon for various drawing tool options. When the Single Figure Mode checkbox is ticked Bookmap will exit drawing mode after the first drawing element is completed. Use the Change Drawing Style menu item to control drawing elements attributes.

Configure Visible Components[edit]

The information bar at the bottom of the chart provides accurate data on the number of pending orders and the number of contract executed at every point on the chart. Simply hover with the mouse curser over a specific price level and time (left of the vertical timeline) to get the information on the number of pending contract. Similarly, the Information Bar can also display the volume of each transaction by hovering over an individual volume dot with the mouse cursor. Be sure to carefully position your mouse pointer on the center of the dot to view the VWAP of the specific transaction.
Control visible components

Traded Volume[edit]

Volume Dots[edit]

Application:
Bookmap displays transacted volume using the volume dots. Each dot represents the aggregate volume that has been executed during a time period that is equivalent to a single pixel slice of the user’s screen. This time unit will change based on the level of zoom applied to your Bookmap chart: the more zoomed in the view is the shorter the time period represented by a single pixel slice will be and vice versa.

The size of the volume dots circles is determined by configuration (as explained below) and by an algorithm that scales the aggregated volume of executed trades at a specific pixel time unit in relation to the instrument’s average volume.

Interpretation:

User can gauge the volume dots to gain information on the relative size of executions at specific time and price areas and which side has been more aggressive in these transactions. The precise location of the dot’s center is determined by time (on the X axis) and by the Volume Weighted Average Price (VWAP) of executions at the relevant time unit (the Y axis). The identity of the aggressor side can be determined by the color of the dot which is set on a gradient scale of 2 configurable colors representing buyers and sellers. A stronger color represents a more aggressive action by the side associated with that color.
User can assign the colors they want for the buyers and sellers. See Color Settings for more information.

Settings:

To display or hide the volume dots, click the studies icon above the chart and check the volume dots option on the studies panel.


Volume Dots Configuration Panel


Various settings of the volume dots can be accessed from the studies panel when clicking the Volume Dots item:

  • Minimum accountable dot volume: this parameter defines the threshold of aggregate volume equired to paint a volume dot.
  • Dot size: defines the scaling of the volume dots.
  • Transparency: sets the opacity level of the volume dots.
  • Volume Dots Drawing Type: defines how the classification of aggressor side will be indicated on the volume dot.
    • Gradient displays the relative size of the aggressor side (buy and sell) as a scale of the 2 colors representing buyers and sellers.
    • Solid displays the relative size of the buy and sell aggressor trades as a split of two solid colors.
    • Pie displays the relative size of the buy and sell aggressive orders as a split pie.
  • Dots Clustering: defines whether dots are clustered or not and the method of clustering. There are 3 clustering methods:
    • Smart - using an internal algorithm Bookmap aggregates together several adjacent or overlapping dots into a single dot display that is positioned on the chart based on weighted averages of the trades values and execution time. Use the slider to define the level of aggregation.
    • Volume - Bookmap will create a volume dot whenever the number of traded contracts reaches the number defined by the user. Thus, volume dots will have a similar size but they will appear in different frequency depending on market activity. Note that the volume dot can represent more contracts traded than the configured number in case the last trade exceeds the configured volume size. For example, if the configured volume size is 100 but the volume dot is comprised of 2 single sequential trades of size 50 and 100, the volume dot will show 150 contracts traded and not 100.
    • Time - Bookmap will paint a volume dot every configurable period of time.
    • Price - Bookmap will aggregate the trades (regardless of aggressor side) in a single dot as long as they occur at the same price.

Click Apply to Bars to apply the volume dots clustering setting to the volume bars or click Inherit from Bars to align the volume dots clustering setting with that of the volume bars

Volume Bars[edit]

Application:

Bookmap also displays transacted volume using volume bars painted on the lower part of the heat map. Each bar dot represents the aggregate volume that has been transacted during a time period that is equivalent to the pixel width of the bar. This time period will change based on the pixel width configured for the bar and the level of zoom applied to your Bookmap chart: the more zoomed in the view is the shorter the time period represented by a single pixel slice will be, and vice versa.

Bookmap with volume bar display


Interpretation:

User can gauge the volume bars to gain information on the relative size of executions at specific time and price and which side has been more aggressive in these transactions. The identity of the aggressor side can be determined by the color of the bar which is set on a gradient scale of 2 configurable colors representing buyers and sellers. A stronger color represents a more aggressive action by the side associated with that color. User can assign the colors they want for the buyers and sellers. See Color Settings for more information.

Settings:

  • Bars Width: by default the bars width is set to 1 pixel. Use the setting window on the studies panel to change the width of the bars up to a max width of 15 pixels.
  • Volume Bars Drawing Type: defines how the classification of aggressor side will be indicated on the volume bar. Use Gradient to display the relative size of the aggressor side (buy and sell) as a scale of the 2 colors representing buyers and sellers. Use Solid to display the relative size of the buy and sell aggressor trades as a split of two solid colors.
  • Bars Clustering: defines whether volume bars are clustered or not and the method of clustering. There are 3 clustering methods:
    • Smart - using an internal algorithm Bookmap aggregates together several adjacent bars into a single bar positioned on the chart at the time weighted averages of executions.
    • Volume - Bookmap will create a volume bar every set number of contracts traded. Note that the volume bar can represent more contracts traded than the configured number in case the last trade exceeds the configured volume size. For example, if the configured volume size is 100 but the volume bar is comprised of 2 single sequential trades of size 50 and 100, the volume bar will show 150 contracts traded and not 100.
    • Time - Bookmap will paint a volume bar every configurable period of time.


Click Apply to Dots to apply the volume bar clustering settings to the volume dots or click Inherit from Dots to align the volume bars clustering setting with that of the volume dots.

In order to set the height of the volume bar display, hover with the mouse curser over the volume bar area and drag the red line to the desired height. The number on the right represents the max volume bar value during the displayed range.

Bookmap with volume bar display

Indicators[edit]

Display and Setting[edit]

The indicator and widget pane currently displays position and P&L indication and cumulative volume delta (CVD). It will host additional indications as they become available or ones developed via Main page: Bookmap API.

To display the Indicator and widget pane click the small triangle mark at the bottom of the price ladder.

To control various widget / indicator settings either click the gear icon on the upper left corner of the widget window and then set the relevant widget or right click the widget itself and select the relevant item on the list.

To display / hide specific line indication click the gear icon on the upper left corner of the widget window and then click the bars icon of the relevant indicator on the settings window. To display / hide specific widget indication click the gear icon on the upper left corner of the widget window and then click the lines icon of the relevant indicator on the settings window.

To have the indicators or widget display data based on a chart range or full session right click the relevant widget and select Indicator Range.

Bookmap Indicators and Widget Pane

Cumulative Volume Delta[edit]

The Cumulative Volume Delta (CVD) displays the cumulative volume changes based on the volume traded by sell aggressors versus buy aggressors and is displayed on the indicator and widget pane.

To display CVD click the studies icon and check Cumulative Volume Delta CVD settings are controlled from the right part of the CVD studies panel. Following settings are available:

Add CVD indication – use the + sign to add more different CVD indications per symbol

Minimum accountable volume size – CVD will take into account trades that are equal or greater than the selected size.

Maximum accountable volume size – CVD will take into account trades that are smaller than selected size

Indicator Range – controls the data range referred to for calculation of CVD, either chart range or session based.

'Reference Points – allows users to define reset time and reset frequencies. CVD will start accumulation from zero at these points in time. CVD can also be reset immediately by clicking the Reset Now button at the bottom of the window.

Split Buyers / Sellers – displays split CVD indications for buyers and sellers

Colors – set CVD colors for positive and negative values. The eye drop icon allows selection of any color on the screen to apply to the relevant indication display.

CVD Settings Window

Interpretation[edit]

Users can gauge the imbalance indicators to assess when the activity is heavily titled to a single direction based on the order book and order flow activity. This can help in assessing momentum move or exhaustion points.

Settings[edit]

The Imbalance Indicator ratios are displayed on the top right side of the chart. Whenever an imbalance ratio is equal to or greater than 10% the number will appear in the color set for the buyers. If the imbalance ratio is equal or less than -10%, the number will appear in the color set for the sellers. See Color Settings for details on changing the color setup.

To enable the imbalance indicator display click the studies panel icon above the chart and check either of the two imbalance indicators. The studies panel also includes settings for the order book imbalance as illustrated below.

Imbalance Settings



The Limit number of levels to calculate is used to set the number of levels above and below the bid/offer price that are taken into account when calculating order book imbalances. A setting of 5, for instance, will calculate imbalance of 5 levels above and below the bid/offer.

The Weight levels exponentially decay rate setting allows the user to control the weighting and significance of levels closer to current price.

Note that if a setting value is not check marked, then the imbalance indicator will generate a calculation for the entire visible book and volume size with no exponential decay rate.

Limitations[edit]

The imbalance indicators are set to take into account the entire visible range of the chart. To change the time range taken into account when calculating the imbalance ratios, users must zoom in or out or drag the chart.

Chart Synchronization[edit]

Application[edit]

If you have multiple Bookmap charts open, you can synchronize the charts together. One chart is defined as a master chart and the viewing range of all other open charts is synchronized with it. Any change applied to the chart range of the master chart will automatically be reflected in the subordinate charts.

Interpretation[edit]

Traders can use the synchronization feature to look for deviations in price or liquidity behavior of correlated instruments or viewing various legs of spread trades.

Settings[edit]

Once all relevant charts are open, click the sync icon above the chart you want to designate as the master chart. Any change of range you make on the master chart (whether by dragging or zooming in and out) will be reflected on the subordinated charts. Note that all charts should have the same size window for the synchronization to be complete. To deactivate the sync mode simply click again the sync icon.

Limitations[edit]

  • It is recommended that all synchronized charts are the same size in order to have a complete synchronization.
  • All open charts are affected by the synchronization feature; one chart acts as a master chart and the rest are subordinated to the master chart.
  • Dragging or zooming in and out on a subordinate chart will break the synchronization of that specific chart in relationship to the master chart.

Chart Refresh[edit]

Bookmap utilized advanced GPU to efficiently and rapidly render the visual information on the chart. It could be that some users’ machine will be less equipped to handle the resources required for rapid chart refreshes, whether because of lack of advanced GPU support or low video memory. The default refresh rate of Bookmap chart is 40 FPS (frames per second) or every 25 milliseconds. If you experience resources burden using the default refresh rate, adjust the refresh rate to make it less frequent. However, setting FPS below 15 (refresh rate above every 67 ms) will make the refresh noticeable by human eye. To change the refresh rate, click Setting >> Chart refresh rate from the Bookmap control panel, and choose an in-range rate from the refresh rate setting panel.

Bookmap normally works with OpenGL 3 and above. Not all video cards support this OpenGL version or may have outdated drivers. If you cannot update your video card to support this OpenGL requirements Bookmap can still work with older video card but that will require more CPU utilization. To allow Bookmap to work without GPU acceleration click the Settings menu on the Bookmap control window and deselect the GPU acceleration option on the menu.


Presentation Mode[edit]

This mode is intended to improve the quality of the presentation of Bookmap with video capture or screen sharing software. It allows recording of Bookmap sessions with video capture software (e.g. Camtasia) or screen sharing Bookmap over Skype or similar screen sharing software, while maintaining the original Bookmap chart frame rate instead of lower frame rate enforced by these software.

To use this presentation mode, click Settings>>Chart refresh rate and check the “Presentation Mode” checkbox.

Data Recording[edit]

Recording setup window

Bookmap provides the ability to record your live session's data into a file and replay it later for analysis and training purposes using Bookmap replay mode.

With the exception of Bookmap for NinjaTrader, to record your session's data simply check the "Record Live Data" checkbox on the Bookmap Run Options window. When you close Bookmap the data file will be closed as well and will be ready for replay. Data files are located by default in C:\Bookmap\Feeds. See Bookmap Replay for further instructions on how to use Bookmap replay to view data files.

Another option to activate data recording, which is also applicable to NinjaTrader users using Bookmap and indicator, is directly from the Bookmap chart. Click the recoding icon on the bottom right corner of the chart and click Start Recording. Choose the recording option from the recording setup window and click start.

Order Recording[edit]

Users who have the one click trading addon can record their own orders and later view their trading activity on the chart in replay mode. To record your orders make sure first to record the session by checking the “Record Live Data” check box on the run options window. After you launch Bookmap make sure that the “Record orders” Settings menu item is selected. After you finish recording close Bookmap and reopen it in replay mode. Select the relevant data file you want to replay, and make sure the “Replay recorded orders” Settings menu item is selected.

Data Refresh[edit]

Scheduled Data Refresh

The data refresh feature allows users to define when to reset the inflow of data and start the accumulation of data anew. This can be done manually or at a preset time. If the user is recording the data, each refresh will close a data file and will start recording the new data in a separate file.

To activate the refresh feature go to File>>Restart Bookmap and click either Now for an immediate manual refresh or Schedule for an auto scheduled refresh.

When adding a scheduled refresh, check the “Alert before refresh” if you want to be alerted before a refresh is done (you will then have a chance to cancel the refresh) and set how many seconds before the refresh to pop-up the alert. Then click “Add refresh” and set the refresh time. You can set the refresh as a one-time event or a recurring daily event. Note that the scheduled refresh will not start while the configuration window is open.

Bookmap Columns[edit]

Application and Interpretation[edit]

Bookmap displays configurable columns to right of the Bookmap chart. Each column can be configured to display the following column types: Current Order Book, Volume, Trades Counter, Quotes Counter, Quotes Delta and Custom Notes

Current Order Book (COB)

This column displays a graphical representation and numeric values of the pending orders of the current book with bars (COB). Users can interpret the size of pending orders by comparing the relative size of the graphical bars.

Volume (CVP, SVP)

This column displays a colored volume profile. The colors represent the aggressor side (buyers or seller). Users can interpret the aggressor trading side by looking at the colors of the volume bars. Note the radio button choices available for volume: Session Accumulation (SVP), Chart Range Accumulation (CVP). Session accumulation displays the volume from the beginning of the Bookmap session. Chart range accumulation displays just the volume related to the visible data of the current Bookmap window. If you zoom in or out, you will notice how the volume changes to the data within the visible chart.

Trades Counter (CTC, STC)

This column displays the number of trades accumulated at each price level. The colors represent the aggressor side (buyers or seller). Similar to volume, Trades Counter can be displayed by either Session Accumulation or Chart range accumulation.

Quotes Counter (CQC, SCQ)

This column displays the number of quotes refreshed at each price level. The colors represent the aggressor side (buyers or seller). Quotes Counter can be displayed by Session Accumulation (SQC) or Chart range accumulation (CQC).

Quotes Delta(+/-)

This column displays the size of pending orders added or pulled from the active bid and ask range (the range below and above that is transmitted by the exchange). Each price level shows the number of contracts added or pulled from it since the last best bid or ask update. The best bid and ask price levels are marked with a rectangular of a matching color.
The delta number reset after each update of the best bid or ask. The top and bottom most numbers on either side of the active range is the total sum of the delta since the last best bid or best ask update.

Time and Sale

This column displays Time and Sale table.

Custom Notes(CN)

This column displays user notes for each price level.

Trading DoM Configuration panel[edit]

Trading DoM

This column allows placing trades directly from the DoM.

Right clicking each of the sub-columns will open a configuration panel with the available setup options for that specific sub-column. Beyond display setup, use this configuration panel to define mouse and key sequence for specific order types (limit, stop, stop limit) on the BID or ASK sub-columns, or specific order modification actions on the ORD sub-column.

Note that as with trading from the chart, market orders are not supported on the Trading DoM column. Place a buy limit order far enough above the best bid for immediate execution or a sell order far enough below the best ask for immediate execution of a sell order.

As with any new trading functionality, we recommend that you first use the Trading DoM column in simulation to experiment with its different options and functionalities.

Trading DoM Column & Trading DoM Configuration Panel


Columns showing volume profile, trades count and quotes count also display a horizontal line that mark the VWAP calculated from the start of the Bookmap session or for the chart range displayed (depending on the view method set by the user for the specific columns). To view the VWAP line on these columns, open the Format Column panel from the column right click menu and check the Show VWAP line check box.

Layered Bookmap charts with different column options


For the COB column Bookmap displays at the top of the column a number that corresponds to the number of contracts represented by the full pixel width of the COB column. This should give users a reference number to gauge the contract sizes represented by the different bars.

In the example below, the max width of the COB column is 1000. A bar that would have filled the entire width of the column would have represented a size of 1000 contracts.

Column.jpg


To choose between columns types, right click any of the column and select the column type to display and, where applicable, whether to use session or chart range data accumulation.

See the screenshot below for columns right click menu.

Right click columns menu


Settings[edit]

Users can set the colors representing buyers and sellers for the volume profile, trades count, quote counts, current order book bars and time and sale.

Users can also control various aspects of the column display: (i) display the data as a single or split histogram; (ii) display the data as bars or number or both; (iii) alignment of the bars and numbers; and (iv) inverse data display; (v) displaying only bid or ask sides or both.

For the COB column only users can also select an aggregate display and extended displays:

Aggregate Display - instead of presenting the size of each individual price level, each level represents the cumulative size of its own size and the aggregate size of preceding levels (i.e. level 3 represents the size of Level 1+2+3). When choosing aggregate view, Iceberg and Large Lot indications will not be visible.

Extended display – user can choose to present only the active range or an extended range which will be displayed based on the last updated size for out-of-active-range price levels.

To control all these display options, right click on the relevant column. At the top of the menu click Format Column and set your display preferences from the format column dialogue box.

Format Column Dialogue Box


The data on the Volume, Quotes and Trades columns can be reset by the user using different options: Manual reset – right click on the relevant column and click the Reset menu option and then click Reset Now.

Reset Configuration – right click the relevant column and click the Reset menu option then click Reset Configuration. There are two options to configure: Scheduled Reset at predefined frequency and Conditional Reset that will reset the selected price level if the time between two trades at that level is greater than the selected period (in milliseconds)

Reset on Double Click – right click the relevant column and click the Reset menu item, then tick the Reset on Double Click checkbox. As long as this option is checked users will be able to reset the column by double clicking it.

Manual column reset & auto column reset


Time and Sale[edit]

The columns display the stream of executed orders. Bookmap reconstructs the tape based on the order of data transmission so that even if a single trade is broken into several executions it will still be displayed as a single trade with the total contract size. Users can filter time and sale to show only executions on the bid or ask or filter based on contract maximum and minimum size.

The Time and Sale window is detachable. If detached it can be set back to column display by closing the detached Time and Sale window.

There is an option to export trades into file. Note, that export range is limited to last 10000 raw events.

Bookmap Time and Sale Column


Custom notes[edit]

To add notes, set the column type to Custom Notes. Once set, right click the custom notes column at the relevant price level and click the top option Add/Edit Notes. Use the custom note dialogue box to set your note and style it.

Custom Notes Panel


You can also import notes from a csv file. To import your notes set the column type Custom Right click on the Custom Notes column and select import notes. Browse for your notes csv file and click open. This will populate the Custom notes column with the notes from the file. You should use a specific csv template to import notes from. A cutom_notes_template.csv can be found in C:\Bookmap\Config. Please note that you should enter the Symbol and Price Level in the file in the exact format they appear on your platform and the Bookmap chart. Values for Foreground Color, Background Color and Text Alignment are optional. If not filled, default values will be used. Color values can either be entered as hex codes or names.

Alerts[edit]

To add price alerts right click the custom notes column at the relevant price and click the notification tab. Then set the following values:

  • Set the offset from price where you want the alert to trigger. Use positive offset for distance above price and negative offset for distance below price.
  • Check notify only once if you want the alert to be triggered once. If notify only once is not checked, choose the interval at which you want the alert to be triggered again.
  • Choose the sound for the alert. This can be either the default system alert or any sound file added to the sound folder.
Alerts Panel


Adding and deleting columns[edit]

To add or delete any column type, right click on any column and select Insert Column or Hide Column. Initially, the column that is added is a replica of the column from which the Insert column option has been selected. User can then configure this column as they prefer. You can also rearrange the order of the columns by left click and hold the column title and dragging the column to the desired place. Columns can be dragged to either side of the Bookmap chart.

Bookmap Orders Format[edit]

Bookmap allows recording and replaying user's orders with all events that occur during order's lifetime. Like the market data, orders files are stored by Bookmap in the C:\Bookmap\Feeds folder in an encrypted format '*bmo' and are automatically replayed with corresponding market data. Traders can also export and import orders file in human readable format, which implies that such files can be edited or even generated from scratch (e.g. from an external simulation software). This page describes the format of the file.

Human readable orders files[edit]

Order files can be exported via File->Export->Export orders as plain text. The files may contain lines with comments starting with '#'. Each line except the header and comments represents a particular event of a particular order where the type of the event is represented by a single letter as shown below.

Example of exported order data[edit]

Here is a simple scenario that includes 3 orders and shows corresponding text file. For simplicity, in this example there is only one working order at a time.

Orders.png

!BOOKMAP_FORMAT_V1
!DO_NOT_UPDATE_AFTER_EXECUTION
S,20180817,132604,0.278443826,1105671107,ESU8.CME@RITHMIC,1,2837.0,2
C,20180817,132606,0.660462608,1105671107
S,20180817,132608,0.448465391,1105671108,ESU8.CME@RITHMIC,0,2838.0,2
E,20180817,132609,0.385849739,1105671108,2838.0,2
F,20180817,132609,0.386520348,1105671108
S,20180817,132612,0.325328,1105671115,ESU8.CME@RITHMIC,1,2837.25,2
U,20180817,132614,0.282056116,1105671115,2837.5,2
U,20180817,132617,0.837655884,1105671115,2837.75,2
U,20180817,132621,0.738012058,1105671115,2838.25,2
U,20180817,132625,0.130369159,1105671115,2838.5,2
E,20180817,132625,0.130665043,1105671115,2838.5,2
F,20180817,132625,0.130980406,1105671115

File header[edit]

The header is needed for internal use to allow back-compatibility in case the format changes in the future

!BOOKMAP_FORMAT_V1
!DO_NOT_UPDATE_AFTER_EXECUTION

Timestamps[edit]

Each line has timestamp represented by 3 fields: date, hours in UTC timezone, and sub-seconds. For instance, here it's 17-Aug-2018 13:26:04, 278 milliseconds, 443 microseconds, 826 nanoseconds. The sub-seconds field can be anything in the range [0 1).

<date>,<time>,<subsecond>
20180817,132604,0.278443826

Send order message[edit]

The first event any order is always event called ‘Send Order’ which starts with S and includes order's properties and its unique Order ID. This ID will be used for referencing the order during its lifetime:

S,<date>,<time>,<subsecond>,<order id>,<instrument alias>,<bid(1) or ask(0)>,<price>,<size>
S,20180817,132604,0.278443826,1105671107,ESU8.CME@RITHMIC,1,2837.0,2

Update order[edit]

Update order event starts with U and appears when price and / or size of the order are modified.

U,<date>,<time>,<subsecond>,<order id>,<new price>,<new size>
U,20180817,132621,0.738012058,1105671115,2838.25,2

Cancel order[edit]

Cancel order event starts with C.

C,<date>,<time>,<subsecond>,<order id>
C,20180817,132606,0.660462608,1105671107

Execution[edit]

Full or partial execution events start with E and tell at which price and how much of the order was executed.

E,<date>,<time>,<subsecond>,<order id>,<price>,<size>
E,20180817,132625,0.130665043,1105671115,2838.5,2

Fill[edit]

Fill event (F) allows to mark an order as filled (otherwise it will be displayed as 0 size by some versions):

F,<date>,<time>,<subsecond>,<order id>
F,20180817,132625,0.130980406,1105671115

Replay data / Simulated trading mode[edit]

Bookmap Replay[edit]

Bookmap offers the ability to replay and trade pre-recorded market data. This is a great training tool. All settings and features are fully functional within Replay mode.

Running Bookmap in replay mode[edit]

a.) Open Bookmap. This will open the Bookmap run options window:

Bookmap Run Options window


b.) Choose Replay data / Simulated trading and click ok. This will open Bookmap Main Window.

Bookmap Replay main window


c.) On the main window , click “Load Feed File”. This will open a new window. Choose one of the text feed files and click “Open”. Each feed file represents a prerecorded trading session.

User’s feed files directory


d.) The feed loads the recorded sessions. Give it a moment to load. The recorded instruments will open as tabs. Click any of your desired instruments to open the relevant chart. The chart starts replaying as soon as the feed file loads.

e.) A control slider will open above the chart. User can manipulate the slider to go forward or backwards inside the recorded data. Hovering over the slider will open additional replay control options. You can either pause or choose varying replay speeds using the various controllers on the replay panel.

Use the pin icon on the right side of the replay panel to keep the panel always visible or to auto hide it.

f.) The replay panel includes the ability to jump to the next data point in the file . This is useful in micro second analysis or to skip end of day period in case recording stretches overnight. Currently the skip to next data point button refers to the entire record file and not to the specific instrument viewed.

Bookmap Replay main window with active symbols

Bookmap run modes[edit]

Bookmap Run Options

Bookmap supports the following 3 modes of operation:

Replay data / Trading simulated by Bookmap: this mode of operation is independent of your trading platform and operates as a standalone product. It allows you to replay market depth data files of previous live sessions you recorded. Traders can place and execute simulated orders to evaluate how their trading decisions and strategies fit their analysis of the market based on Bookmap insights.

External data / Trading simulated by Bookmap: this mode of operation allows you to trade with internal Bookmap simulator while acting on real time data transmitted from your supported trading platform.

External data / Trading through your brokerage account (real simulated): this mode of operation presents real time market depth data and orders transmitted from your supported trading platform. It also supports the transmission of limit orders to your supported trading platform through one-click order placement directly from the Bookmap chart.

Bookmap Add-ons[edit]

Bookmap one-click trading add-on[edit]

This Bookmap addon enables placing limit and stop orders with one click action directly from the Bookmap chart or from the Trading DoM column. This offers a tremendous advantage for pinpointing trade location and expediting trade execution.

Cyan dots mark the entry of buy orders. The cyan line extends from the entry time until the order is either filled or cancelled. A filled buy order is marked by cyan triangle.

Magenta dots mark the entry of sell orders. The magenta line extends from the entry time until the order is either filled or cancelled. A filled sell order is marked by magenta triangle.

It is possible to define what type of order information will be displayed on the chart. By default, pending, cancelled and executed orders are all presented on the chart. To change the default settings click Settings → Configurations and uncheck the relevant information on the Order Display section. See the figure below for details of the various orders markings on the chart:

Legend:
1. Pending(sell) order            4. Cancelled (sell) order
2. Pending (sell) stop order      5. Executed(buy) order
3. Pending (buy) stop order       6. Number of contracts & (Number of orders)


Placing limit and stop Orders[edit]

Trading Configuration Panel

Every time the Bookmap chart opens the one-click trading feature is disabled for precautionary measures. To enable one click trading click the lock icon above the Bookmap chart. This will open the Trading Configuration Panel. Check Enable One-Click Trading and specify the number of contracts per click (Size box). Note that when one-click trading is enabled the lock icon will open.

To follow up on your orders, position and P&L status you can either use the Trading Configuration Panel or the Trade Status Panel. To open or close the Trading Configuration Panel, use the lock icon above the chart. To close or open the Trade Status Panel click Settings → Configuration and check/uncheck the "Show Trade Status Panel" checkbox.

The Bookmap chart is divided into 2 areas separated by the current time line. Orders can be placed with one click action only from the area right vertical time line. To place an order, follow the instructions below:

  1. To place a Buy Limit order, click the left mouse button at or below the current bid at the desired price level. Note that clicking the left mouse button at or above the current ask will result in a buy at current market price.
  2. To place a Sell Limit order, click the right mouse button at or above the current ask at the desired price level. Note that clicking the right mouse button at or below the current bid will result in a sell at market price.
  3. To place a Buy Stop order, press SHIFT + left mouse button at or above the current ask at the desired stop price level. To place a Sell Stop order, press SHIFT+ right mouse button at or below the current bid at the desired stop price level. Note that stop orders can be either stop market of stop limit orders, as explained below.
  4. A single mouse click places an order for the number of contracts specified by the trader in the trade configuration settings window. Each additional mouse click will add another order for a similar number of contracts.

Quick order entry[edit]

Quick Order Entry

Use the quick order entry to place market buy or sell orders or place buy or sell limit at the bid or ask.

Stop order types[edit]

Stop Order Types

A stop order can be placed as either stop market or stop limit. A stop market becomes a market order once the stop trigger price is reached. A stop limit order becomes a limit order once stop price is reached.

To choose between the two stop order types set the stop order type on the Trading Configuration Panel to either MKT for a stop market order or LMT for a stop limit order. When using a stop limit order set the stop order offset to indicate the limit price. Note that offset can also be negative. A negative offset mean that once the stop trigger is met the limit order is below the trigger price (for buy stop) or above the stop trigger price (for sell stop).

Send order confirmation[edit]

By default a pop confirmation window will appear after sending orders. The order needs to be confirmed before it is actually sent for execution via the connected trading platform or API. To disable the order confirmation pop up click Settings >> Orders Conformation and uncheck any order type for which you do not want to get a pop up order confirmation window.

Order Duration[edit]

There are 4 different order duration that can be set in Bookmap through the Trading Configuration Panel:

  • Day – order expires at the end of the regular session
  • GTC – order stays in effect until cancelled
  • FOK – fill or kill
  • IOC – immediate or cancel

NOTE that order duration setup will be kept for all orders until changed or until the one-click trading is disabled in which case the duration setup will revert to default.

NOTE that stop order duration is set separately from limit order duration to allow greater flexibility. The stop order setup will be kept for all stop orders until changed or until the one-click trading is disabled in which case the stop order setup will revert to default.

Cancelling pending Orders and exiting all positions[edit]

Cancelling Orders & Closing Position

Pending orders can be cancelled and open position closed either by one-click interaction on the Bookmap chart or from the Trading Configuration Panel.

Cancelling orders and closing an open position from the chart:

  • To cancel pending orders, place the mouse pointer over the relevant price level and click the middle mouse button. When multiple orders are placed on the same price, Bookmap will cancel the last order placed.
  • To cancel all of the pending orders at a certain price level place the mouse pointer over the relevant price level and press CTRL + middle mouse button.
  • To cancel all pending orders click the Cancel All button on the Trading Configuration Panel. To cancel just buy or sell orders click the buy or sell X buttons on the Trading Configuration Panel..
  • To exit all open positions, click the Flatten button on the Trading Configuration Panel. This will also cancel all pending orders.


Bracket Orders[edit]

To send bracket orders users need to check the Brackets checkbox on the Trading Configuration Panel and check the type of orders to send as brackets and their distance in ticks from the executed price of the leading order. Bracket orders can be either or both of take profit limit order and stop order. Note that bracket orders will be sent for every filled order that was placed when the Bracket checkbox was already checked.

The duration and type of the stop limit bracket order will be as was set for any stop order when the leading order was sent to the market. The duration of the take profit limit order will be the same as was set for any limit order when the leading order was sent to the market.

Once triggered the bracket orders will function as OCO orders. The price of each OCO leg can be changed individually2. When one leg is cancelled the other leg will be cancelled as well. Size modification of a single leg may or may not result in a similar change of the other OCO leg, depending on the platform to which Bookmap is connected. See Special Orders for details. Note that size can only be modified downwards, i.e. you can only reduce the size of the order but not increase it.

For some of the platforms and APIs supported by Bookmap, the bracket orders are server side, i.e. the instruction to send a bracket order following the execution of the leading order is not stored internally in Bookmap but on the broker / execution platform side. At the same time, some other platforms and APIs do not support server side bracketing, in which case the bracket orders will be client side, i.e. kept in Bookmap until sent to the market. Whether bracket orders are server or client side has implications on the submission of orders when Bookmap becomes unavailable due to loss of connection, involuntary or voluntary shutdown, system crush or any other reason. When bracket orders are kept on the client side, they will be lost when Bookmap becomes unavailable and will not be sent to the market when the triggering condition has been met. Traders’ caution and discretion is advised when using client side bracket orders. See Special Orders for details on which platform / API supports server side brackets. When working with other platforms / APIs the brackets will be client side.

OCO Orders[edit]

When OCO check box is checked, traders can enter two linked orders that will cancel each other when filled. Once the trader designate the first OCO leg price the trader will be guided to designate the second OCO leg price. Only when both OCO leg has been designated both OCO orders will be sent.

The price of each OCO leg can be changed individually. When one leg is cancelled the other leg will be cancelled as well. Size modification of a single leg may or may not result in a similar change of the other OCO leg, depending on the platform to which Bookmap is connected. See Special Orders for details. Note that size can only be modified downwards, i.e. can only reduce the size of the order but not increase it.

For some of the platforms and APIs supported by Bookmap, the OCO conditions is server side, i.e. the condition to cancel one order when the other gets filled is not stored internally in Bookmap but on the broker / execution platform side. At the same time, some other platforms and APIs do not support server side OCO, in which case the OCO condition will be client side, i.e. kept in Bookmap. Whether OCO is server or client side has implications on whether the cancelling of the relevant OCO leg will be done when Bookmap becomes unavailable due to loss of connection, involuntary or voluntary shutdown, system crush or any other reason. When OCO is kept on the client side, it will be lost when Bookmap becomes unavailable and an order that should have otherwise been cancelled when the other OCO leg gets filled, will be kept in the market. Traders' caution and discretion is advised when using client side OCO. See Special Orders for details on which platform / API supports server OCO. When working with other platforms / APIs the OCO will be client side.

Trailing Stops[edit]

Brackets, OCO and Trailing Stop

For trailing stops users need to check the TS checkbox on the Trading Configuration Panel. A trailing stop will be executed for every stop order that was placed when the TS checkbox was already checked. The trailing parameter controls the steps at which the stop order is updated and is measured in tick distance. Note that stop orders placed to open a position will not be affected by trailing stop.

For some of the platforms and APIs supported by Bookmap, the trailing stop is server side, i.e. the trailing stop instructions are not stored internally in Bookmap but on the broker / execution platform side. At the same time, some other platforms and APIs do not support server side trailing stop, in which case the bracket orders will be client side, i.e. kept in Bookmap. Whether trailing stop is server or client side has implications on the trailing stop availability when Bookmap becomes unavailable due to loss of connection, involuntary or voluntary shutdown, system crush or any other reason. When trailing stop is kept on the client side, it will be lost when Bookmap becomes unavailable. Traders' caution and discretion is advised when using client side trailing. See Special Orders for details on which platform / API supports server side trailing

Order Modifications[edit]

Price Modifications

  1. To modify the price of an existing order hover with the mouse cursor over the order line mark at the area left of the vertical time line. When over the order left click and drag the order marking to the new price, then release the left click to change the order price. NOTE: order modification is done from the area left of the vertical timeline. Performing this action from the area right of the time line will result in a new buy limit order, which may be executed immediately.
  2. If there are multiple orders at a single price level, the order modification will apply to the newest order at that level. To move all order resting at the same price level, hold CTRL + middle mouse click and drag the orders to the new price.


Price Modifications

  1. To change the quantity of a pending order hover with the mouse cursor over the order line mark at the area left of the vertical time line. When over the order line mark left click and release. This will open an order size ladder. Click the new order size you want to change the order.
  2. If there are multiple pending orders at a single price level, modification will first apply to the newest order.
  3. To change the order size of new orders either use the size box on the Trading Configuration Panel or use the number buttons below it for a quickly adding or reducing size. When adding size simply click the relevant size buttons; when reducing size, SHIFT+click the relevant size buttons. User can set any preferred number on the size buttons. Simply right click any of the size button and then click “customize sizes”. Enter any size of preference and close the customize sizes window.
Orders Price and Size modifications
Size modification buttons


Cross Instrument Trading[edit]

Bookmap enables traders to trade a mini or micro instrument (e.g. mini DAX futures) from the chart of the major instrument (e.g. DAX futures). The eligible pairs are not configured by the trader but are predefined. In case of an eligible instrument pair, the symbol box on the Trading Configuration Panel of the major instrument will include both the major and the mini or micro instrument. To trade the mini or micro instrument off of the major instrument chart, the user must first subscribe to the mini (or micro) instrument through the Bookmap control window. Once subscribed, both instruments will appear active in the symbol box on the Trading Configuration Panel.

Once the major and mini (or micro) instruments are active, the trader needs to click the Start button in order to trade the mini or micro instrument from the major instrument’s chart. The symbol presented in the symbol box will be the tradable one.

Since the tick sizes of the major instrument and the mini (or micro) instrument may be different, the price clicked on the major instrument’s chart is rounded to the next compatible value of the traded mini (or micro) instrument. Using the Round box on the Trading Configuration Panel, traders can define whether to round the price into the market (TO) or away from the market (OFF).

To view the available pairs for cross instrument trading click File >> List of cross instrument trading pairs.

Cross Instrument Trading Settings


Order Display[edit]

Your trading data is displayed in the window above the chart. It shows your current position, Average Price, the open number of Buy and Sell orders in the current market, the amount of volume you’ve traded, and your Profit and Loss.

Orders generated directly from your trading platform will also be displayed and updated on the Bookmap chart opened for the same instrument.

You can control from the general configuration panel what on-chart indication of trades will be displayed on the chart itself. Click Settings → Configuration for the general configuration panel.

General config.jpg


Approximation of Order Queue[edit]

When the one click trading add-on Bookmap is enabled Bookmap can display an approximation of the position of the trader’s orders in the queue. Bookmap approximates the position in the queue according to a FIFO matching algorithm using a more pessimistic scenario relating to cancelled orders. The ability to display a more accurate position in the queue ultimately depends on the quality of data provided through the trader’s trading platform.

Bookmap presents queue approximation with white vertical lines on top of the current order book histogram. The place in the queue is illustrated by the position of the line over the bar representing the current size of pending order at any given price level.

In order to activate the presentation of the queue approximation, click Settings → Configuration and check Orders Queue.

Trading Configuration Panel[edit]

The Trading Configuration Panel controls various settings related to trading with the Bookmap platform. Most of these settings are detailed above. The 2 figures below details the various setting and control option on the Trading Configuration Panel. The items displayed on the Trading Configuration Panel are customizable – by right clicking each component on the Trading Configuration Panel, users can control which component (or component elements) to show or hide and can rearrange the order of components by dragging and dropping them on the Trading Configuration Panel.

Trade panel1.jpg

  1. Enable checkbox. Need to be checked to enable trading functionalities.
  2. Trading information. P Current position; A Average price of the open position (based on FIFO model); U Unrealized P&L; T Total P&L (i.e. realized + unrealized P&L); V Total volume traded by the user
  3. Size. Set the order size per click.
  4. Reset. Click the reset button to set the order size to 0. If the checkbox is checked the size will be reset to 0
  5. automatically after an order is sent.
  6. Set order duration for all orders except stop orders
  7. Stop order type. Can be a stop market or stop limit, with or without an offset.
  8. Set order duration for stop orders
  9. Quick order size modifications. Clicking any of the numerical values will add the relevant size to the currently set order size. Clicking SHIFT+ any numerical value will subtract the relevant size from the currently set order size.
  10. Cancel all sell orders. 10 Cancel all buy orders.
  11. Cancel all orders
  12. Cancel all orders and close open position (market exit).
  13. Automatic bracketing. When checked, a limit order (take profit) and a stop order (stop loss) will be automatically sent when a new order to open a position is filled (assuming the order for opening the position has been sent after the checkbox has been checked).
  14. TP. Set the number of ticks for auto bracketing take profit.
  15. SL. Set the number of ticks for auto bracketing stop loss.
  16. TS. Set trailing stop in tick increments.


Trade panel2.jpg

  1. Bookmap enables a trader to trade a mini or micro instrument (e.g. mini DAX futures) from the chart of the major instrument (e.g. DAX futures). The eligible pairs are not configured by the user but are predefined. In case of an eligible instrument pair, the symbol box on the trading panel of the major instrument will include both the major and the mini or micro instrument. To be able to trade the mini or micro instrument, the user must first subscribe to this instrument through the Bookmap control window. Once subscribed, both instruments will appear active in the symbol box on the trading panel.
  2. Once the major and mini (or micro) instruments are active, the user needs to click the Start button in order to trade the mini or micro instrument from the major instrument’s chart. The symbol presented in the symbol box will be the tradable one.
  3. Round. Since the tick sizes of the major instrument and the mini (or micro) instrument may be different, the price clicked on the major instrument’s chart is rounded to the next compatible value of the traded mini (or micro) instrument. The user can define whether to round the price into the market (TO) or away from the market (OFF).
  4. Order Cancel Order & Order Send Order
  5. Quick trade buttons


Trading from DoM[edit]

Instead of trading from the chart as explained above, you can also use the Trading DoM column to place your orders from the DoM. You would still need to follow the same procedures relating to the trading configuration panel as detailed in section 6.1 but the actual placement of order will be done from the DoM.

The DoM trading column includes 5 sub-columns:

  • ORD – displays your working order. You can modify or cancel your existing orders from this subs-column
  • BID –place your orders from this sub-column. Note that you can use this column for buy or sell order or both.
  • ASK – place your orders from this sub-column. Note that you can use this column for buy or sell order or both.
  • PR – price ladder
  • T – displays the last traded size.

Large Lot Tracker[edit]

Application[edit]

Bookmap can display an approximation of the largest single pending order at any price level if that order crosses a certain threshold. In order for the Large Lot Trade to be displayed it has to be at least 20% of the total order size at the relevant price level and at least 10% of width of the largest pending orders bar.

Large Lot Tracker is displayed by a vertical white line on the order bars on the COB column. The distance between the vertical line and the base of the bar is an approximation of the size of the Max Order.

White vertical lines indicating large order portion of total size


Interpretation[edit]

This feature can be utilized to identify the presence of a dominant market participant(s) at a certain price level.

Settings[edit]

Once enabled the Large Lot Tracker add-on is activated by clicking the studies panel icon above the chart and checking the “Largest Lot Tracker” checkbox. User can set the thresholds a single order must pass in order to be displayed as a large lot. There are two thresholds to pass: the size of the order relative to the total size at the relevant price level (Minimum percentage at price level) and the size of the order relative to largest total size at any of the visible order book levels (Minimum percentage in Order Book)

Enabling large lot display


Limitations[edit]

The Large Lot Tracker is not based on an exchange transmitted data but rather on an internal algorithm that approximates the largest single order at any price level. Therefore, it is not guaranteed 100% accuracy. It requires the COBB (current order book bars) to be defined as one of the user’s column selections.


Imbalance Indicators[edit]

Application[edit]

Application: The imbalance indicators are located on top right part of the chart. They display the Order Book Imbalance and the Volume Imbalance.

White vertical lines indicating large order portion of total size


Order Book imbalance represents the ratio between the average bid order book size versus the average ask order book size. The ratio is calculated as:

𝑁𝑢𝑚𝑏𝑒𝑟 𝑜𝑓 𝑎𝑐𝑐𝑜𝑢𝑛𝑡𝑏𝑙𝑒 𝑏𝑢𝑦 𝑜𝑟𝑑𝑒𝑟𝑠−𝑁𝑢𝑚𝑏𝑒𝑟 𝑜𝑓 𝑎𝑐𝑐𝑜𝑢𝑛𝑡𝑎𝑏𝑙𝑒 𝑠𝑒𝑙𝑙 𝑜𝑟𝑑𝑒𝑟𝑠
——————————————————————————————————————————————————————————————
𝑁𝑢𝑚𝑏𝑒𝑟 𝑜𝑓 𝑎𝑐𝑐𝑜𝑢𝑛𝑡𝑏𝑙𝑒 𝑏𝑢𝑦 𝑜𝑟𝑑𝑒𝑟𝑠+𝑁𝑢𝑚𝑏𝑒𝑟 𝑜𝑓 𝑎𝑐𝑐𝑜𝑢𝑛𝑡𝑎𝑏𝑙𝑒 𝑠𝑒𝑙𝑙 𝑜𝑟𝑑𝑒𝑟𝑠

Volume imbalance represents the ratio between the volume generated by buying aggressors (market order transactions on the offer) versus the volume generated by selling aggressors (market order transactions on the bid) The ratio is calculated as:

𝑁𝑢𝑚𝑏𝑒𝑟 𝑜𝑓 𝑎𝑐𝑐𝑜𝑢𝑛𝑡𝑏𝑙𝑒 𝑏𝑢𝑦 𝑣𝑜𝑙𝑢𝑚𝑒−𝑁𝑢𝑚𝑏𝑒𝑟 𝑜𝑓 𝑎𝑐𝑐𝑜𝑢𝑛𝑡𝑎𝑏𝑙𝑒 𝑠𝑒𝑙𝑙 𝑣𝑜𝑙𝑢𝑚𝑒
——————————————————————————————————————————————————————————————
𝑁𝑢𝑚𝑏𝑒𝑟 𝑜𝑓 𝑎𝑐𝑐𝑜𝑢𝑛𝑡𝑏𝑙𝑒 𝑏𝑢𝑦 𝑣𝑜𝑙𝑢𝑚𝑒−𝑁𝑢𝑚𝑏𝑒𝑟 𝑜𝑓 𝑎𝑐𝑐𝑜𝑢𝑛𝑡𝑎𝑏𝑙𝑒 𝑠𝑒𝑙𝑙 𝑣𝑜𝑙𝑢𝑚𝑒

The two imbalance indicators are calculated according to the current chart range. Any change to the chart range (either by dragging or by zooming in or out) will affect the readings of the imbalance indicators.

Iceberg Detector[edit]

Application[edit]

The Iceberg Detector add-on feature displays hidden volume as numbers on the COB column and as a number of hidden contracts on the heat map. Bookmap generates the iceberg indications based on the difference between the actual pending orders offered at that price level and the actual number of orders that transacted at that price level. For example, if the Iceberg Detector displays 43, this signifies that 43 more contracts were transacted than available in the order book at that specific time.

The display of the hidden orders on the COB is based on the chart viewable time range, i.e. the number of the hidden order displayed is the number of hidden order identified during the viewable chart range. In contrast, the display of the iceberg on the chart does not depend on a specific chart range and is placed at the relevant time and price on the chart.

Iceberg indications on the heat map


Interpretation[edit]

Traders can assess the possibility of hidden liquidity at certain price levels with the Iceberg Detector. Since hidden orders are usually associated with the activity of more sophisticated players, traders may also use this information to assess possible short-term price action and areas of resistance or support.

Settings[edit]

To enable it, click the studies panel icon above the chart and check the Iceberg Detector check box. Users can control the colors of iceberg indications for sell and buy orders. Users can also set voice alerts for icebergs and apply order size filter for the alerts. There are no settings for the Iceberg Detector.

Iceberg Settings


Limitations[edit]

The Iceberg Detector can only display hidden orders after the execution of those orders has taken place; it is not forward-looking. It cannot display hidden orders currently resting at specific price levels. As mentioned earlier the discrepancies are likely to occur on low-quality data. Even on colocation servers. High quality data and timing are very important for proper iceberg detection. We recommend to start from a setting of 5ms delay and test the results. In fact, the best option will be 0.5ms. For example, 50ms is quite a long time in the HFT environment. This should help filter out some noise.

Just note, that in general discrepancies will occur, this is the nature of the business and technology. To get very precise iceberg detection, it would require the highest quality data with a collocated dedicated connection directly at the exchange.

Correlation Tracker[edit]

Application[edit]

Using the Correlation Tracker traders can overlay several instruments on a single chart view to gauge the correlation between them. To open Correlation Tracker click the studies icon above the chart and check the Correlation Tracker checkbox. Then tick the Enable for current instrument checkbox and select the instrument(s) to be overlaid on the chart.

Interpretation[edit]

Traders can assess the correlation between two or more instruments and look for trading opportunities when instruments deviate from expected correlation.

Bookmap view with correlation tracker


Settings[edit]

Users can set the Correlation Tracker to reference mid-price or last trade and control the time resets for the overlaid instruments lines. Users can also set color and line shape for the overlaid instruments.

Bookmap view with correlation tracker


Limitations[edit]

Overlaid instrument must be subscribed to in order to be available for correlation display.

Bookmap API[edit]

Main page: Bookmap API

API Settings and UI[edit]

Some strategies may have to be configured by the user. Apart from a dirty way of creating a window directly from a strategy and displaying it (which should work) the user can integrate with Bookmap UI to some extent.

With current version your strategy can provide a panel that will be displayed inside strategies dialog similar to bookmap Studies window:

API strt.jpg


Others[edit]

Keyboard Shortcuts[edit]

There are several keyboard shortcuts that can be used instead of mouse action in Bookmap:

  1. CTRL+S to take a screenshot of the Bookmap chart.
  2. ESC to hide the configuration dialogues of the chart, colors, contrast and the log window.
  3. SPACE to pause/resume in Replay mode.
  4. Left/Right arrows in chart drag-mode to shift the chart pixel by pixel.
  5. Shift + Left/Right arrows in chart drag mode to shift the chart by 10 pixels increments.
  6. Right click on an empty space of the toolbar to find main window.
  7. CTRL+T opens instrument subscription window
  8. CTRL+W unsubscribe a specific instrument
  9. CTRL+TAB switch between subscribed instruments


Color value names[edit]

The following colors can be entered in the custom note import file with their names and not just their hex code:

  • Black
  • White
  • Red
  • Yellow
  • Green
  • Blue
  • Light
  • Blue
  • Cyan X
  • Magenta
  • Brown
  • Gray
  • Light gray


Special orders[edit]

Server-side vs Client-side[edit]

Platform Brackets Trailing Stop OCO
Ninja Client side Client side Client side
TWS Client side Client side Client side
S5 Server side Server side Server side
TT Client side Client side Client side
CQG Server side Server side Server side
Rithmic Server side Server side Server side
Transact Client side Client side Client side
Simulator Client side Client side Client side

OCO[edit]

For all platforms the price of a stop leg of an OCO cannot be modified to an invalid price, i.e. at or above the offer for a buy stop or at or below the bid for a sell stop

Size increase modifications of OCO orders is not allowed across all platform connections Allowed price changes can be done on each order individually.

Allowed size modifications (decreasing size) can either be done on each individual leg or is automatically updated to the other leg, depending on the platform connection, as detailed below:

Behavior Platform
Size change of one leg automatically updates the other leg S5
Each leg is modified individually, i.e. size modification of a single leg will not automatically update the other leg CQG
Size change of one leg automatically updates the other leg RIthmic
Size change of one leg automatically updates the other leg Ninja, TWS, TT, Transact, Simulator

Brackets[edit]

Bracket secondary orders behave as OCO orders, as detailed above

Trailing Stop[edit]

The trailing stop parameter controls the tick steps at which the stop order is updated Trailing stop will not apply to an entry stop order.

Trailing stop will not apply to a leading (primary) bracket order.

US Stocks dxFeed data by Devexperts[edit]

US stocks[edit]

Traders can connect Bookmap to dxFeed market data offered by Devexperts. As for July 2018 it is the only available US stocks data source over the internet with the institutional level of quality. Traders can connect Bookmap simultaneously to dxFeed market data and their Interactive Brokers account for trading. Connection to other brokerage platforms can be developed using the API under Bookmap Connect solution.

    What are the supported market data packages and what are the costs?
  • After subscribing to Bookmap, connect to your account here and select one or more of the following data subscriptions:
Feed Details Ref. Non-Pro Price Pro Price
Nasdaq Depth Nasdaq TotalView & Nasdaq Last Sale: Full market depth & Traded volume Read more $69 / mo $199 / mo
EDGX Depth Cboe/EDGX (BATS): Full market depth & Traded volume Read more $59 / mo $129 / mo
Premium bundle Includes a consolidation of the above feeds. Enable access to 15 symbols $119 / mo $329 / mo
    Remarks
  • Each of the feeds covers all US equities
  • Up to 24 hours of recent historical data merged into real-time data upon subscription to a new symbol. The resolution of recent historical data is 1 second.It consolidates the following:
  • Nasdaq TotalView FOD
  • Cboe/EDGX (BATS) FOD
  • When subscribing to more than 1 data source, the data sources will be consolidated to a single feed.


    How much does Bookmap cost and how do I purchase it?
  • First, you have to subscribe to Bookmap. Click here to subscribe.
  • Bookmap Global price starts at $39 / month (for longer-term plans)
  • Bookmap Global+ price starts at $79 / month (for longer-term plans)


    What data subscription combinations are supported?
  • Any combinations of the feeds: NasdaqTV, Edgx, NasdaqTV & Edgx consolidated books


    Can I trade with Bookmap and dxFeed US Equities data?
  • Yes. Connect to dxFeed data and trade via Interactive Brokers (IB) account from the same Bookmap chart.
  • For training, you can also use the Bookmap built-in simulator.
  • We plan to add connectivity to more platforms for trading US Equities in near future. If you have the preference for a specific platform, please let us know.


    Will there be dxFeed Futures data package available?
  • Real time Futures data package will be available soon.
  • If you wish to get Futures data, please fill in the support survey send email to support@bookmap.com


    What is the difference between Level I, Level II, Level III? What is the full market depth?
  • As opposed to Futures that are traded on a single exchange, Equities/Stocks are traded on several exchanges (ECN’s) in parallel. Using dxFeed Bookmap you will get insight into the full consolidated order depth and trades for the all US equities based on data coming from some of the most liquid US exchanges – NASDAQ & EDGX.
  • Level 1 data includes the Best Bid and Offer (BBO) prices and the last traded prices with the respective volumes.
  • Level 2 data in some cases refers to Level 1 from different exchanges, where the BBO may be different between the exchanges. In other cases, Level 2 may relate to the depth of the market with limited levels. E.g up to 10 levels.
  • Full depth data includes all available real-time bid and ask prices (on all levels) and also the last traded prices.


    What is the resolution of the data? Is the market data limited in depth levels?
  • dxFeed real-time market data feed contains the highest resolution for US equities and includes full depth of market data updates and all trades.
  • Unlike some of the Futures exchanges the number of transmitted depth levels is not limited.
  • Note that since the scope of data is extremely large, historical data is aggregated to 1 second


    What is the resolution of the data? Is the market data limited in depth levels?
  • We do not offer trials. You can test Bookmap by subscribing to our free version here.
  • Free Bookmap includes a delayed dxFeed. You will get access to many of Bookmap features. The exact delayed time will be displayed in the upper left corner of the Bookmap chart.


    Can I connect to the equities feed in parallel to Futures feed?
  • Yes. Bookmap enables multiple concurrent connections.


    Does it support MAC?
  • Not yet. Currently, only Windows is supported.
  • We’re working on MAC version that is planned to be launched in Aug.


    Is there a limit to the number of symbols I can get with the equities feed?
  • Yes, there is a limit of 10 symbols at a time. However, you can subscribe to any of the thousands of US equity symbols available -- all US equities and exchanges are available.


    Which credentials do I use for the equities feed?
  • You should use your bookmap.com credentials. The ones you got when you first subscribed to Bookmap.


    Can I record the depth data with Bookmap?
  • Yes, you can record the data with Bookmap and also use Bookmap Replay mode & simulator to replay the data for practice and analysis purposes.


    How reliable is this feed?
  • Devexperts provides data feed solutions for some of the big brokers, such as TD Ameritrade.
  • The equities market data feed is very reliable and have 99.99% uptime during trading hours.


    Can I use Bookmap from more than one PC?
  • You can run Bookmap on any PC that meets the hardware requirements. However, you cannot use Bookmap simultaneously on multiple PCs.
  • If you have an active session on a certain PC you will be able to terminate it once you log in to a second PC.


    Is ARCA/CTA/NYSE included into the dxFeed subscription?
  • Currently dxFeed provides Nasdaq and EDGX data only. If you wish to have additional market data connectivity, please complete the following survey Bookmap survey


    When will you add ARCA/CTA/NYSE?
  • During next two month Bookmap will add NBBO data, which will also include the top of ARCA book.


    Will I see the volume from ARCA?
  • No, you can’t see the volume from ARCA. Currently, we offer Nasdaq Total View and EDGX.


    What is the difference between Nasdaq and EDGX?
  • The order book for US Equities is much more complex than futures. There are several data providers such as Nasdaq, EDGX/BATS, ARCA, PSX, BX, etc. In Bookmap, DxFeed offer connection to two of these providers, Nasdaq and EDGX/BATS. Thus, you will not see all of the liquidity for each stock, but you will see a lot.


    You offer all CBOE depth or only just EDGX ?
  • Just EDGX. There is a special if you want to try both Nasdaq TotalView/Last sale and EDGX/BATS for $59 for the first month and then $119 afterwards.


    Is Nasdaq Total View montage itself: I could see EDGX as MM; then why you offer EDGX as a separate data feed ?
  • Nasdaq TotalView and LastSale does not include EDGX liquidity.


    What is the % of the total volume in US tickers that have these 2 options? how % each does have out of the total volume of tickers ?
  • This depends on the stock. For the overall market, We don't know the answer for percentages. ARCA also provides a lot but is very expensive. We may offer it in the future but I do not have any info on this.


    US brokers (IB , Etrade .. etc etc) offTotalView totalview, right ?
  • Regardless, you might be able to connect to stocks with IB in Bookmap, but you will not have access to the depth data. You would need to subscribe to dxFeed.

Custom Notes[edit]

How to upload Cloud Notes so other users can use it?[edit]

Here are the steps to upload cloud notes:

1) Create notes in Bookmap.

2) Save those notes using "Export notes" (you can change colors, sound alerts etc.)

3) Upload those to server in a way that provides direct link *

4) Feed the link to bookmap, make sure "Bookmap" notes format is selected.

5) Share with other Bookmap users

Example file: Cloud notes file

  • Direct link means that when request to that link made file is returned, not redirect, page, or any other stuff - just file. When direct link is pasted into browser file download will start immediately without redirect (url will change in address line if redirect happens). http->https redirect also counts as redirect, so make sure to use right link (https one) if server is configured to do http->https redirect.

If you're using google drive, use this link to convert from a shared file to direct link Google Drive Direct Link Generator It's important to set correct file permissions, otherwise it won't work.

The format of symbols in cloud notes should be only symbol name and expiry, as shown in Rithmic (e.g. 'ESM8')

To use FT71 notes on ES and CL, please use ESBookMapRefs.csv file

How to set local path to Cloud Notes[edit]

Local path "file:///" before the local path.

          Example: file:///C:\Bookmap\notes\FT71_Master_Levels.csv


Publish cloud notes on Google drive (or any data provider) so other users can use it - option 1[edit]

  1. Upload your .csv file to Google Drive (Not google spreadsheet)
  2. Share the uploaded file with anyone on the Internet
  3. Get a public link like this: CloudNotes_example
  4. Then generate a direct link via this site: Google Drive Direct Link Generator. It will be like this one: CloudNotes_example_File (id field is populated with part taken from initial link)
  5. Feed the direct link to Bookmap to the Cloud Notes downloading URL at the Cloud Notes Configuration Window.

For the pricing column, make sure the format is "text" format - this way separator should not be changed by google

Publish cloud notes on Google Drive (or any data provider) so other users can use it - option 2[edit]

Cloud Notes could be created in google docs table. It should have columns as for "Bookmap" format. This format used on export notes from BM. (see also remark above reg. the pricing format)

To use google docs table in BM you need to share it. Go to File > Publish to the web. Publish as csv file. Auto republish should be on. Publish guide: Publish Document

Use "Publish to the web" link in BM as usual Cloud Notes link.

Changes in table applied in 3-5 mins (delay on google side).

Publish cloud notes on OneDrive[edit]

Idea behind it is same as with all other methods - to get a direct link. Here is an article describing how to do it with OneDrive https://www.marstranslation.com/blog/how-to-make-direct-link-of-onedrive-files

So, the steps are:

  • upload a csv file to OneDrive
  • go to https://onedrive.live.com/ right click, select "Embed", generate code
  • you will get a code like this:

<iframe src="https://onedrive.live.com/embed?cid=....&resid=....&authkey=...." width="98" height="120" frameborder="0" scrolling="no"></iframe>