From 3063d1d2762316f1fd3b70bc69478d397071e197 Mon Sep 17 00:00:00 2001
From: Kevin Casey <82106893+Kevincasey-iex@users.noreply.github.com>
Date: Tue, 25 Oct 2022 10:40:33 -0400
Subject: [PATCH] Update README.md

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 09defba..42939ea 100644
--- a/README.md
+++ b/README.md
@@ -106,7 +106,7 @@ quote.change_percent # 0.00418
 quote.change_percent_s # '+0.42%'
 ```
 
-See [#quote](https://iexcloud.io/docs/api/#quote) for detailed documentation or [quote.rb](lib/iex/resources/quote.rb) for returned fields.
+See [#quote](https://iexcloud.io/docs/api/#quote) for detailed documentation or [quote.rb](lib/iex/resources/quote.rb) for returned fields. This endpoint requires a paid login.
 
 ### Get a OHLC (Open, High, Low, Close) price
 
@@ -122,6 +122,7 @@ ohlc.open.time
 ohlc.high # 0.00418
 ohlc.low # '+0.42%'
 ```
+NOTE: This endpoint requires a paid login.
 
 ### Get a Market OHLC (Open, High, Low, Close) prices
 
@@ -136,6 +137,7 @@ market['SPY'].open.time # 2018-06-12 16:30:00 +0300
 market['SPY'].high #
 market['SPY'].low #
 ```
+NOTE: This endpoint requires a paid login.
 
 ### Get Historical Prices
 
@@ -156,7 +158,8 @@ NOTE: If you use the `date` value for the `range` parameter:
 `Query params` supported include:
 `chartByDay`
 
-This is a complicated endpoint as there is a lot of granularity over the time period of data returned. See below for a variety of ways to request data, NOTE: this is _NOT_ as exhaustive list.
+This is a complicated endpoint as there is a lot of granularity over the time period of data returned. See below for a variety of ways to request data, NOTE: this is _NOT_ as exhaustive list. Access to Historical Prices from more than 5 years ago is only included with paid subscriptions
+
 
 ```ruby
 historical_prices = client.historical_prices('MSFT') # One month of data
@@ -376,6 +379,8 @@ advanced_stats.put_call_ratio # 0.6780362005229779
 
 See [#advanced-stats](https://iexcloud.io/docs/api/#advanced-stats) for detailed documentation or [advanced_stats.rb](lib/iex/resources/advanced_stats.rb) for returned fields.
 
+NOTE: This endpoint requires a paid login.
+
 ### Get Dividends
 
 Fetches dividends for a symbol.
@@ -391,6 +396,8 @@ dividends.amount # 0.42
 
 See [#dividends](https://iexcloud.io/docs/api/#dividends) for detailed documentation or [dividends.rb](lib/iex/resources/dividends.rb) for returned fields.
 
+NOTE: Dividends prior to last reported are only included with paid subscription plans
+
 ### Get Earnings
 
 Fetches earnings for a symbol.
@@ -413,6 +420,8 @@ earnings.year_ago_change_percent_s # '+15.31%'
 
 See [#earnings](https://iexcloud.io/docs/api/#earnings) for detailed documentation or [earnings.rb](lib/iex/resources/earnings.rb) for returned fields.
 
+NOTE: This endpoint has been deprecated.
+
 ### Get Income Statement
 
 Fetches income statements for a symbol.
@@ -436,6 +445,8 @@ income.gross_profit_dollar # '$20,335,000,000'
 
 See [#income-statement](https://iexcloud.io/docs/api/#income-statement) for detailed documentation or [income.rb](lib/iex/resources/income.rb) for returned fields.
 
+NOTE: This endpoint requires a paid login.
+
 ### Get Balance Sheet
 
 Fetches balance sheets for a symbol.
@@ -457,6 +468,8 @@ balance_sheet.short_term_investments_dollar # '$40,388,000,000'
 
 See [#balance-sheet](https://iexcloud.io/docs/api/#balance-sheet) for detailed documentation or [balance_sheet.rb](lib/iex/resources/balance_sheet.rb) for returned fields.
 
+NOTE: This endpoint requires a paid login.
+
 ### Get Cash Flow Statement
 
 Fetches cash flow statements for a symbol.
@@ -478,6 +491,8 @@ cash_flow.depreciation_dollar # '$2,754,000,000'
 
 See [#cash-flow](https://iexcloud.io/docs/api/#cash-flow) for detailed documentation or [cash_flow.rb](lib/iex/resources/cash_flow.rb) for returned fields.
 
+NOTE: This endpoint requires a paid login.
+
 ### Get Sector Performance
 
 Fetches latest sector's performance.
@@ -493,6 +508,8 @@ sectors.last_updated # 1533672000437
 
 See [#sector-performance](https://iexcloud.io/docs/api/#sector-performance) for detailed documentation or [sectors.rb](lib/iex/resources/sectors.rb) for returned fields.
 
+NOTE: This endpoint requires a paid login.
+
 ### Get Largest Trades
 
 Fetches largest trades in the day for a specific stock. Ordered by largest trade on the top.
@@ -510,6 +527,8 @@ trades.first.venue_name # Cboe EDGX
 
 See [#largest-trades](https://iexcloud.io/docs/api/#largest-trades) for detailed documentation or [largest_trades.rb](lib/iex/resources/largest_trades.rb) for returned fields.
 
+NOTE: This endpoint requires a paid login.
+
 ### Get a Quote for Crypto Currencies
 
 Fetches a crypto currency quote.
@@ -706,6 +725,8 @@ However, please note that data in the IEX sandbox environment is scrambled. Ther
 
 See [IEX sandbox environment](https://intercom.help/iexcloud/en/articles/2915433-testing-with-the-iex-cloud-sandbox) for more information.
 
+NOTE: The Sandbox Environment has been deprecated.
+
 ## Errors
 
 ### SymbolNotFound