get_instruments {charlesschwabapi}

Get Instruments

Description

Given the tokens object from the 'get_authentication_tokens' function, the symbol(s) of interest, and the search type, return a data frame with information about the securities matching the search.

Usage

get_instruments(tokens, symbol, projection)

Arguments

tokens

token object from 'get_authentication_tokens' function (list).

symbol

symbol(s) of interest to search for (string or character vector).

projection

type of search to be performed. Valid values are "symbol-search", "symbol-regex", "desc-search", "desc-regex", "search", and "fundamental" (string).

Value

Returns a data frame containing information surrounding the symbol(s) of interest in the search.

Author(s)

Nick Bultman, [e-mail], July 2024