yh-finance 0.0.6
A Python package that wraps YH Finance API endpoints and returns financial data in JSON format.
Requires Python: >=3.6

# yh_finance

A Python package that wraps YH Finance API endpoints and returns financial data in JSON format. The API queries markets, stocks, news and conversations on Yahoo! Finance in real time to streamline the development of financial applications.

<table><tr><td>

#### IMPORTANT LEGAL DISCLAIMER

---

yh-finance is **not** affiliated, endorsed, or vetted by Yahoo, Inc. It is
an open-source tool that uses a publicly available API and is
intended for research and educational purposes.
</td></tr></table>

## Install

```shell
pip install yh_finance
```

## [Subscribe to YH Finance API](https://rapidapi.com/apidojo/api/yh-finance/ 'YH Finance API')

## Tutorial

```python
import yh_finance as yhf
```

### Default

Get auto complete suggestions by term or phrase.
```python
json_resp = yhf.auto_complete(query='tesla', 
                              region='US', 
                              api_key='YOUR_API_KEY')
```

### Market

Get live price quotes.
```python
json_resp = yhf.get_quotes(region='US',
                           symbols='AMD,IBM,AAPL',
                           api_key='YOUR_API_KEY')
```

The live day gainers, losers, and actives in a specific region.
```python
json_resp = yhf.get_movers(region='US',
                           lang='en-US',
                           count=5,
                           api_key='YOUR_API_KEY')
```

Get live summary information of market by region.
```python
json_resp = yhf.get_summary(region='US',
                            api_key='YOUR_API_KEY')
```

Used with get_trending_tickers endpoint together to draw brief chart.
```python
json_resp = yhf.get_spark(symbols='AMZN,AAPL,WDC,REYN,AZN',
                          interval='1m',
                          time_range='1d',
                          api_key='YOUR_API_KEY')
```

Get recent earnings in the market.
```python
json_resp = yhf.get_earnings(region='US',
                             start_date='1585155600000',
                             end_date='1589475600000',
                             size=10,
                             api_key='YOUR_API_KEY')
```

Get latest trending tickers in the market (Count 20).
```python
json_resp = yhf.get_trending_tickers(region='US',
                                     api_key='YOUR_API_KEY')
```

Get popular watchlists in the market.
```python
json_resp = yhf.get_popular_watchlists(api_key='YOUR_API_KEY')
```

Get performance information of specific watchlist.
```python
json_resp = yhf.get_watchlist_performance(user_id='X3NJ2A7VDSABUI4URBWME2PZNM',
                                          portfolio_id='the_berkshire_hathaway_portfolio',
                                          symbols='^GSPC',
                                          region='US',
                                          api_key='YOUR_API_KEY')
```

Get detail information of specific watchlist.
```python
json_resp = yhf.get_watchlist_detail(user_id='X3NJ2A7VDSABUI4URBWME2PZNM',
                                     portfolio_id='the_berkshire_hathaway_portfolio',
                                     api_key='YOUR_API_KEY')
```

### Stock

Get data in summary section.
```python
json_resp = yhf.get_summary(symbol='AMRN',
                            region='US',
                            api_key='YOUR_API_KEY')
```

Get symbols similar to the specified one.
```python
json_resp = yhf.get_recommendations(symbol='INTC',
                                    api_key='YOUR_API_KEY')
```

Get upgrade and downgrade data.
```python
json_resp = yhf.get_upgrades_downgrades(symbol='INTC',
                                        region='US',
                                        api_key='YOUR_API_KEY')
```

Get data to draw full screen chart.
```python
json_resp = yhf.get_chart(interval='1mo',
                          symbol='AMRN',
                          time_range='1y',
                          region='US',
                          include_pre_post='false',
                          use_yahoo_id='true',
                          include_adj_close='true',
                          events='capitalGain,div,split',
                          api_key='YOUR_API_KEY')
```

Get data in statistics section.
```python
json_resp = yhf.get_statistics(symbol='JD',
                               api_key='YOUR_API_KEY')
```

Get data in historical section.
```python
json_resp = yhf.get_historical_data(symbol='AMRN',
                                    region='US',
                                    api_key='YOUR_API_KEY')
```

Get data in profile section.
```python
json_resp = yhf.get_profile(symbol='AMRN',
                            region='US',
                            api_key='YOUR_API_KEY')
```

Get income statement and annual data in financial section.
```python
json_resp = yhf.get_financials(symbol='AMRN',
                               region='US',
                               api_key='YOUR_API_KEY')
```

Get quarterly data in financial section.
```python
json_resp = yhf.get_timeseries(symbol='AMRN',
                               start_date='493578000',
                               end_date='1625011200',
                               region='US',
                               api_key='YOUR_API_KEY')
```

Get cash flow data in financial section.
```python
json_resp = yhf.get_cash_flow(symbol='AMRN',
                              region='US',
                              api_key='YOUR_API_KEY')
```

Get balance sheet data in financial section.
```python
json_resp = yhf.get_balance_sheet(symbol='AMRN',
                                  region='US',
                                  api_key='YOUR_API_KEY')
```

Get data in analysis section.
```python
json_resp = yhf.get_analysis(symbol='AMRN',
                             region='US',
                             api_key='YOUR_API_KEY')
```

Get data in options section.
```python
json_resp = yhf.get_options(symbol='AMRN',
                            date='1562284800',
                            region='US',
                            api_key='YOUR_API_KEY')
```

Get major holders in holders section.
```python
json_resp = yhf.get_holders(symbol='AMRN',
                            region='US',
                            api_key='YOUR_API_KEY')
```

Get data in holdings section. The symbol must be a mutual fund stock.
```python
json_resp = yhf.get_holdings(symbol='AMRN',
                             api_key='YOUR_API_KEY')
```

Get brief reports relating to the symbol.
```python
json_resp = yhf.get_insights(symbol='AAPL',
                             api_key='YOUR_API_KEY')
```

Get insider transaction data in the holders section.
```python
json_resp = yhf.get_insider_transactions(symbol='AMRN',
                                         region='US',
                                         api_key='YOUR_API_KEY')
```

Get insider roster data in the holders section.
```python
json_resp = yhf.get_insider_roster(symbol='AMRN',
                                   region='US',
                                   api_key='YOUR_API_KEY')
```

### Conversation

Get conversations list relating to a symbol.
```python
json_resp = yhf.get_conversation_list(symbol='AAPL',
                                      message_board_id='finmb_24937',
                                      region='US',
                                      user_activity='true',
                                      sort_by='createdAt',
                                      off='0',
                                      api_key='YOUR_API_KEY')
```