reqMatchingSymbols: Requests matching stock symbols.

View source: R/reqMatchingSymbols.R

reqMatchingSymbolsR Documentation

Requests matching stock symbols.

Description

Stock Contract Search.

Usage

reqMatchingSymbols(reqId = 1L, pattern, ib_con)

Arguments

reqId

id to specify the request. Should be a scalar integer.

pattern

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

ib_con

a valid ib_con connection object

Details

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.

Value

A data.frame containing sample contract descriptions.

Examples

## Not run: 
ib_con <- ib_connect()
reqMatchingSymbols(pattern = "Intel", ib_con = ib_con)

## End(Not run)

pverspeelt/ibapir documentation built on March 29, 2022, 11:57 a.m.