yfrake 2.1.2
A fast and flexible stock market, forex and cryptocurrencies data provider.
License: MIT
Requires Python: >=3.10,<4.0
Keywords: yahoo,finance,api,server,scraper

# YFrake

<a target="new" href="https://pypi.python.org/pypi/yfrake"><img border=0 src="https://img.shields.io/badge/python-3.10+-blue.svg?label=python" alt="Supported Python versions"></a>
<a target="new" href="https://github.com/aabmets/yfrake/releases"><img border=0 src="https://img.shields.io/github/v/release/aabmets/yfrake" alt="Latest version released"></a>
<a target="new" href="https://www.codefactor.io/repository/github/aabmets/yfrake"><img border=0 src="https://img.shields.io/codefactor/grade/github/aabmets/yfrake?label=code quality" alt="CodeFactor code quality"></a>
<a target="new" href="https://scrutinizer-ci.com/g/aabmets/yfrake/"><img border=0 src="https://img.shields.io/scrutinizer/build/g/aabmets/yfrake" alt="Scrutinizer build inspection"></a>
<a target="new" href="https://app.codecov.io/gh/aabmets/yfrake"><img border=0 src="https://img.shields.io/codecov/c/github/aabmets/yfrake" alt="Code coverage"></a> 
<br />
<a target="new" href="https://pypi.python.org/pypi/yfrake"><img border=0 src="https://img.shields.io/pypi/dm/yfrake?label=installs" alt="Installs per month"></a>
<a target="new" href="https://github.com/aabmets/yfrake/issues"><img border=0 src="https://img.shields.io/github/issues/aabmets/yfrake" alt="Issues on Github"></a>
<a target="new" href="https://github.com/aabmets/yfrake/blob/main/LICENSE"><img border=0 src="https://img.shields.io/github/license/aabmets/yfrake" alt="License on GitHub"></a>
<a target="new" href="https://github.com/aabmets/yfrake/stargazers"><img border=0 src="https://img.shields.io/github/stars/aabmets/yfrake?style=social" alt="Stars on GitHub"></a>
<a target="new" href="https://twitter.com/aabmets"><img border=0 src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Faabmets&label=Say%20Thanks" alt="Say thanks on Twitter"></a>


### Description
YFrake is a fast and flexible stock market, forex and cryptocurrencies data scraper and server [&#91;note1&#93;](#footnote1).
It enables developers to ***build powerful apps*** without having to worry about the details of session management or maximizing throughput [&#91;note2&#93;](#footnote2).

YFrake has caching built in to speed up requests even more and to reduce load on the source servers. 
The cache and other YFrake options are fully customizable through the configuration file.

YFrake can be used as a client to directly return market data to the current program or 
as a ***programmatically controllable server*** to provide market data to other applications.

In addition, all network requests by the client in ***both*** sync and async modes are ***non-blocking***, 
which means that your program can continue executing your code while network requests are in progress.

The best part about YFrake is its ***built-in swagger API documentation*** which you can use to 
perform test queries and examine the returned responses straight in your web browser.

YFrake is built upon the widely used ***aiohttp*** package and its plugins.

### Documentation

The tutorials and the reference manual is available at: &nbsp; <a target="new" href="http://yfrake.readthedocs.io">yfrake.readthedocs.io</a>


### Contributing

Your suggestions on how to improve the library or the docs are welcome!  
Please open an issue with the appropriate label to share your ideas or report bugs.

<br />
<a id="footnote1"><sup>&#91;note1&#93;:</sup></a> Stock market data is sourced from Yahoo Finance. 
<br/>
<a id="footnote2"><sup>&#91;note2&#93;:</sup></a> The limits of YFrake are configurable and depend on the capabilities of your system.
<br/>