Work with instruments
The Instrument Escort is a tool that helps you to manage instruments and instrument lists. In order to receive data for particular instruments and to be able to trade with them, the necessary instruments must be imported into the Instrument Escort.
You can use the Instrument Escort to:
- select instruments and instrument lists
In order to open the Instruments window use one of the options:
- 1.Select Instrument Escort by using Tools -> Settings or
- 2.left-click the symbolin the application toolbar within the main window.
This window consists of the following parts:
- Search for a symbol/name:
- enter the symbol (e.g. GOOG), the full name (Google Inc.), or the ISIN number (US38259P5089).
- double-click on the search result to select the instrument and bring up the Instrument details tab.
- enter type of symbol (e.g. future, stocks, index, etc)
- enter exchange (e.g. Nyse)
- Selection list tree:
- Choose single instruments or whole instrument lists for further editing.
- Details tab:
- Add new instruments or edit existing instruments within the details tab.
- Instrument lists tab:
- Add or manage instrument lists within this tab.
Note: Fractals are only available for the Futures. It is the default setting in the right area of the window, yet disappears when you have chosen an instrument other than futures.
The Instrument Escort selection list tree displays 3 additional lists:
- Static Lists: lists created or edited by a user. Using the Preferences you can connect chart groups with the static instrument lists if necessary. This means that changing values within the list chart group or the tab chart group will automatically change your static lists and vice versa.
- Dynamic Lists: predefined lists that are updated automatically (if there is an internet connection).
The context menu of the selection list tree section can be accessed by right-clicking and allows the following
- Reset checkboxes: deletes all checkbox markers.
- Reload: reloads the Instrument Escort. This may be necessary after a new instrument has been added.
Left clicking on the instrument name within the chart opens the Instrument Escort window.
To add a new instrument to a chart follow these steps:
- 1."Activate" the chart by left-clicking on it.
- 2.Once you start typing letters using the keyboard, the instrument search window will be opened.
- 3.After selecting the instrument needed and pressing 'Enter' (or double-clicking) the new chart will be displayed.
If you open the Instrument Escort to choose instruments/instrument lists (tick record, Forex pad, etc.) then only the section with the selection list will appear. Press the Select button or double-click to choose a single instrument or whole instrument list.
The following actions can be carried out using the Import/Export button within the Instruments window:
Description of the functions:
Select Markets + Mappings menu item:
- Import from File: imports instruments from a CSV file
- Import from Dialog: inserts symbols that satisfy the same criteria.
- Import Mappings: imports mappings from a CSV file.
- Import Instrument Lists: imports instrument lists from a CSV file.
The name of the *.csv file will be suggested as the instrument list name. Importing will not overwrite existing lists but will simply add instruments from the *.csv file that are not included in the instrument list. However, importing will overwrite existing instruments (details will be updated).
- Import from Instruments DB XML Snapshots: creates a backup file of instruments. More information in the section: How to backup the instrument database.
- Export Instruments to XML Snapshot.
This section explains which formats are supported when importing instruments and mappings from a CSV file.
Each instrument traded or analyzed within TradersYard X must exist in the Instrument Escort. Currently, the TradersYard X database contains approx. 7000 instruments of all types (stocks, futures, etc.).
The following attributes can be imported into TradersYard X: - <Symbol> - The instrument's exchange symbol - <Name> - Instrument name - <Margin> - %-margin for a leveraged instrument (see below) - <PointValue> - Value per point - <TickSize> - Tick size - <MainSector> - Sector of economy (for stocks) - <DetailSector> - Industry (for stocks) - <InstrumentType> - Instrument type (see selection list in the Details tab) - <Exchange> - Exchange (see selection list in the Details tab) - <ETF> - Exchange Traded Fund: true / false - <Currency> - Currency (see selection list in the Details tab) - <Expiry> - The instrument's expiration date (futures) – Format example: 06.2014 (mm.yyyy) - <ISIN> - tbd - <DefaultOrdersize> - tbd
If a margin is different for various brokers, you can edit it using the Mapped symbol column in the Details tab.
The following formatting is required for a CSV file:
- 1.The first cell must contain the tag <Import Instrumens>
- 2.Below this tag there are <Attributes> and <Instrument> rows.
- 3.The <Attributes> row causes a change of attributes for the following <Instrument> rows.
- 4.The <Instrument> row may also include attributes.
Using "FromYahoo": you may often face situations in which you have an instrument list and know its base currency, instrument type, etc. but are missing information such as the traded exchange or a symbol name. You can solve this problem by simply retrieving the required information from the internet. When you enter <Name>FromYahoo or <Exchange>FromYahoo this information will be imported from the Yahoo database.
CAUTION! Should you need to import a large number of values, then this may take quite a long time. Importing 1000 instruments will take approximately 10 minutes.
There is a difference between importing instruments and instrument lists. Instrument lists are lists of symbols that have been assembled for a specific purpose e.g. long lists/short lists etc. When you import a list such as this, the corresponding symbols must already exist in TradersYard X.
The following formatting is required for a CSV file:
- 1.The first cell must contain the tag <Import Instrument list>
- 2.Below this tag, all symbols needed must be listed.
An example of the format for the import of mappings from a CSV file:
Examples of importing instrument and instrument lists:
Export Mappings Example
Inside the tab Instrument lists of the Instrument Escort, you can create or edit existing instrument lists.
In order to create a new instrument list follow these steps:
- 1.Assign the name for a new list manually.
- 2.Add instruments using one of the following methods:
Manual entry in the "Symbol" cell
Important note. You can also create a blank list by leaving this cell empty. However, you can only use a blank list as an LCG (list chart group).
Drag and drop:
- from the instrument search section
- from the list selection tree:
- single values
- instrument lists.
Clicking or double-clicking the checkbox will select an instrument/instrument list, after which you can drag it into a new instrument list.
3. Click the Save button to add the new list to the list selection tree. Once finished, the list will be available for editing within the static lists in TradersYard X.
If you wish to create a new list (for example, from the scanner), then the name of the instrument list will be pre-initialized with <New List> or empty. The instrument list cannot be saved in either of these states. If you choose an existing name, this instrument list will be overwritten.
Additional functions are available under the Instrument lists tab:
- Delete All: Clicking the arrow next to "Delete All" opens a drop-down menu where you can choose between Delete All Instruments or Instrument Lists. Delete All Instruments removes all instruments from the instrument manager. Delete All Instrument Lists removes all instrument lists from the instrument manager.
- Remove List: deletes only the list
- Export list: exports the symbol names into a CSV file
- Exp. Instruments: exports the symbol names and all corresponding data into a CSV file
- Save: saves the instrument list
- Remove: removes one or more marked instruments from the list (this can also be achieved by clicking the Delete button)
- Synchronize: opens a new settings window that enables you to assign the same value to all entries in the list according to the specific instrument properties
- Clear: removes all instruments from the list
You can edit Instrument lists outside the Instrument Escort using the following functionalities:
- Click the Instrument list buttons in the action bar to make the necessary changes. These buttons will be displayed once you add them from the Action bar settings under the menu item Instrument List.
Once an instrument's symbol is red, the instrument from the current chart will be added to the list. By clicking the button it can be added to as well as deleted from the corresponding list.
- Add an instrument to an instrument list with theicon in the chart toolbar.
- The scanner has a multi-select function that allows you to add several instruments to a list in one go.
You can define your favorite instrument list by selecting the corresponding icon in the chart toolbar and checking the Fav. a checkbox in the popup. The favorite instrument list will be offered as the first option whenever a new LCG/TCG is created.
A large number of instruments are already mapped in TradersYard X. If a certain instrument does not exist in the Instrument Escort then you can add it manually.
To add a new instrument, select an instrument of the same type (stock, Future, etc.).
Usually, it is sufficient to:
- 1.Enter the symbol, name of the instrument, or its ISIN number.
- 2.Select the exchange:
- 1.the correct exchange input is highly important in order to access the appropriate trading hours (Marketplace Escort and tab Trading hours) and organize charts.
- 3.Adjust the def. order size in the Preferences. Any value higher than 0 replaces the default setting for the order size.
- 4.Adjust the mappings for a new instrument using a mapped symbol (see examples in the forum below)
Additional fields are:
- Instrument type: allows you to define a new instrument as one of the following types:
- Currency: pertains to the currency in which the instrument is traded. It is necessary to perform currency conversions in TradersYard X for the correct P&L display.
- Margin (security %): must be entered for leveraged products and represents the general margin for the instrument. This value may vary depending on the broker. If this is the case, the margin must be entered in the broker-specific list (in the Instrument Escort window within the Details tab).
- Tick size and point value are necessary for various calculations such as stop price, P&L calculation, etc.
- If the main sector or details sector is entered, an instrument will be displayed inside the appropriate submenu of the selection tree in the InstrumentEscort.
Press the Add/Save button to register a new instrument in the system or edit the existing instrument.
Different brokers/data feed providers may use different symbol names and offer different margins for leveraged instruments.
You can enter their specific characteristics manually in the list within the details tab.
In addition, you can set commission manually by adding this info to the InstrumentEscort in the Mapping Area using the "C" Button:
The mapped symbols entered within the details tab will be used internally by TradersYard X. If the same symbol is used by other brokers/data feed providers, this mapping will not take place. The name (symbol) AAPL (Apple Inc. stocks ) is used by the majority of brokers and does not need an additional label/identification in the list. Different labels/names exist primarily in the Futures and Forex markets.
In case symbol mapping for Teletrader is incorrect please follow these steps:
- Then go to the details and you'll see the ID in the browser address bar.
- After just copy the ID and paste it to the symbol field in Instrument Escort opposite Teletrader datafeed.
- Click Save button
Adjusting the tick size for CFDs according to the current price
Please note that Interactive Brokers uses different tick size parameters according to the particular price range. When trading some European CFDs, it may occur that users receive the following error messages: 1. "The price does not conform to the minimum price variation for the contract". 2. "Instrument Tick-Size is not yet calculated or delivered". In order to continue the trade, it is necessary to adjust the tick size for the instrument manually.
Then enter the tick size in the Instruments window according to the current price, and check the checkbox Fixed as shown in the figure below:
The expiry date of your futures contract is visible in the upper left corner of your chart.
In order to change the expiration date of a futures contract:
- 1.Open the Instrument Escort from the chart by clicking on the instrument symbol or by using the main menu Tools -> Instrument Escort
- 2.Find the desired instrument using the Symbol search cell to the instrument selection tree
- 3.Change the expiry date in the Contract cell in the Details tab
In addition, you have the possibility to change the contract date in Futures Calendar. Simply right-click on the Contract field for the symbol in which you are interested:
Continuous Contract is the default setting. If any of the three available options are selected, a number 1-3 will be added to the Mapped Symbol.
Definition for contracts:
Continuous CC = continuous contract FrontMonth FM = actual contract according to the calendar only Next = upcoming contract according to calendar NextOn = contract after next according to calendar
Setting options are quite similar or even the same for Teletrader and Taipan.
As described in the Taipan connection guide, you can select in account settings if you want to use "CC" or "FM" contracts. Whatever is selected there, will be regarded as the default setting for all mappings.
Changing the expiration date
If you wish to extend the existing expiration date to the next expiration date for an FDAX instrument, you must disconnect all data feed and broker connections. After changing the expiration date and reconnecting you will see the data from the new futures contract.
The same instrument with a different expiration date
If you wish to see both expiration dates for a futures contract for the same instrument follow these steps:
- 1.Find the desired futures contract in the Instrument Escort.
- 2.If, for example, you wish to see FDAX 09.JJJJ and FDAX 12.JJJJ simultaneously, change the name of one of these instruments (e.g. to "FDAX-NEXT") and set the new expiry date as 12.JJJJ, then click the Save button.
By doing so you create the FDAX with the Contract date 09.JJJJ and the FDAX-NEXT with the expiry date 12.JJJJ, both of which can now be found within the instruments.
Volume Based Rollover
In Futures Calendar (Tools -> Accessories -> Futures Calendar) expiry with the highest Volume will be marked yellow (in case you haven't set it yet for the selected instrument). After checking your instrument in Futures Calendar you can easily switch to the most popular expiry.
In order to get up-to-date data, you need to import mappings for CME Manager first. Simply select Tools -> Settings -> Instruments: Markets and Mappings, activate CME Manager, and select Import:
You can create an instrument database backup using the Instrument Escort.
Clicking the Import/Export button followed by the Export Instruments DB to XML Snapshot submenu will prompt you to select a directory, where the backup file will be saved in XML format. To restore, click on the Import/Export button and select Import from Instruments DB XML Snapshot. After choosing the XML file the instruments will be imported.
Please note the following when importing the instruments:
- Existing instruments will be updated.
- Instruments in the Instrument Escort will not be overwritten if they are not included in the XML file.
- Instruments from the XML file will be added if they are not included in the Instrument Escort.
- All mappings and instrument lists from the Instrument Escort will be deleted and replaced with entries from the XML file.
CAUTION. Depending on the size of the instrument database the Import/Export process may take a while.