marketdata

Search for Symbols

Changed on

Searches symbols based upon input criteria including Name, Category and Country.

get/v2/data/symbols/search/{criteria}

Request

  • Base URL
    https://api.tradestation.com
  • Auth
    • OAuth 2
      Authorization codehttps://api.tradestation.com/v2/security/authorize
      Token URLhttps://api.tradestation.com/v2/security/authorize
      Scopesmarketdata
    • or OAuth 2
      Client credentials
      Token URLhttps://api.tradestation.com/v2/security/authorize
      Scopesmarketdata

Path parameters

criteriastring required

Criteria are represented as Key/value pairs (& separated):

N: Name of Symbol. (Optional)

C: Asset categories. (Optional) Possible values:

  • Future or FU
  • FutureOption or FO
  • Stock or S (Default)
  • StockOption or SO (If root is specified, default category)
  • Index or IDX
  • CurrencyOption or CO
  • MutualFund or MF
  • MoneyMarketFund or MMF
  • IndexOption or IO
  • Bond or B
  • Forex or FX

Cnt: Country where the symbol is traded in. (Optional) Possible values:

  • ALL if not specified (Default)
  • US
  • DE
  • CA

For Equities Lookups:

N: partial/full symbol name, will return all symbols that contain the provided name value

Desc: Name of the company

Flg: indicates whether symbols no longer trading should be included in the results returned. (Optional) This criteria is not returned in the symbol data. Possible values:

  • true
  • false (Default)

Cnt: Country where the symbol is traded in. (Optional) Possible values:

  • ALL if not specified (Default)
  • US
  • DE
  • CA

For Options Lookups:

(Category=StockOption, IndexOption, FutureOption or CurrencyOption)

R: Symbol root. Required field, the symbol the option is a derivative of, this search will not return options based on a partial root.

Stk: Number of strikes prices above and below the underlying price

  • Default value 3

Spl: Strike price low

Sph: Strike price high

Exd: Number of expiration dates.

  • Default value 3

Edl: Expiration date low, ex: 01-05-2011

Edh: Expiration date high, ex: 01-20-2011

OT: Option type. Possible values:

  • Both (Default)
  • Call
  • Put

FT: Future type for FutureOptions. Possible values:

  • Electronic (Default)
  • Pit

ST: Symbol type: Possible values:

  • Both
  • Composite (Default)
  • Regional

For Futures Lookups:

(Category = Future)

Desc: Description of symbol traded

R: Symbol root future trades

FT: Futures type. Possible values:

  • None
  • PIT
  • Electronic (Default)
  • Combined

Cur: Currency. Possible values:

  • All
  • USD (Default)
  • AUD
  • CAD
  • CHF
  • DKK
  • EUR
  • DBP
  • HKD
  • JPY
  • NOK
  • NZD
  • SEK
  • SGD

Exp: whether to include expired contracts

  • false (Default)
  • true

Cnt: Country where the symbol is traded in. (Optional) Possible values:

  • ALL if not specified (Default)
  • US
  • DE
  • CA

For Forex Lookups:

N: partial/full symbol name. Use all or null for a list of all forex symbols

Desc: Description

Note:

  • The exchange returned for all forex searches will be FX
  • The country returned for all forex searches will be FOREX

Response

Symbol Search Response

Categorystring

The type of financial instrument that the symbol represents, such as a stock, index, or mutual fund.

Country'US' | 'DE' | 'CA'

The country of the exchange where the symbol is listed.

Currency'USD' | 'AUD' | 'CAD' | 'CHF' | 'DKK' | 'EUR' | 'DBP' | 'HKD' | 'JPY' | 'NOK' | 'NZD' | 'SEK' | 'SGD'

Displays the type of base currency for the selected symbol.

Descriptionstring

Displays the full name of the symbol.

DisplayTypenumber

Symbol's price display type based on the following list:

  • 0 "Automatic" Not used
  • 1 0 Decimals => 1
  • 2 1 Decimals => .1
  • 3 2 Decimals => .01
  • 4 3 Decimals => .001
  • 5 4 Decimals => .0001
  • 6 5 Decimals => .00001
  • 7 Simplest Fraction
  • 8 1/2-Halves => .5
  • 9 1/4-Fourths => .25
  • 10 1/8-Eights => .125
  • 11 1/16-Sixteenths => .0625
  • 12 1/32-ThirtySeconds => .03125
  • 13 1/64-SixtyFourths => .015625
  • 14 1/128-OneTwentyEigths => .0078125
  • 15 1/256-TwoFiftySixths => .003906250
  • 16 10ths and Quarters => .025
  • 17 32nds and Halves => .015625
  • 18 32nds and Quarters => .0078125
  • 19 32nds and Eights => .00390625
  • 20 32nds and Tenths => .003125
  • 21 64ths and Halves => .0078125
  • 22 64ths and Tenths => .0015625
  • 23 6 Decimals => .000001
Errorstring

Element that references error.

Exchangestring

Name of exchange where this symbol is traded in.

ExchangeIDnumber

A unique numerical identifier for the Exchange.

ExpirationDatestring

Displays the expiration date for a futures or options contract in UTC formatted time.

ExpirationTypestring

For options only. It indicates whether the option is a monthly, weekly, quarterly or end of month expiration.

  • W - Weekly
  • M - Monthly
  • Q - Quartely
  • E - End of the month
  • "" - The term not be identified
FutureTypestring

Displays the type of future contract the symbol represents.

MinMovenumber

Multiplying factor using the display type to determine the minimum price increment the asset trades in. For options the MinMove may vary. If the MinMove is negative, then the MinMove is dependent on the price. The whole number portion of the min move is the threshold. The leftmost two digits to the right of the decimal (X.XXXX) indicate the min move beneath the threshold, and the rightmost two digits (X.XXXX) indicate the min move above the threshold.

Namestring

A unique series of letters assigned to a security for trading purposes.

OptionTypestring

Displays the type of options contract the symbol represents. Valid options include: Puts, Calls.

PointValuenumber

Symbol`s point value.

Rootstring

The Symbol root.

StrikePricenumber

Displays strike price of an options contract; For Options symbols only.

Underlyingstring

The financial instrument on which an option contract is based or derived.

Changes