Security
Each Security is represented by a unique name and refers to a grouping of symbols that can be configured together. Features that support security rules can apply settings to symbols in that group. More-specific symbol rules can take precedence, depending on the feature. Security has the following attributes and can be accessed via pending config or real-time config:
| attributes | required | default settings | attribute type | description |
|---|---|---|---|---|
| id | Y | – | INT | The ID of the Security. |
| type | Y | – | VARCHAR | The type of Security. Possible types are: • FX: This security refers to where various currencies and currency derivatives are traded. • CFD: A contract for differences (CFD) is an arrangement made in financial derivatives trading where the differences in the settlement between the open and closing trade prices are cash-settled. • CFD_FUT: CFD for Futures is a financial contract bound to a Future that pays the differences in the settlement price between the open and closing trades • CFD_INDEX: a contract for difference on an index. • CFD_STOCK: CFD for Stocks is a financial contract bound to a stock that pays the differences in the settlement price between the open and closing trades • CRYPTO: is a financial contract of digital or virtual currency that is secured by cryptography. • FUT: Futures are financial derivative contracts that obligate the parties to transact an asset at a predetermined future date and price. • STOCK: Stock security refers to a fungible, negotiable financial instrument that holds some type of monetary value. It represents an ownership position in a publicly-traded corporation via stock. Other supported types are FX_NDF, CFD_OPT and NDF. Type names must use the uppercase spelling shown. Supported types vary by provider and connector adapter. |
| name | Y | – | VARCHAR | The unique name assigned to this security. |
| description | N | – | VARCHAR | Free text for the description of the security. |
The effect of a security rule depends on the component using it and its matching rules. The use of specific providers may require the implementation of a different security type, which can include additional tags for configuration purposes.
Type-specific handling.
- FX: base and quote currency names must have three characters and the symbol name must start with them; connector instrument names must not match another FX symbol;
fokand the FX commission and swap variants apply; FX symbols starting with XAU, XAG, XPD or XPT are treated as metals. - FX and NDF: orders whose Currency (tag 15) is the quote currency are rejected.
- NDF: fixing date (tag 541) on FIX fills.
Individual LP and platform adapters can treat other types differently.