Get Alternative Candlestick Data

Description

Retrieves alternative candlestick data for a given stock symbol within the specified date range. The API token is retrieved from an environment variable 'LIMEX_API_TOKEN'.

Usage

altercandles(symbol = "BRX", from = "2023-11-27", to = Sys.Date())

Arguments

Value

A data frame containing the candlestick data if the request was successful, NULL otherwise.

Examples

## Not run: 
  candles_data <- altercandles(symbol = "BRX", from = "2023-07-31", to = "2023-08-24")

## End(Not run)

Get Candlestick Data

Description

Retrieves historical candlestick data for a given stock symbol within the specified date range. The API token is retrieved from an environment variable 'LIMEX_API_TOKEN'.

Usage

candles(symbol = "AAPL", from = "2023-07-31", to = Sys.Date(), timeframe = 3)

Arguments

Value

A data frame containing the candlestick data if the request was successful, NULL otherwise.

Examples

## Not run: 
  candles_data <- candles(symbol = "BRX", from = "2023-07-31", to = "2023-08-24")

## End(Not run)

Get Events

Description

Retrieves events data for a specified stock symbol, filtered by event type and date range. Utilizes the API token set as an environment variable 'LIMEX_API_TOKEN'.

Usage

events(
  symbol = "AAPL",
  from = "2010-01-01",
  to = Sys.Date(),
  type = "dividends"
)

Arguments

Value

A data frame containing the events data if the request is successful, NULL otherwise.

Examples

## Not run: 
  events_data <- events(symbol = "AAPL", from = "2023-01-01", to = "2024-01-01")

## End(Not run)

Get Fundamental Data

Description

Fetches fundamental data for a specified stock symbol and range of dates, and for specified accounting quarter(s), using the Limex API. Authentication is done via an API token stored in an environment variable 'LIMEX_API_TOKEN'.

Usage

fundamental(
  symbol = NULL,
  from = "2010-01-01",
  to = Sys.Date(),
  quarter = NULL,
  fields = NULL
)

Arguments

Value

A data frame containing the requested fundamental data if successful, NULL otherwise.

Examples

## Not run: 
  company_fundamental <- fundamental(symbol = "AAPL")
  universe <- fundamental(fields = 'pe-ratio',quarter = 'Q2-2023')
  hist_data <- fundamental(symbol = "AAPL",fields = 'pe-ratio')

## End(Not run)

Get Instruments

Description

Retrieves instruments data filtered by asset type. This function uses an API token stored in an environment variable named 'LIMEX_API_TOKEN'.

Usage

instruments(assets = "stocks")

Arguments

Value

A data frame containing instrument data, or NULL if the request fails.

Examples

## Not run: 
  instruments_data <- instruments(assets = 'stocks')

## End(Not run)

Set API Token for Limex

Description

Sets the API token for the Limex service by storing it in an environment variable for the current R session. This token will be used by other functions in the package to authenticate API requests.

Usage

limex_token(token)

Arguments

Value

Invisible NULL, side-effect function setting an environment variable.

Examples

## Not run: 
  limex_token("your_personal_token_here")

## End(Not run)

Retrieve Models from Limex API

Description

Fetches data about models from the Limex API for a specified vendor. It uses an API token that is stored in the 'LIMEX_API_TOKEN' environment variable.

Usage

models(vendor = "boosted")

Arguments

Value

A data frame containing the models data if the request is successful; NULL otherwise.

Examples

## Not run: 
  models_data <- models(vendor = "boosted")

## End(Not run)

Get News Data

Description

Retrieves news data for a specific stock symbol from the Limex API. The API token is retrieved from an environment variable 'LIMEX_API_TOKEN'.

Usage

news(symbol = "AAPL", from = "2010-01-01", to = Sys.Date())

Arguments

Value

A data frame containing the news data if successful, NULL otherwise.

Examples

## Not run: 
  news_data <- news(symbol = "BRX", from = "2023-11-27", to = "2023-11-28")

## End(Not run)

Get Signals Data

Description

Retrieves signals data for a specified stock symbol and model from the Limex API. The function uses the API token that is stored in the 'LIMEX_API_TOKEN' environment variable.

Usage

signals(
  vendor = "boosted",
  model = "50678d2d-fd0f-4841-aaee-7feac83cb3a1",
  symbol = "AAPL",
  from = "2010-01-01",
  to = Sys.Date()
)

Arguments

Value

A data frame containing the signals data if the request is successful; NULL otherwise.

Examples

## Not run: 
  signals_data <- signals(vendor = "boosted", symbol = "AAPL")

## End(Not run)