rp_getAllInstruments: Get All Instruments
In rPublic: 'Public Trading API'

rp_getAllInstruments

R Documentation

Get All Instruments

Description

Get All Instruments

Usage

rp_getAllInstruments(
  typeFilter = NULL,
  tradingFilter = NULL,
  fractionalTradingFilter = NULL,
  optionTradingFilter = NULL,
  optionSpreadTradingFilter = NULL
)

Arguments

`typeFilter`	= (Optional) Ex. "BOND","EQUITY","CRYPTO","INDEX","ALT"
`tradingFilter`	= (Optional) Ex. "BUY_AND_SELL","DISABLED","LIQUIDATION_ONLY"
`fractionalTradingFilter`	= (Optional) Ex. "DISABLED","BUY_AND_SELL","LIQUIDATION_ONLY"
`optionTradingFilter`	= (Optional) Ex. "DISABLED","BUY_AND_SELL","LIQUIDATION_ONLY"
`optionSpreadTradingFilter`	= (Optional) Ex. "DISABLED","BUY_AND_SELL","LIQUIDATION_ONLY"

Value

Retrieves all available trading instruments with optional filtering capabilities as a data.frame.

Examples

## Not run: 
  # Fetches All Instruments From Public
    all_inst <- rp_getAllInstruments()
    
    # Fetches All equities enabled for trading fractional shares
    all_frac <- rp_getAllInstruments(typeFilter = "EQUITY", 
                                     tradingFilter = 'BUY_AND_SELL',
                                     fractionalTradingFilter = 'BUY_AND_SELL')

## End(Not run)

rPublic documentation built on Aug. 23, 2025, 1:12 a.m.