Skip to main content
Version: v27

SearchSymbolResultItem

Interface

Symbol Search result item. Pass the resulting array of symbols as a parameter to SearchSymbolsCallback of the searchSymbols method.

Example

{
    description: 'Apple Inc.',
    exchange: 'NasdaqNM',
    full_name: 'NasdaqNM:AAPL',
    symbol: 'AAPL',
    ticker: 'AAPL',
    type: 'stock',
}

Properties​

description​

Description

Type​

​string

exchange​

Exchange name

Type​

​string

Optional

URL of image to be displayed as the logo for the exchange. The show_exchange_logos featureset needs to be enabled for this to be visible in the UI.

The image should ideally be square in dimension. You can use any image type which the browser supports natively. Simple SVG images are recommended.

Examples:

  • https://yourserver.com/exchangeLogo.svg
  • /images/myImage.png
  • data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...
  • data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...

Type​

​string

full_name​

Full symbol name

Type​

​string

logo_urls​

Optional

URL of image/s to be displayed as the logo/s for the symbol. The show_symbol_logos featureset needs to be enabled for this to be visible in the UI.

  • If a single url is returned then that url will solely be used to display the symbol logo.
  • If two urls are provided then the images will be displayed as two partially overlapping circles with the first url appearing on top. This is typically used for FOREX where you would like to display two country flags as the symbol logo.

The image/s should ideally be square in dimension. You can use any image type which the browser supports natively. Simple SVG images are recommended.

Examples:

  • https://yourserver.com/symbolName.svg
  • /images/myImage.png
  • data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...
  • data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...

Type​

​[string, string] | [string]

symbol​

Short symbol name

Type​

​string

ticker​

Optional

Symbol ticker name. Should be an unique id

Type​

​string

type​

Type of symbol

'stock' | 'futures' | 'forex' | 'index'

Type​

​string