Help Center
Our products knowledge base for customers
Aggregator Settings
Aggregator settings
The Aggregator settings
allow you to customize how, where and what instruments your client trades.
Aggregator Setting
DEFAULT are used in technical accounts where price feed and order execution are not required.
We recommend using the DEFAULT setting for Nominal
type accounts, i.e. technical accounts used as correspondent accounts for trades from Personal
and Real
type accounts.
General
In this section in the Name
field you can set the name of your setting.
In the Routing type
setting the default value is Account
.
The alternative value - Connector
is available only for platform administrators and is necessary to configure quotes flow routing and execution.
Routing type = Account
This Aggregator settings
type allows you to define what data you will provide to customers.
Click Add account
to select and configure the account from which you will receive prices.
Account source type
- type of account on which orders will be executed.
Name | Description |
---|---|
Abook | external execution |
Bbook | internal execution |
Indicative | the possibility to let the client see prices for instruments, but orders will not be accepted and executed |
Account ID
- Real
type account, from which the prices will be transferred to the clients' accounts.
SLIPPAGE PROTECTION PERCENT
- if the actual price in the platform differs from the price that came from the client in the market order by more than the percentage set in this field, the order will be rejected.
Override price
- this setting checks the price of the incoming market order. If it differs from the current price, the price in the order will be replaced with the current one before sending. Override price
allows you to overwrite the value of SLIPPAGE PROTECTION PERCENT
coming from the provider's account. On the Liquidity Provider side these values are not specified, i.e. LP will see the already edited values.
Close only instrument groups
allows selecting instrument groups for which only reduction of open positions will be available.
Show Instruments
allows you to view the list of instruments for a specific setting. In edit mode, you can also select or exclude groups of instruments to which the setting will be applied:
The search functionality allows you to quickly find the desired instrument within a group.
To apply the configured filter of included and excluded instrument groups, click the Apply Included and Excluded Groups button.
The Manual execution conditions
setting allows you to specify the quote amount threshold at which orders will be sent for manual execution. Orders below that threshold will be executed automatically.
ABook execution configuring
In the Account source type
field select ABook
.
In the Account ID
field select an external account (the filter on provider accounts is set by default) to which clients' orders will be sent for execution. When the provider account is selected - you will see the number of instruments available for this account and can customize them in Show instruments
.
Example: you have OneZero, NTPro and IRESS provider accounts that are already configured in the platform. You want to configure the client to be able to trade CFDs on all instruments. CFDs are held in the OneZero account. Accordingly, to see the groups of instruments available for trading in this stream, you need to select the OneZero account in the list.
If you need to reduce the number of trading instruments available to your client (you can't add, only reduce!), you can select groups from the existing ones or create a specific group filled with excluded instruments to be involved.
Example: you can create a separate instrument group with only two specific instruments and select it. For example, create a group of USOil and SP500, excluding other instruments, and then you will be able to trade with only these instruments.
IMPORTANT: A separate routing must be set up for each provider. If there is more than one client and it is necessary to allow one of the clients to trade all instruments from all providers, a separate routing must be created for each provider.
Example: you have a “OneZero” provider that provides only CFDs and a “VetolNet” provider which provides only Forex. Accordingly, you need a stream for each of these provider accounts.
BBook-execution configuring
Bbook is the execution of client orders within the system, without transferring them to liquidity providers. However, it is still necessary to receive a price stream from the liquidity provider, which the system will use to execute trades. In the platform, BBook execution occurs as follows:
After the order has been accepted for execution (i.e. all checks on the client account have been passed), the order is transferred to the BBook account. On the BBook account the TTL (time of life) of the price is checked. If the check is positive, the order is executed. If the check is negative - the order gets the status Rejected
with the No quotes
comment.
Important! If theSkip order margin check
setting is enabled on the client's account - the check for margin collateral sufficiency is performed only after checking the TTL price on the BBook account. Accordingly, in this case, the order may not be executed if there is not enough margin collateral on the client's account for its execution. In this case, the order will move to theRejected
status with the commentNo margin available
.
Once the order is executed, two trades occur in the platform, one for the client's account and one for BBook's account with a reverse sign.
Example: A client bought 1,000 EUR/USD. In this case, the BUY 1000 EUR/USD trade will be displayed on the Client's account, and the SELL 1000 EUR/USD trade will be displayed on the BBook account.
1. Creating Aggregator settings
for the BBook account.
Account source type
= Indicative
should be selected, because this type of account needs only indicative prices, which will be executed inside the platform.
Account ID
- here it is necessary to select the provider account (Real), from which the price flow will go to BBook account and further to the accounts of clients, who have BBook-execution configured.
Important: All Account IDs
of Real accounts, which receive prices for the required instruments, must be added to the setting.
It is also necessary to enable the BBook executor
setting for all added Real accounts - this will allow orders to be executed and will also open additional settings. Click Edit
to make the necessary changes and turn on the BBook executor
:
-
Group orders interval (ms) - if less time has elapsed between orders with the same trade side and volume for the same instrument than the time specified in this setting, they will be grouped and executed together.
-
Same price interval (ms) - guarantees that if between the orders with one side of the trade and volume for one instrument less time has passed than the time specified in this parameter, such orders will be executed at the same price.
-
Execute any volume
- allows accounts with this aggregator setting to close positions regardless of liquidity in the stack. -
Override instrument sets
- allows to set individual settings for each instruments group (after saving changes in the current sidepage): -
- separate
Schedules
- schedules of the trading calendar.
- separate
-
- separate
Order type set
- set of order types available for trading.
- separate
-
Active sessions
- sessions available for trading. If no session is selected, all sessions will be selected as available for trading.
-
- separate
MPI
(Minimum Price Increment) - minimum possible price change.
- separate
-
- separate
Min. order size
andMax. order size
.
- separate
-
Stop limit prohibited range
- prohibits placing SL/TP orders close to the market price. If the price in the order is closer to the market price by a value greater than the value specified in this field, the client will not be able to place the order.
Descriptions of the several parameters such as Override value date
and Override commission
are given in the description of the subsection Routing type = Connector
of this article.
When finished editing, press CREATE
or SAVE
to save the created / edited setting.
2. Creating and setting up an account for BBook-execution
To create this type of account, go to Access ➝ Accounts
section, click Create account and make the following settings:
Name | Description |
---|---|
Client ID | profile of the broker for which the account is created |
Accounting type | Personal |
Management type | Brokerage |
Provider ID | the profile of the quotes provider. Orders of clients with a configured BBook execution will be executed on the BBook account of this provider |
Aggregator settings | here it is necessary to specify the setting created in the previous section of the instruction |
** Please note!** You will not be able to trade on this account, as it receives only indicative prices. For trading, you need to create a separate account (or select an existing one) and apply the setting from the next step to it.
3. Aggregator settings for the accounts with BBook execution
Next, it is necessary to create the Aggreagtor Setting for the accounts of clients with BBook-execution. In this setting it is necessary to select Account source type
- BBook
, and in the Account ID field
- select the internal account for BBook-execution (created at the previous step).
Please note! To trade on BBook, it is mandatory to have this setting applied to the client account.
Configuring Indicative account source type
For Account source type
- Indicative
, the logic for configuring the ABook implementation is used, as described in the corresponding subsection of this manual.
Please note! For the Indicative
type setting, there can be no order execution by default. Prices will be displayed, but orders will not be executed.
Configuring Manual account source type
If Account source type
is set to Manual
, orders will be sent to the provider for execution only after manual processing of the request.
Please note! When manually executing requests, the following logic of markups configured in tariffs is applied:
- For buy trades on A-book accounts and sell trades on B-book accounts: the price of the instrument on the provider account is calculated as the price of the instrument on the client account minus the markup size set for it.
- For sell trades on A-book accounts and buy trades on B-book accounts: the price of the instrument on the provider account is calculated as the price of the instrument on the client account plus the markup amount set for it.
TTL (Time-To-Live) of the quote
TTL (Time To Live) - time to live of the quote. Quote - current price announced by the seller or buyer, at which trading participants are ready to sell or buy the instrument. Server time - time of the world NTP-servers. Local time - time on the device of the current user. Delta Δ - difference between server time and local time.
When receiving the first instrument quote for validation, the TTL of the quote is compared with the current local time considering delta. If the quote time is not included in the interval equal to the TTL of the instrument, the quote is considered as expired and is hidden from the user. Otherwise, if the quote is not the first one, the timer is starting for the time equal to TTL with delta correction, or, if TTL is less than one second, without correction. After that the quote will be deleted as expired. The timer is updated when a new quote is received.
Also, after the first appearance of quotes, a timer that checks the quote every 2 seconds is starting.
- If the TTL of the instrument is 5 or more seconds, then after 2/3*TTL the price is coloring yellow and a tooltip with the amount of time elapsed since the quote was received appears in place of the spread.
- The warning displays if more than a minute has elapsed since receiving the quote.
When TTL expires, the quote is deleted and the warning is erased.
If TTL is not set, the system considers the last received quote valid.
You can always initiate a connection update with a price subscription as follows:
- When reloading the page (F5).
- When activating the browser tab where the prices are displayed (switching from another window, unfolding the browser).
- every 20 minutes.
- When reconnecting the Internet connection.
In Ticket:
- When switching instruments
- When changing the tenor of an instrument
- When changing the value in the
Amount
field - When changing the stream
- When inverting a currency pair (icon between tickers)
- When changing
Pricing mode
in user settings - When changing the data refresh rate in user settings
In Watchlist:
- When deleting/adding an instrument
- When switching the tab of the Watchlist
- When changing the value in the
Amount
field - When changing the tenor of an instrument
- When changing the stream
- When changing
Pricing mode
in user settings - When changing the data update frequency in user settings
Specifics of TTL application at B-book execution:
- If TTL is set, then at the moment of order receipt on the B-book account the system checks when the last quote was received, if TTL is exceeded - the system waits 10 seconds for a new quote, if it does not come, the order is switched to the Rejected status.
- If TTL is not set - then the last quote is considered valid, independently of the time of its receipt in the system.
With the TTL setting disabled, execution may proceed at the old price.
Example: One price has been in the system for 20 seconds. If TTL is not set, execution will occur at the price that was in the system during that time. If TTL is set on 5 seconds, for example, and there is no new price in the system during this time, the order will be rejected.
Please note: Market orders have a lifetime of 10 seconds. If in that time a price satisfying TTL does not appear within 5 second period - the order will be rejected. If TTL is not set, the order will be executed at the price that has been pending for 20 seconds (in our example).
If the new price comes from the liquidity provider when resubscribing, the new price is displayed; if the new price does not come, no price is displayed.
Instruments export
You can export (download) the set of the instruments included in your Aggregator setting in .xls
format by clicking SAVE AS XLS button.
The table contains the next information about instruments included in your Aggregator setting:
Name | Description |
---|---|
Instrument ID | Unique number of the instrument |
Ticker | Instrument's ticker |
Code | Instrument and its exchange code |
Category | Instrument's category |
AssetType | Asset type of instrument |
Tenor | Instrument's tenor (one per line) |
Exchange | Exchange code |
Account ID | The ID of the account that provides the prices |
Account name | The name of the account that provides the prices |
The final .xls
table contains instruments divided into groups by using empty rows.
By clicking DUPLICATE you can create a copy of your current setting.
To save your new or edited setting click SAVE in the bottom right of the screen, CANCEL to cancel the changes and SHOW USAGE to view on which accounts this setting is used.