DTN ProphetX^® Web Services

SymbolSearch

This operation provides the facility to find symbols that contain a given string in an instrument's symbol, description, or meta-data. This operation works best for finding symbols based on known meta-data fields such as location, provider, or grades. Please note the types of meta-data stored with symbols is different for different categories of symbols. Also the descriptions and meta-data associated with symbols does change from time to time which can affect the results.

The simplest search can be performed by entering a single keyword. Multiple keywords can be combined with "or" to match either word. Example: Butter or cheese The word "not" excludes the next keyword. Example: Butter or cheese not "cash settled" Parenthesis can be used to group portions of the search. Example: (Cheese spot) or (Butter not 2020)

Use cases that need to only search symbols or need to get all symbols for a particular market should use the search pattern features built into GetQuoteSnap, GetHistory, and the other requests.

This operation has a default limit of 200 symbols and a maximum limit of 4,998 symbols in a single request. If a query has more results than the specified limit, the server will return a PageToken in the header of the response. If a client makes another request with the same parameters plus the PageToken from the previous response, the server will return results starting from where the previous request ended. When no more symbols are available, the last response will have no PageToken value.

Parameter	Value
UserID*
Password*		Password is case sensitive.
Search Text		Search text to match against symbols, descriptions, and meta-data.  This parameter is case insensitive.
Limit		Limit on the number of symbols to return.  The default value is 200 symbols, and the maximum limit for a single request is 4,998. Using the Page Token with multiple requests can be used to get an unlimitted number of responses.
Page Token		A page token returned from a previous request. It is used to resume a request that matched more symbols than the Limit allowed in one request.
Format+		Optional parameter to request the result in an specific format.  Default value is XML.

Example Requests

• Find all corn contracts (futures, options, etc) expiring in December
  Search Text: corn december
  Sample Result:
  
  • CBT:@BCFZ20 - BLACK SEA CORN FINANCIALLY SETTLED December 2020
  • CBT:@CZ20 - CORN December 2020
  • CBT:@CZ21 - CORN December 2021
  • CBT:@CZ20C1000 - CORN December 2020 Call 1000
  • CBT:@CZ20P1000 - CORN December 2020 Put 1000
  • CBT:@CZ20C2000 - CORN December 2020 Call 2000

   

• Find all cash grain symbols for a given zip code.
  Search Text: dtn grain bids 50623
  Sample Results:
  
  • DGR:CY010G20.855.B - CORN/YELLOW BASIS Feb 2020, AGVANTAGE FS, DEWAR, IA 50623
  • DGR:CY010F20.855.B - CORN/YELLOW BASIS Jan 2020, AGVANTAGE FS, DEWAR, IA 50623
  • DGR:CY010G20.855 - CORN/YELLOW Feb 2020, AGVANTAGE FS, DEWAR, IA 50623
  • DGR:CY010F20.855 - CORN/YELLOW Jan 2020, AGVANTAGE FS, DEWAR, IA 50623
  • DGR:CORN.855.B - CORN/YELLOW New Crop BASIS, AGVANTAGE FS, DEWAR, IA 50623

   

• Find energy products based on location and type
  Search Text: coraopolis conv 87
  Sample Results:
  
  • DRK:GPAPI11331GB008E - BP Products Branded/Coraopolis/Buckeye E//Conv 87 Unleaded with 10% Ethanol/Pittsburgh PA/Gross
  • DRK:NPAPI11331GB008E - BP Products Branded/Coraopolis/Buckeye E//Conv 87 Unleaded with 10% Ethanol/Pittsburgh PA/Net
  • DRK:GPAPI113D1GL00N4 - Citgo Branded/Coraopolis/Lucknow//Conv 87 Unleaded with 10% Ethanol/Pittsburgh PA/Gross
  • DRK:NPAPI113D1GL00N4 - Citgo Branded/Coraopolis/Lucknow//Conv 87 Unleaded with 10% Ethanol/Pittsburgh PA/Net

   

• Find an equity symbol based on a description
  Search Text: American Express
  Sample Result:
  
  • NYS:AXP - AMERICAN EXPRESS
  • NYS:AXP38.CB - AMERICAN EXPRESS 8.15% SR NTS 3/19/38
  • NYS:AXP22.CB - AMERICAN EXPRESS AXP 2.65%
  • LSE:L.0R3C - AMERICAN EXPRESS CO

   

Notes

*Mandatory parameters are marked with an asterisk.
+This parameter is not supported when using the STD invocation.

The following needs to be considered when searching for symbols:

Format

Supported format codes are: XML, JSON, and CSV.