Message: SymbolCategory

File: WebAPI/symbol_browsing_2.proto

Description

Symbol category.

Used in

SymbolCategoryListByInstrumentTypeReport, SymbolCategoryListReport, SymbolCategoryReport

Fields

id

Type: string

Description: Category identifier.

Note: This identifier is not guaranteed to be stable, so categories should be obtained e.g., via SymbolCategoryListRequest or SymbolCategoryListByInstrumentTypeRequest instead of being saved using this id between sessions.

name

Type: string

Description: Category name.

description

Type: string

Description: Category description.

parent_id

Type: string

Description: Category parent identifier. Omitted for root categories.

Source: SymbolCategory.id of another SymbolCategory.

can_filter

Type: bool

Description: Indicates whether this category can be used as a filter for getting a list of symbols.

exchange_id

Type: sint32

Description: If the category is an exchange, then this field defines exchange id.

Source: ExchangeMetadata.exchange_id.

contributor_id

Type: string

Description: If the category is an OTC contributor then this field defines contributor ID.

instrument_business_type_id

Type: uint32

Description: If the category is an Asset Class, then this field defines instrument business type id. To get a list of all instrument business type id values, send a SymbolCategoryListRequest with category_id corresponding to Asset Class, then for each id from SymbolCategoryListReport’s symbol_categories field, send SymbolCategoryListRequest with this id as the value of category_id or send SymbolCategoryListRequest with a big enough depth parameter value (see SymbolCategoryListRequest.depth) to get all symbol categories.

deleted

Type: bool

Description: Deleted flag is used in updates when the category is removed or does not satisfy request criteria anymore (e.g., parent_id is changed).