iex-ruby-client 0.4.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 17fd934d31cffa99721a3046560f2e9d1fbec9ddc78161829c199c29fd3b807e
-  data.tar.gz: c12a34546c617ff6145f52632387a63d4dd4866dadafcf7cbf95c934863499a9
+SHA1:
+  metadata.gz: df29afbbbd95d15992840fdfe66fd8fa31ed1cee
+  data.tar.gz: df551117e4b8dcfa5e223a765c1fa97e7bc4bedb
 SHA512:
-  metadata.gz: 7935962fa422e12cea770c3dff841a2b66c97f3dc1121a2e94e96160fc27449535c07bb9ed72247830324159f1dd3a3a22b210a6b2980c95b478df8401718386
-  data.tar.gz: 840148d3f1aa4bd174e737781f0a0e5063ec243541f82966eaddf95a653c0cf0964915447dcb115d598824fba5da3827486b513454a9c6ed47b58874e8fd6fda
+  metadata.gz: b28d4ea0c36db77958e86a5c0ad347a04876a7bd8e51582f853435316444f0b7277c1a1b98bd299e4b77f89821ec89dc58e9923c45e631e961433dcc5dfe2aa9
+  data.tar.gz: 34f851cf3b8e46f2475531717055c1a9cf9ca7abb96675fc50c88a766a5ff6f92f6f52459fda71e1d046eba4ade185d7e368639222195a662c8ee1bba957c4e9

data/.rubocop.yml

@@ -9,4 +9,10 @@ Naming/FileName:
   Exclude:
     - 'lib/iex-ruby-client.rb'
 
+Style/Documentation:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,49 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-10-19 21:17:47 -0400 using RuboCop version 0.51.0.
+# on 2019-04-19 14:36:19 -0400 using RuboCop version 0.67.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Cop supports --auto-correct.
-Layout/EmptyLines:
-  Exclude:
-    - 'lib/iex/resources/crypto.rb'
-
-# Offense count: 2
-Lint/AmbiguousOperator:
-  Exclude:
-    - 'spec/iex/resources/crypto_spec.rb'
-
-# Offense count: 15
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 86
-
-# Offense count: 83
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 221
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 15
-
-# Offense count: 1
+# Configuration parameters: AllowedChars.
 Style/AsciiComments:
   Exclude:
     - 'lib/iex/resources/quote.rb'
 
-# Offense count: 2
-Style/DateTime:
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, Autocorrect.
+# SupportedStyles: module_function, extend_self
+Style/ModuleFunction:
   Exclude:
-    - 'lib/iex/resources/news.rb'
-    - 'spec/iex/resources/news_spec.rb'
-
-# Offense count: 36
-Style/Documentation:
-  Enabled: false
+    - 'lib/iex/api/config.rb'

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 1.0.0 (2019/04/23)
+
+* [#42](https://github.com/dblock/iex-ruby-client/pull/42): Migrated to the IEX Cloud API - [@bingxie](https://github.com/bingxie).
+* [#46](https://github.com/dblock/iex-ruby-client/pull/46): Made client configurable - [@dblock](https://github.com/dblock).
+
 ### 0.4.4 (2018/12/27)
 
 * [#39](https://github.com/dblock/iex-ruby-client/pull/39): Remove default range and use iextrading default range 1m instead in `IEX::Api::Dividends` - [@ildarkayumov](https://github.com/ildarkayumov).

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Daniel Doubrovkine and Contributors
+Copyright (c) 2018-2019 Daniel Doubrovkine and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,21 +1,20 @@
-IEX Finance API
-===============
+# IEX Finance API
 
 [![Gem Version](https://badge.fury.io/rb/iex-ruby-client.svg)](https://badge.fury.io/rb/iex-ruby-client)
 [![Build Status](https://travis-ci.org/dblock/iex-ruby-client.svg?branch=master)](https://travis-ci.org/dblock/iex-ruby-client)
 
-A Ruby client for the [IEX Finance API](https://iextrading.com/developer).
-
+A Ruby client for the [The IEX Cloud API](https://iexcloud.io/docs/api/).
 
 # Table of Contents
 
 - [Installation](#installation)
-- [Methods Available](#methods-available)
 - [Usage](#usage)
+  - [Get an API Token](#get-an-api-token)
+  - [Configure](#configure)
   - [Get a Single Price](#get-a-single-price)
   - [Get a Quote](#get-a-quote)
   - [Get a OHLC (Open, High, Low, Close) price](#get-a-ohlc-open-high-low-close-price)
-  - [Get a market OHLC (Open, High, Low, Close) prices](#get-a-market-ohlc-open-high-low-close-prices)
+  - [Get a Market OHLC (Open, High, Low, Close) prices](#get-a-market-ohlc-open-high-low-close-prices)
   - [Get Company Information](#get-company-information)
   - [Get a Company Logo](#get-a-company-logo)
   - [Get Recent News](#get-recent-news)
@@ -25,14 +24,15 @@ A Ruby client for the [IEX Finance API](https://iextrading.com/developer).
   - [Get Earnings](#get-earnings)
   - [Get Sector Performance](#get-sector-performance)
   - [Get Largest Trades](#get-largest-trades)
-  - [Get Cryptocurrencies](#get-cryptocurrencies)
+  - [Get a Quote for Crypto Currencies](#get-a-quote-for-crypto-currencies)
+- [Configuration](#configuration)
 - [Errors](#errors)
   - [SymbolNotFound](#symbolnotfound)
+  - [PermissionDeniedError](#permissiondeniederror)
   - [ClientError](#clienterror)
 - [Contributing](#contributing)
 - [Copyright and License](#copyright-and-license)
 
-
 ## Installation
 
 Add to Gemfile.
@@ -43,41 +43,42 @@ gem 'iex-ruby-client'
 
 Run `bundle install`.
 
+## Usage
 
-## Methods Available
+### Get an API Token
 
-- [Get a Single Price](#get-a-single-price)
-- [Get a Quote](#get-a-quote)
-- [Get a OHLC (Open, High, Low, Close) price](#get-a-ohlc-open-high-low-close-price)
-- [Get a Market OHLC (Open, High, Low, Close) prices](#get-a-market-ohlc-open-high-low-close-prices)
-- [Get Company Information](#get-company-information)
-- [Get Company Logo](#get-company-logo)
-- [Get Recent News](#get-recent-news)
-- [Get Chart](#get-chat)
-- [Get Key Stats](#get-key-stats)
-- [Get Dividends](#get-dividends)
-- [Get Earnings](#get-earnings)
-- [Get Sector Performance](#get-sector-performance)
-- [Get Largest Trades](#get-Largest-trades)
+Create an account on [IEX Cloud](https://iexcloud.io) and get a publishable token from the cloud console.
 
-## Usage
+### Configure
+
+```ruby
+IEX::Api.configure do |config|
+  config.publishable_token = 'token' # defaults to ENV['IEX_API_PUBLISHABLE_TOKEN']
+end
+```
+
+You can also configure an instance of a client directly.
+
+```ruby
+client = IEX::Api::Client.new(publishable_token: 'token')
+```
 
 ### Get a Single Price
 
 Fetches a single number, being the IEX real time price, the 15 minute delayed market price, or the previous close price.
 
 ```ruby
-IEX::Resources::Price.get('MSFT') # 93.78
+client.get('MSFT') # 93.78
 ```
 
-See [#price](https://iextrading.com/developer/docs/#price) for detailed documentation.
+See [#price](https://iexcloud.io/docs/api/#price) for detailed documentation.
 
 ### Get a Quote
 
 Fetches a single stock quote.
 
 ```ruby
-quote = IEX::Resources::Quote.get('MSFT')
+quote = client.quote('MSFT')
 
 quote.latest_price # 90.165
 quote.change # 0.375
@@ -85,13 +86,14 @@ quote.change_percent # 0.00418
 quote.change_percent_s # '+0.42%'
 ```
 
-See [#quote](https://iextrading.com/developer/docs/#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.
 
 ### Get a OHLC (Open, High, Low, Close) price
 
 Fetches a single stock OHLC price. Open and Close prices contain timestamp.
+
 ```ruby
-ohlc = IEX::Resources::OHLC.get('MSFT')
+ohlc = client.ohlc.get('MSFT')
 
 ohlc.close.price # 90.165
 ohlc.close.time #
@@ -101,11 +103,12 @@ ohlc.high # 0.00418
 ohlc.low # '+0.42%'
 ```
 
-### Get a market OHLC (Open, High, Low, Close) prices
+### Get a Market OHLC (Open, High, Low, Close) prices
 
 Fetches a hash market OHLC prices.
+
 ```ruby
-market = IEX::Resources::OHLC.market
+market = client.market
 market['SPY'].close.price # 278.56
 market['SPY'].close.time # 2018-06-11 23:00:00 +0300
 market['SPY'].open.price # 279.05
@@ -119,32 +122,32 @@ market['SPY'].low #
 Fetches company information for a symbol.
 
 ```ruby
-company = IEX::Resources::Company.get('MSFT')
+company = client.company('MSFT')
 
 company.ceo # 'Satya Nadella'
 company.company_name # 'Microsoft Corporation'
 ```
 
-See [#company](https://iextrading.com/developer/docs/#company) for detailed documentation or [company.rb](lib/iex/resources/company.rb) for returned fields.
+See [#company](https://iexcloud.io/docs/api/#company) for detailed documentation or [company.rb](lib/iex/resources/company.rb) for returned fields.
 
 ### Get a Company Logo
 
 Fetches company logo for a symbol.
 
 ```ruby
-logo = IEX::Resources::Logo.get('MSFT')
+logo = client.logo('MSFT')
 
 logo.url # 'https://storage.googleapis.com/iex/api/logos/MSFT.png'
 ```
 
-See [#logo](https://iextrading.com/developer/docs/#logo) for detailed documentation or [logo.rb](lib/iex/resources/logo.rb) for returned fields.
+See [#logo](https://iexcloud.io/docs/api/#logo) for detailed documentation or [logo.rb](lib/iex/resources/logo.rb) for returned fields.
 
 ### Get Recent News
 
 Fetches news for a symbol.
 
 ```ruby
-news = IEX::Resources::News.get('MSFT')
+news = client.news('MSFT')
 
 news.size # 10
 
@@ -153,26 +156,20 @@ latest.headline # 'Smartsheet files for $100M IPO with growing losses'
 latest.url # 'https://...'
 ```
 
-Use `market` to get market-wide news.
-
-```ruby
-news = IEX::Resources::News.get(:market)
-```
-
 Retrieve a range between 1 and 50.
 
 ```ruby
-news = IEX::Resources::News.get('MSFT', 5)
+news = client.news('MSFT', 5)
 ```
 
-See [#news](https://iextrading.com/developer/docs/#news) for detailed documentation or [news.rb](lib/iex/resources/news.rb) for returned fields.
+See [#news](https://iexcloud.io/docs/api/#news) for detailed documentation or [news.rb](lib/iex/resources/news.rb) for returned fields.
 
 ### Get Chart
 
 Fetches charts for a symbol.
 
 ```ruby
-chart = IEX::Resources::Chart.get('MSFT')
+chart = client.chart('MSFT')
 
 chart.size # 38510
 
@@ -184,9 +181,9 @@ first.high # 94.97
 You can specify a chart range and additional options.
 
 ```ruby
-IEX::Resources::Chart.get('MSFT', 'dynamic') # 1d or 1m data depending on the day or week and time of day
-IEX::Resources::Chart.get('MSFT', Date.new(2018, 3, 26)) # a specific date
-IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10) # every n-th data point
+client.chart('MSFT', 'dynamic') # 1d or 1m data depending on the day or week and time of day
+client.chart('MSFT', Date.new(2018, 3, 26)) # a specific date
+client.chart('MSFT', '1d', chart_interval: 10) # every n-th data point
 ```
 
 ### Get Key Stats
@@ -194,56 +191,22 @@ IEX::Resources::Chart.get('MSFT', '1d', chart_interval: 10) # every n-th data po
 Fetches company's key stats for a symbol.
 
 ```ruby
-key_stats = IEX::Resources::KeyStats.get('MSFT')
+key_stats = client.key_stats('MSFT')
 
-key_stats.symbol # MSFT
 key_stats.market_cap # 825814890000
 key_stats.market_cap_dollars # '$825,814,890,000'
-key_stats.beta # 1.261768
 key_stats.week_52_high # 111.15
 key_stats.week_52_high_dollar # '$111.15'
 key_stats.week_52_low # 71.28
 key_stats.week_52_low_dollar # '$71.28'
 key_stats.week_52_change_dollar # '$51.77'
-key_stats.short_interest # 47158592
-key_stats.short_date # '2018-07-13'
-key_stats.dividend_rate # 1.68
 key_stats.dividend_yield # 1.5617738
 key_stats.ex_dividend_date # '2018-08-15 00:00:00.0'
-key_stats.latest_eps # 2.11
-key_stats.latest_eps_date # '2018-06-30'
 key_stats.shares_outstanding # 7677000000
 key_stats.float # 7217387757
-key_stats.return_on_equity # 20.82
-key_stats.consensus_eps # 0.86
-key_stats.number_of_estimates # 14
-key_stats.eps_surprise_dollar # nil
-key_stats.eps_surprise_percent # 11.6279
-key_stats.eps_surprise_percent_s # '+1162.79%'
-key_stats.ebitda # 23558000000
-key_stats.revenue_dollar # '$53,456,000,000'
-key_stats.gross_profit # 34114000000
-key_stats.gross_profit_dollar # '$34,114,000,000'
-key_stats.cash_dollar # '$281,251,000,000'
 key_stats.ttm_eps # 3.51
-key_stats.revenue_per_share # 7
-key_stats.revenue_per_employee # 431097
-key_stats.pe_ratio_high # 0
-key_stats.pe_ratio_low # 0
-key_stats.return_on_assets # 6.46
-key_stats.return_on_capital # nil
-key_stats.profit_margin # 15.1
-key_stats.price_to_sales # 7.393182
-key_stats.price_to_sales_dollar # '$7.39'
-key_stats.price_to_book # 10.73
-key_stats.price_to_book_dollar # '$10.73'
 key_stats.day_200_moving_avg # 91.99065
 key_stats.day_50_moving_avg # 102.2528
-key_stats.institution_percent # 75.1
-key_stats.institution_percent_s # '+7510.00%'
-key_stats.insider_percent # nil
-key_stats.insider_percent_s # nil
-key_stats.short_ratio # 1.7330703
 key_stats.year_5_change_percent # 2.85141424991049
 key_stats.year_5_change_percent_s # '+285.14%'
 key_stats.year_2_change_percent # 0.9732002824884664
@@ -260,38 +223,33 @@ key_stats.month_1_change_percent_s # '+8.60%'
 key_stats.day_5_change_percent # -0.0010215453194652084
 key_stats.day_5_change_percent_s # '-0.10%'
 ```
-See [#key-stats](https://iextrading.com/developer/docs/#key-stats) for detailed documentation or [key_stats.rb](lib/iex/resources/key_stats.rb) for returned fields.
+
+See [#key-stats](https://iexcloud.io/docs/api/#key-stats) for detailed documentation or [key_stats.rb](lib/iex/resources/key_stats.rb) for returned fields.
 
 ### Get Dividends
 
 Fetches dividends for a symbol.
 
 ```ruby
-dividends = IEX::Resources::Dividends.get('MSFT', '6m') # Options are: 5y, 2y, 1y, ytd, 6m, 3m, 1m
+dividends = client.dividends('MSFT', '6m') # Options are: 5y, 2y, 1y, ytd, 6m, 3m, 1m
 
 dividends.payment_date # '2018-03-08'
 dividends.record_date # '2018-02-15'
 dividends.declared_date # '2017-11-29'
 dividends.amount # 0.42
-dividends.amount_dollar # '$0.42'
-dividends.flag # ''
-dividends.type # 'Dividend income'
-dividends.qualified # 'Q'
-dividends.indicated # ''
 ```
-See [#dividends](https://iextrading.com/developer/docs/#dividends) for detailed documentation or [dividends.rb](lib/iex/resources/dividends.rb) for returned fields.
 
+See [#dividends](https://iexcloud.io/docs/api/#dividends) for detailed documentation or [dividends.rb](lib/iex/resources/dividends.rb) for returned fields.
 
 ### Get Earnings
 
 Fetches earnings for a symbol.
 
 ```ruby
-earnings = IEX::Resources::Earnings.get('MSFT')
+earnings = client.earnings('MSFT')
 
 earnings.actual_eps # 1.13
 earnings.consensus_eps # 1.07
-earnings.estimated_eps # 1.07
 earnings.announce_time # 'AMC'
 earnings.number_of_estimates # 14
 earnings.eps_surprise_dollar # 0.06
@@ -301,33 +259,31 @@ earnings.fiscal_end_date # '2018-06-30'
 earnings.year_ago # 0.98
 earnings.year_ago_change_percent # 0.15306122448979584
 earnings.year_ago_change_percent_s # '+15.31%'
-earnings.estimated_change_percent # 0.09183673469387764
-earnings.estimated_change_percent_s # '+9.18%'
-earnings.symbol_id # 4563
 ```
-See [#earnings](https://iextrading.com/developer/docs/#earnings) for detailed documentation or [earnings.rb](lib/iex/resources/earnings.rb) for returned fields.
 
+See [#earnings](https://iexcloud.io/docs/api/#earnings) for detailed documentation or [earnings.rb](lib/iex/resources/earnings.rb) for returned fields.
 
 ### Get Sector Performance
 
 Fetches latest sector's performance.
 
 ```ruby
-sectors = IEX::Resources::Sectors.get('MARKET')
+sectors = client.sectors('MARKET')
 
 sectors.type # sectors
 sectors.name # Industrials
 sectors.performance # 0.00711
 sectors.last_updated # 1533672000437
 ```
-See [#sector-performance](https://iextrading.com/developer/docs/#sector-performance) for detailed documentation or [sectors.rb](lib/iex/resources/sectors.rb) for returned fields.
+
+See [#sector-performance](https://iexcloud.io/docs/api/#sector-performance) for detailed documentation or [sectors.rb](lib/iex/resources/sectors.rb) for returned fields.
 
 ### Get Largest Trades
 
 Fetches largest trades in the day for a specific stock. Ordered by largest trade on the top.
 
 ```ruby
-trades = IEX::Resources::LargestTrades.get('aapl')
+trades = client.largest_trades('aapl')
 
 trades.first.price # 186.39
 trades.first.size # 10000 - refers to the number of shares negotiated in the day.
@@ -336,77 +292,74 @@ trades.first.time_label # 11:51:30
 trades.first.venue # EDGX
 trades.first.venue_name # Cboe EDGX
 ```
-See [#largest-trades](https://iextrading.com/developer/docs/#largest-trades) for detailed documentation or [largest_trades.rb](lib/iex/resources/largest_trades.rb) for returned fields.
 
-### Get Cryptocurrencies
+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.
+
+### Get a Quote for Crypto Currencies
+
+Fetches a crypto currency quote.
+
+```ruby
+crypto = client.crypto('BTCUSDT')
+
+crypto.symbol #'BTCUSDT'
+crypto.company_name #'Bitcoin USD'
+crypto.primary_exchange #'crypto'
+crypto.sector #'cryptocurrency'
+crypto.calculation_price #'realtime'
+crypto.open #3527.79
+crypto.open_dollar #'$3,527'
+crypto.open_time #1_548_082_840_296
+crypto.close #3522.05522498
+crypto.close_dollar #'$3,522'
+crypto.close_time #1_548_169_240_296
+crypto.high #3590.51
+crypto.high_dollar #'$3,590'
+```
+
+See [#crypto](https://iexcloud.io/docs/api/#crypto) for detailed documentation or [crypto.rb](lib/iex/resources/crypto.rb) for returned fields.
 
-Fetches a list of cryptocurrencies' latest quotes and information.
+## Configuration
 
+You can configure client options globally or directly with a `IEX::Api::Client` instance.
+
+```ruby
+IEX::Api::Client.configure do |config|
+  config.user_agent = 'IEX Ruby Client/1.0.0'
+end
 ```
-crypto = IEX::Resources::Crypto.get
-
-crypto.first.ask_price # 6617.99
-crypto.first.symbol # 'BTCUSDT'
-crypto.first.company_name # 'Bitcoin USD'
-crypto.first.primary_exchange # 'crypto'
-crypto.first.sector # 'cryptocurrency'
-crypto.first.calculation_price # 'realtime'
-crypto.first.open # 6645.76
-crypto.first.open_dollar # '$6,645'
-crypto.first.open_time # 1_538_360_540_423
-crypto.first.close # 6595.49934953
-crypto.first.close_dollar # '$6,595'
-crypto.first.close_time # 1_538_446_940_423
-crypto.first.high # 6663.1
-crypto.first.high_dollar # '$6,663'
-crypto.first.low # 6510
-crypto.first.low_dollar # '$6,510'
-crypto.first.latest_price # 6618.7
-crypto.first.latest_price_dollar # '$6,618'
-crypto.first.latest_source # 'Real time price'
-crypto.first.latest_time # '10:22:20 PM'
-crypto.first.latest_update # 1_538_446_940_423
-crypto.first.latest_volume # 20_027.36393
-crypto.first.latest_volume_dollar # '$20,027'
-crypto.first.iex_realtime_price # nil
-crypto.first.iex_realtime_size # nil
-crypto.first.iex_last_updated # nil
-crypto.first.delayed_price # nil
-crypto.first.delayed_price_time # nil
-crypto.first.extended_change # nil
-crypto.first.extended_change_percent # nil
-crypto.first.extended_price_time # nil
-crypto.first.previous_close # 6645.76
-crypto.first.previous_close_dollar # '$6,645'
-crypto.first.change # -27.06
-crypto.first.change_percent # -0.00407
-crypto.first.change_percent_s # '-0.41%'
-crypto.first.iex_market_percent # nil
-crypto.first.iex_volume # nil
-crypto.first.avg_total_volume # nil
-crypto.first.iex_bid_price # nil
-crypto.first.iex_bid_size # nil
-crypto.first.iex_ask_price # nil
-crypto.first.iex_ask_size # nil
-crypto.first.market_cap # nil
-crypto.first.pe_ratio # nil
-crypto.first.week52_high # nil
-crypto.first.week52_high_dollar # nil
-crypto.first.week52_low # nil
-crypto.first.week52_low_dollar # nil
-crypto.first.ytd_change # nil
-crypto.first.bid_price # 6613.16
-crypto.first.bid_size # 2.166213
-crypto.first.ask_price # 6617.99
-crypto.first.ask_size # 0.264944
+
+```ruby
+client = IEX::Api::Client.new(
+  publishable_token: 'token',
+  user_agent: 'IEX Ruby Client/1.0.0'
+)
 ```
 
+The following settings are supported.
+
+setting             | description
+--------------------|------------
+user_agent          | User-agent, defaults to _IEX Ruby Client/version_.
+proxy               | Optional HTTP proxy.
+ca_path             | Optional SSL certificates path.
+ca_file             | Optional SSL certificates file.
+logger              | Optional `Logger` instance that logs HTTP requests.
+timeout             | Optional open/read timeout in seconds.
+open_timeout        | Optional connection open timeout in seconds.
+publishable_token   | IEX Cloud API publishable token.
+endpoint            | Defaults to `https://cloud.iexapis.com/v1`.
+
 ## Errors
 
 ### SymbolNotFound
 
 If a symbol cannot be found an [IEX::Errors::SymbolNotFound](lib/iex/errors/symbol_not_found_error.rb) exception is raised.
 
+### PermissionDeniedError
+
+All errors that return HTTP code 403 result in a [IEX::Errors::PermissionDeniedError](lib/iex/errors/permission_denied_error.rb) exception.
+
 ### ClientError
 
 All errors that return HTTP codes 400-600 result in a [IEX::Errors::ClientError](lib/iex/errors/client_error.rb) exception.
@@ -417,8 +370,8 @@ See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Copyright and License
 
-Copyright (c) 2018, [Daniel Doubrovkine](https://twitter.com/dblockdotorg) and [Contributors](CHANGELOG.md).
+Copyright (c) 2018-2019, [Daniel Doubrovkine](https://twitter.com/dblockdotorg) and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).
 
-Data provided for free by [IEX](https://iextrading.com/developer), see [terms](https://iextrading.com/api-terms).
+Data provided for free by [IEX](https://iexcloud.io), see [terms](https://iexcloud.io/terms/).