====== Ticker Properties ======

===== Scan Syntax Reference: Ticker Properties =====

There are several ticker properties that you can set as filters for your scan. For more information on writing scans using these and other scan clauses, please see our Support Center article on [[:scans:advanced_scan_syntax|Writing Scans]].

===== Type =====

The specific kind of security.

**Syntax:**
  * type

**Acceptable Values: **
  * stock, index, fund, future

**Operators:**
  * is, is not, =, !=

**Example:**
  * [type is stock]


===== Symbol =====

The ticker symbol for the security. Use single quotes around the symbol or partial symbol.

**Syntax:**
  * symbol

**Operators:**
  * is, is not, =, !=, contains, not contains, starts with, ends with

**Example:**
  * [symbol starts with 'A']

===== Name =====

The name for the security. Use single quotes around the name or partial name.

**Syntax:**
  * name

**Operators:**
  * is, is not, =, !=, contains, not contains, starts with, ends with

**Example:** 
  * [name contains 'DOW']


===== Country =====

The country of the exchange where the security trades.

**Syntax:**
  * country

**Acceptable Values:** 
  * US, Canada, UK, India

**Operators:**
  * is, is not, =, !=

**Example:** 
  * [country is US]



===== Region =====

The geographic region where the security trades. Regions are broader areas than specific countries.

**Syntax:**
  * region

**Acceptable Values:** 
  * NorthAmerica

**Operators:**
  * is, is not, =, !=

**Example:** 
  * [region is NorthAmerica]

===== Exchange =====

The exchange where the security trades. (**Note:** ICE and CME values are for futures only, so if you combine [type=stock] with [exchange=CME], your scan will return no results. Similarly, CRYPT is for cryptocurrencies, which are classified as indexes, not stocks.)

**Syntax:**
  * exchange

**Acceptable Values:** 
  * NYSE, NASDAQ, OTCMKT, PINK, AMEX, TSE, TSXV, CSE, NSE, LSE, ICE, CME, CRYPT

**Operators:**
  * is, is not, =, !=

**Example:** 
  * [exchange is NYSE]

===== EPS (Earnings Per Share) =====

The last reported EPS value for the security.

**Syntax:**
  * EPS

**Operators:**
  * =, !=, >, >=, %%<=%%, <, is, is not

**Example:** 
  * [EPS > 1.00]

===== PE Ratio (Price-Earnings Ratio) =====

The last reported PE Ratio value for the security.

**Syntax:**
  * PE Ratio

**Operators:**
  * =, !=, >, >=, %%<=%%, <, is, is not

**Example:**
  * [PE Ratio > 15.00]

===== Market Cap =====

The last reported market capitalization value for the security. Market Cap is calculated by multiplying the security's current price by the number of outstanding shares. Market Cap is reported in millions, so a value of 10,000 means a market cap of $10 billion.

**Syntax:**
  * market cap

**Operators:**
  * =, !=, >, >=, %%<=%%, <, is, is not

**Example:** 
  * [market cap > 10,000]

===== Outstanding Shares =====

The last reported number of outstanding shares for the security. Outstanding Shares is reported in millions, so a value of 100 means 100 million shares.

**Syntax:**
  * outstanding shares

**Operators:**
  * =, !=, >, >=, %%<=%%, <, is, is not

**Example:** 
  * [outstanding shares > 100]

===== Optionable =====

Whether or not the security trades options. Scanning the options themselves is not currently offered.

**Syntax:**
  * optionable

**Acceptable Values:** 
  * true, false

**Operators:**
  * is, is not, =, !=

**Example:** 
  * [optionable is true]

===== Has Dividend =====

Whether or not the security pays dividends.

**Syntax:**
  * has dividend

**Acceptable Values:** 
  * true, false

**Operators:**
  * is, is not, =, !=

**Example:** 
  * [has dividend is true]

===== Dividend =====

The annualized dividend value for the security.

**Syntax:**
  * dividend

**Operators:**
  * =, !=, >, >=, %%<=%%, <, is, is not

**Example:** 
  * [dividend > 0]

===== Next Earnings Date =====
Scan stocks based on their next quarterly earnings date.

**Syntax:**
  * next earnings date

**Operators:**
  * >

**Example:**
  * [next earnings date > 20230831]

===== Previous Earnings Date =====
Scan stocks based on previous quarterly earnings date.

**Syntax:**
  * previous earnings date

**Operators:**
  * <

**Example:**
  * [previous earnings < 20230831]
===== Yield =====

The yield for the security expressed as a percentage. Based on the annualized dividend.

**Syntax:**
  * yield

**Operators:**
  * =, !=, >, >=, %%<=%%, <, is, is not

**Example:** 
  * [yield > 0]