Symbol Search Help

These methods are available with details below or via a WSDL file.


GetSymbolSources

GetSymbolSources returns an XML document containing the list of sources available.


GetDDTreeXML

GetDDTreeXML returns an XML document containing the drilldown tree for the specified source ID.

ParameterValue
lSrcID:


GetDDTreeBranch

GetDDTreeBranch returns an XML document containing only the immediate children of the branch. When path is empty, the top-level list of Symbol Sources are returned. All path components are joined with ||.

ParameterValue
path:


GetDDTreeBranchHTML

GetDDTreeBranchHTML is similar to GetDDTreeBranch except an HTML page is returned.

ParameterValue
path:


GetLeafNodes

GetLeafNodes returns an XML document containing the symbol list for a subset of a source filtered by keywords and/or symbol name.

sXMLRequest:



GetDDJSON

GetDDJSON returns a JSON document containing the symbol list for a subset of a source filtered by keywords and/or symbol name.

Categories separated by double pipe characters. (||) Blank returns the top level categories.

Optional - Return symbols where the description contains all the keywords.

Optional - Return symbols that contain the symbolSearch substring.

Optional - Same as setting both keywords and symbolSearch.

Maximum number of symbols to return. Defaults to 3000 if blank.

True False

True False

True False


BrowseDDJSON

BrowseDDJSON shows search results in a browseable HTML form.

Categories separated by double pipe characters. (||) Blank returns the top level categories.

Optional - Same as setting both keywords and symbolSearch.

Maximum number of symbols to return. Defaults to 500 if blank.

True False

True False

True False


QuerySymbolsDD

QuerySymbolsDD queries symbols and navigates the symbol hierarchy.

username: Optional username to pull permissions for. Leave blank for anonymous access.
password: User's password for non-anonymous users.
path: Categories separated by double pipe characters. (||) Blank returns the top level categories.
searchText: Text to find in matching symbols.
limit: Maximum number (default=200) of symbols to return.
start: Starting number (default=0) of the symbol to start returning. The sum of limit and start must be no more than 4998.
includeInactive: True False Determines if inactive symbols are included in the response. Inactive symbols only have historic data available.
fullyQualified: True False Returns the symbol in fully-qualified vendor:market:symbol form. When enabled, the marketNumber parameter is ignored since the separate market value is not returned.
marketNumber: True False Returns the market value as a number instead of the default string abbreviation.
showAlias: True False Includes alias symbols, when available, with each symbol found.
includeNotPermCategories: True False Determines if categories containing only not permissioned symbols are included in the response.
includeNotPermSymbols: True False Determines if not permissioned symbols are included in the response.


BrowseSymbolsDD

Wrapper around QuerySymbolsDD to create browseable HTML.

username: Optional username to pull permissions for. Leave blank for anonymous access.
password: User's password for non-anonymous users.
path: Categories separated by double pipe characters. (||) Blank returns the top level categories.
searchText: Text to find in matching symbols.
limit: Maximum number (default=200) of symbols to return.
start: Starting number (default=0) of the symbol to start returning. The sum of limit and start must be no more than 4998.
includeInactive: True False Determines if inactive symbols are included in the response. Inactive symbols only have historic data available.
fullyQualified: True False Returns the symbol in fully-qualified vendor:market:symbol form. When enabled, the marketNumber parameter is ignored since the separate market value is not returned.
marketNumber: True False Returns the market value as a number instead of the default string abbreviation.
showAlias: True False Includes alias symbols, when available, with each symbol found.
includeNotPermCategories: True False Determines if categories containing only not permissioned symbols are included in the response.
includeNotPermSymbols: True False Determines if not permissioned symbols are included in the response.


GetIqCategories

Returns lists of categories that can be used to select subsets of symbols. Each category that is not specified returns a list of possible choices. Each category that is specified filters the values for the other categories to include only matching items. For example, specifying a security type will return only the exchanges that have symbols with that security type. The counts returned show how many remaining items apply to the filtered categories.

ParameterValue
securityType:
exchange:


BrowseIqCategories

Same as GetIqCategories except an interactive HTML page is shown. Don't enter any parameter values to see all choices.


GetIqSymbols

Returns a list of symbols as a JSON list. The parameters are the same as BrowseIqSymbols. Make a request with BrowseIqSymbols and change the URL to GetIqSymbols to see the JSON response.


BrowseIqSymbols

Symbol Lookup
searchText:
limit:

start:

limit + start < 10,000.
searchType:
All Fields
Symbol
SIC Code
NAICS Code
Filter by:
exchange:

securityType:
Search Options:
Show Front Mon. Only [isFrontMonth]
Show Continuous Contr. Only [isContinuous]
Show E-minis Only [isEmini]
Don't Show Options [noOptions]
Don't Show Spreads [noSpreads]
nextKey:
Value provided in a previous request to get the next limit matching symbols. This allows iteratively requesting all possible symbols without the maximum limit with the start field.

GetFuturesInfo

GetFuturesInfo returns a contract chain for sRoot starting at sDate.

ParameterValue
sMarket:
sVendor:
sRoot:
lType:
lExpCtmths:
lMaxCont:
sDate:


GetFuturesInfoXML2

GetFuturesInfoXML2 returns a contract chain for sRoot starting at sDate. This method is the same as GetFuturesInfo with the addition of the l2DYC argument to request two digit year symbols.

ParameterValue
sMarket:
sVendor:
sRoot:
lType:
lExpCtmths:
lMaxCont:
sDate:
l2DYC:


GetVersion

GetVersion returns an XML document containing the current installed version number of the drilldown component.


GetStatus

GetStatus returns an XML document containing the status of the drilldown web service. No inputs are required. Status of 0 = available. A negative number represents an error.