# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "yfscreen" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'yfscreen: Yahoo Finance ''screener'' API'
version: 0.1.3
doi: 10.32614/CRAN.package.yfscreen
abstract: Simple and efficient access to Yahoo Finance's 'screener' API <https://finance.yahoo.com/research-hub/screener/>
  for querying and retrieving financial data. The 'yfscreen' package abstracts the
  complexities of interacting with Yahoo Finance APIs, such as session management,
  crumb and cookie handling, query construction, pagination, and JSON payload generation.
  This abstraction allows users to focus on filtering and retrieving data rather than
  managing API details. Use cases include screening across a range of security types
  such as equities, mutual funds, ETFs, indices, and futures. The package supports
  advanced query capabilities, including logical operators, nested filters, and customizable
  payloads. It handles pagination automatically, fetching results in batches of up
  to 250 entries per request for efficient retrieval of large datasets. Filters can
  be defined dynamically to support a wide range of screening needs. The implementation
  uses standard HTTP libraries to handle API interactions efficiently and is available
  in both R and 'Python' for accessibility to a broad audience.
authors:
- family-names: Foster
  given-names: Jason
  email: jason.j.foster@gmail.com
repository: https://jasonjfoster.r-universe.dev
repository-code: https://github.com/jasonjfoster/screen
commit: ed63621bea9956a89ef69506ebdd9a6a5dd5e02c
url: https://github.com/jasonjfoster/screen
date-released: '2026-06-10'
contact:
- family-names: Foster
  given-names: Jason
  email: jason.j.foster@gmail.com