events {limexhub}

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

symbol

The stock symbol for which events data is requested.

from

The start date for the data retrieval in 'YYYY-MM-DD' format.

to

The end date for the data retrieval in 'YYYY-MM-DD' format.

type

Type of the event to filter (e.g., 'dividends').

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)