reqMatchingSymbols: Stock Contract Search

View source: R/reqMatchingSymbols.R

reqMatchingSymbolsR Documentation

Stock Contract Search

Description

Starting in API v973.02 and TWS v964, a function reqMatchingSymbols is available to search for stock contracts. The input can be either the first few letters of the ticker symbol, or for longer strings, a character sequence matching a word in the security name. For instance to search for the stock symbol 'IBKR', the input 'I' or 'IB' can be used, as well as the word 'Interactive'. Up to 16 matching results are returned.

Usage

reqMatchingSymbols(twsconn, pattern)

Arguments

twsconn

a valid tws connection object

pattern

either start of ticker symbol or (for larger strings) company name

Value

dataframe: conId, symbol, secType, primaryExchange, currency, derivateSecTypes

Author(s)

J.W. de Roode

References

Interactive Brokers https://www.interactivebrokers.com

Examples

## Not run: 
tws <- twsConnect()
reqMatchingSymbols(tws, pattern="IB")

## End(Not run)

IBrokers documentation built on Nov. 16, 2022, 5:05 p.m.