# ------------------------------------------------
# CITATION.cff file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# ------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "secfile" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'secfile: SEC ''EDGAR'' APIs'
version: 0.1.2
doi: 10.32614/CRAN.package.secfile
abstract: Simple and efficient access to the SEC's 'EDGAR' APIs <https://www.sec.gov/search-filings>
  for querying and retrieving filings. The 'secfile' package abstracts the complexities
  of interacting with SEC EDGAR APIs, such as session management, user agent declaration,
  rate limiting, index parsing, pagination of filing metadata, URL construction, document
  caching, and inline XBRL parsing. This abstraction allows users to focus on retrieving
  data rather than managing API details. Use cases include retrieving data across
  a range of workflows such as indexes, tenures, submissions, and facts. The package
  supports flexible query capabilities, including customizable form types, date ranges,
  and dimensions, and validates the retrieved data automatically. It handles the SEC's
  fair access requirements, such as user agent declaration and rate limiting between
  requests, and caches downloaded documents for efficient retrieval of large datasets.
  The implementation uses standard HTTP libraries to handle API interactions efficiently
  and supports both R and 'Python' to make it accessible for 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/file
commit: 0f3f9ca5b31fc3adece25d77d375e04b558d3785
url: https://github.com/jasonjfoster/file
date-released: '2026-09-05'
contact:
- family-names: Foster
  given-names: Jason
  email: jason.j.foster@gmail.com