v1

latestSwagger 2.02026-07-172635179.1 KB
marketdata

Search for Symbols

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

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

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