Data

Tools

Indexes

Applications

Experiments

Open Source Science

screen

Simple and efficient access to Yahoo Finance's screener API for querying and retrieval of financial data.

https://github.com/jasonjfoster/screen

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.2%) to scientific vocabulary

Keywords

data python r
Last synced: 6 months ago · JSON representation

Repository

Simple and efficient access to Yahoo Finance's screener API for querying and retrieval of financial data.

Basic Info
  • Host: GitHub
  • Owner: jasonjfoster
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 172 KB
Statistics
  • Stars: 7
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Topics
data python r
Created about 1 year ago · Last pushed 9 months ago
Metadata Files
Readme

README.md

screen

Overview

screen is a package that provides simple and efficient access to Yahoo Finance's screener API (https://finance.yahoo.com/research-hub/screener/) for querying and retrieval of financial data.

The core functionality of the screen 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:

  • Equities: coverage spans 50 regions to enable the identification of top-performing stocks based on specified criteria
  • Mutual funds: funds can be screened using metrics such as historical performance, performance ratings, and other factors
  • ETFs: a wide range of ETFs can be filtered by criteria including expense ratio, historical performance, and additional attributes
  • Indices: stock market indices are available and often categorized by sector, industry, or the overall market
  • Futures: futures contracts can be screened by exchange, price percent changes, and regional specifications

The package supports advanced query capabilities, including logical operators, nested filters, and customizable payloads. It automatically handles pagination to ensure efficient retrieval of large datasets by fetching results in batches of up to 250 entries per request. Filters can be dynamically defined to accommodate a wide range of screening needs.

The implementation leverages standard HTTP libraries to handle API interactions efficiently and provides support for both R and Python to ensure accessibility for a broad audience.

Owner

  • Name: Jason Foster
  • Login: jasonjfoster
  • Kind: user
  • Location: New York, NY

GitHub Events

Total
  • Watch event: 5
  • Public event: 1
  • Push event: 51
  • Fork event: 1
Last Year
  • Watch event: 5
  • Public event: 1
  • Push event: 51
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • cran 434 last-month
    • pypi 303 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 3
  • Total maintainers: 2
pypi.org: yfscreen

Simple and efficient access to Yahoo Finance's 'screener' API for querying and retrieval of financial data.

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 303 Last month
Rankings
Dependent packages count: 9.3%
Average: 30.9%
Dependent repos count: 52.5%
Maintainers (1)
jasonjfoster
Last synced: 6 months ago
cran.r-project.org: yfscreen

Yahoo Finance 'screener' API

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 434 Last month
Rankings
Dependent packages count: 26.8%
Dependent repos count: 33.0%
Average: 48.9%
Downloads: 86.7%
Maintainers (1)
jason.j.foster@gmail.com
Last synced: 6 months ago

Dependencies

.github/workflows/check-standard.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • codecov/codecov-action v5 composite
  • r-lib/actions/setup-r v2 composite
r/DESCRIPTION cran
  • curl * imports
  • jsonlite * imports
  • covr * suggests
  • testthat * suggests
python/pyproject.toml pypi
  • importlib-resources python_version < '3.9'
  • pandas >= 1.0.0
  • requests >= 2.2.0
.github/workflows/check-standard-py.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/test-coverage-py.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • codecov/codecov-action v4 composite
python/requirements.txt pypi