File: WebAPI/symbol_browsing_2.proto
Symbol structure.
It can represent either a product
(root symbol), a security, an option maturity or a contract (leaf symbol). Only
one of corresponding *_metadata fields can be specified. Each symbol except
product ones has a link to its parent (see Symbol.parent_symbol_id field):
parent symbol for a security symbol is a product symbol, parent symbol for a
contract symbol (non-option) is a security symbol, parent symbol of an option
strike contract symbol is an option maturity symbol, parent symbol for an option
maturity symbol is a security symbol.
ProductSearchReport, SymbolListReport, SymbolReport
Type: string
Description: Symbol Identifier.
Type: string
Description: Symbol readable name.
Type: string
Description: Symbol description.
Type: string
Description: Deprecated and should not be used. Use nested metadata messages.
Type: bool
Description: True if this symbol has child symbols (false for leafs of the symbol tree).
Type: bool
Description: Deleted flag is used in updates when the symbol is either removed (e.g., expired) or no longer meets request filtering criterias (e.g., SymbolListRequest.category_id filter).
Note: List of categories in category_id field (see below) may be cleared when symbol is removed.
last_trading_date (deprecated)
Type: sint64
Description: Deprecated and should not be used. Use nested metadata messages.
maturity_month_year (deprecated)
Type: string
Description: Deprecated and should not be used. Use nested metadata messages.
instrument_group_name (deprecated)
Type: string
Description: Deprecated and should not be used. Use nested metadata messages.
Type: string
Description: ID (Symbol.id) of the parent symbol (if this is not the root symbol - product). If this field is empty, product_metadata field is set.
Source: Symbol.id of another Symbol.
Type: string
Description: List of categories of this symbol, if any.
See: SymbolCategory, SymbolCategoryRequest.
Source: SymbolCategory.id.
Type: string
Description: Deprecated and should not be used. Use metadata_2.SecurityMetadata.source_instrument_group_name or metadata_2.ContractMetadata.source_contract_id instead.
Type: uint32
Description: Rank value of the symbol for sorting peer symbols in user interfaces. Higher value means greater priority.
Type: ProductMetadata
Description: Metadata of a product if this symbol describes one (aka Symbol Root Key). If this field is set, this symbol doesn’t have a parent symbol.
Type: metadata_2.SecurityMetadata
Description: Metadata of a security if this symbol describes one (aka Symbol Prefix Key).
Type: metadata_2.OptionMaturityMetadata
Description: Metadata of options maturity group if this symbol describes one (aka Option Lead Key).
Type: metadata_2.ContractMetadata
Description: Contract metadata if a symbol is a specific contract (leaf of the symbol tree).