get_data: Get Data from the Yahoo Finance API

In yfscreen: Yahoo Finance 'screener' API

Get Data from the Yahoo Finance API

Description

A function to get data from the Yahoo Finance API using the specified payload.

Usage

get_data(payload = NULL)

Arguments

payload

list. Payload that contains search criteria created using the create_query and create_payload functions.

Value

A data frame that contains data from the Yahoo Finance API for the specified search criteria.

Examples

filters <- list(
  list("eq", list("region", "us")),
  list("btwn", list("intradaymarketcap", 2000000000, 10000000000)),
  list("btwn", list("intradaymarketcap", 10000000000, 100000000000)),
  list("gt", list("intradaymarketcap", 100000000000)),
  list("gt", list("dayvolume", 5000000))
)

query <- create_query(filters)

payload <- create_payload("equity", query)

## Not run: 
data <- get_data(payload)

## End(Not run)

yfscreen documentation built on June 8, 2025, 1:50 p.m.