Package: yfscreen 0.1.3
yfscreen: Yahoo Finance 'screener' API
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 automatically handles pagination for efficient retrieval of large datasets by fetching results in batches of up to 250 entries per request. Filters are defined as lists of conditions to accommodate a wide range of screens. 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:
yfscreen_0.1.3.tar.gz
yfscreen_0.1.3.zip(r-4.7-any)yfscreen_0.1.3.zip(r-4.6-any)yfscreen_0.1.3.zip(r-4.5-any)
yfscreen_0.1.3.tgz(r-4.6-any)yfscreen_0.1.3.tgz(r-4.5-any)
yfscreen_0.1.3.tar.gz(r-4.7-any)yfscreen_0.1.3.tar.gz(r-4.6-any)
yfscreen_0.1.3.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
yfscreen/json (API)
| # Install 'yfscreen' in R: |
| install.packages('yfscreen', repos = c('https://jasonjfoster.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/jasonjfoster/screen/issues
- data_categoryname - Category Name Data for the Yahoo Finance API
- data_errors - Errors Data for the Yahoo Finance API
- data_exchange - Exchange Data for the Yahoo Finance API
- data_filters - Filters Data for the Yahoo Finance API
- data_fundfamilyname - Fund Family Name Data for the Yahoo Finance API
- data_industry - Industry Data for the Yahoo Finance API
- data_peer_group - Peer Group Data for the Yahoo Finance API
- data_region - Region Data for the Yahoo Finance API
- data_sector - Sector Data for the Yahoo Finance API
Last updated from:d6c9371818. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 288 | ||
| source / vignettes | OK | 162 | ||
| linux-release | OK | 266 | ||
| macos-release | OK | 230 | ||
| macos-oldrel | OK | 249 | ||
| windows-devel | OK | 197 | ||
| windows-release | OK | 182 | ||
| windows-oldrel | OK | 254 | ||
| wasm-release | OK | 100 |
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Yahoo Finance 'screener' API | yfscreen-package yfscreen |
| Create a Payload for the Yahoo Finance API | create_payload |
| Create a Structured Query for the Yahoo Finance API | create_query |
| Category Name Data for the Yahoo Finance API | data_categoryname |
| Errors Data for the Yahoo Finance API | data_errors |
| Exchange Data for the Yahoo Finance API | data_exchange |
| Filters Data for the Yahoo Finance API | data_filters |
| Fund Family Name Data for the Yahoo Finance API | data_fundfamilyname |
| Industry Data for the Yahoo Finance API | data_industry |
| Peer Group Data for the Yahoo Finance API | data_peer_group |
| Region Data for the Yahoo Finance API | data_region |
| Sector Data for the Yahoo Finance API | data_sector |
| Get Data from the Yahoo Finance API | get_data |
| Get the Crumb, Cookies, and Handle for the Yahoo Finance API | get_session |