Manage the instrument catalog¶
Maintain the system-wide instrument catalog: add instruments, set how each one trades, configure swap and leverage defaults, and upload the flag icon traders see.
Prerequisites
- Your role grants access to the instrument catalog — this is a system-level page, and its values are the base defaults that every firm and trading term inherits.
The instruments grid¶
Open Instruments in the sidebar. Every instrument known to the price feed appears as a row, with its latest quote. The grid is edited like a spreadsheet: double-click a cell to change it (or right-click to apply a value across a selected range), then click Save to commit all pending edits together — Cancel discards them. A search box above the grid filters rows.
Columns include:
- ID, Source, and Symbol — read-only identity; the ID links to the instrument's detail page.
- Name — an optional display name. When set, it replaces the symbol everywhere, including in WebTrader, and must be unique.
- Type, and for forex instruments a Base currency and Counter currency.
- Contract size, Pip, and Digits — the contract and price precision defaults.
- Tradability — whether the instrument is full-trade, close-only, or non-tradable.
- Execution mode — Market, Instant, or Request (Request currently behaves the same as Instant).
- Status — Active or Deleted.
- Trading session and Symbol group — see Market hours.
- Leverage, Flag, and Swap policy — composite cells that open small editors (described below).
- Limit/stop level, Margin requirement, Min lot, Max lot, and Lot step.
- Hidden — hides the instrument from default instrument lists.
- Bid, Ask, and Last tick — the latest quote, read-only.
Add an instrument¶
- Click Add instrument.
- Under identity, choose the Source, enter the Symbol (the per-source ticker, such as EURUSD), and optionally a Name and a Type. For a forex type, set the Base currency and Counter currency.
- Choose a Symbol group (the filter category shown in the WebTrader rates panel) and a Trading session (drives the open/close schedule and holiday calendars).
- Set the global defaults: Contract size, Display digits, Tradability, Execution mode, Pip digit, Limit/stop level, and Margin requirement.
- (Optional) Tick Set base swap default and fill in the swap policy (see below).
- Click Create.
Configure a swap policy¶
The swap editor appears wherever a swap policy can be set — on the catalog's Swap policy cell, in the add dialog, and on the detail page.
- Tick Set base swap default (unticking it clears the policy).
- Choose the Swap type — Pips, Amount, or Percent.
- Enter the Long and Short values in the chosen unit.
- (Optional) Tick Apply weekday multipliers and set a multiplier per weekday — for example, a triple charge on the day that covers the weekend, and zero on non-trading days.
Assign leverage rules¶
The Leverage editor offers two mechanisms, used together or alone:
- Pick a leverage group from the Use a leverage group dropdown; options are grouped into your workspace's own groups and inherited ones. Leave it unset to inherit from the leverage cascade.
- Tick Specific leverage to set a direct rule, choosing a Type:
- Relative multiplier — multiplies the account leverage; for example, a 0.5 multiplier turns 1:100 into 1:50.
- Fixed leverage — a fixed "1:n" ratio for this instrument.
- Fixed by lots — a flat margin amount required per lot, in the instrument's base currency.
If both are set, the specific rule overrides the selected group.
Upload a pair flag¶
The Flag editor shows a round preview of the icon displayed next to the symbol in the WebTrader rates panel.
- Click Upload SVG and pick an SVG file (up to 256 KB).
- Click Save to apply. Use Remove (or Reset to inherited) to drop a custom flag.
The instrument detail page¶
Click an instrument's ID to open its detail page, which edits the same fields as the grid, organized into cards: trading session, symbol group, leverage, flag, global defaults, trading volume (min/max lot and lot step, with a Clear button), risk defaults, swap policy, and name. The page also shows the record's audit history.
Note
Catalog values are the base of a cascade: a firm can override them per instrument (see Instrument overrides), and a trading term can override the firm's values in turn (see Trading terms). Leave a value unset here only if you intend every firm to define it themselves.