├── docs
    ├── .nojekyll
    ├── forex.md
    ├── _media
    │   ├── icon-color.png
    │   └── logo-color.svg
    ├── _navbar.md
    ├── ref-data.md
    ├── _sidebar.md
    ├── _coverpage.md
    ├── iex-data.md
    ├── system-metadata.md
    ├── getting-started.md
    ├── index.html
    ├── account.md
    ├── README.md
    ├── alt-data.md
    ├── cryptocurrency.md
    ├── dev-status.md
    ├── quickstart.md
    ├── data-apis.md
    └── stocks.md
├── .styleci.yml
├── src
    ├── Exceptions
    │   ├── WrongData.php
    │   └── InvalidConfig.php
    ├── Facades
    │   ├── Stocks
    │   │   ├── Logo.php
    │   │   ├── News.php
    │   │   ├── Batch.php
    │   │   ├── Price.php
    │   │   ├── Quote.php
    │   │   ├── Company.php
    │   │   ├── KeyStats.php
    │   │   ├── PriceTarget.php
    │   │   ├── BalanceSheet.php
    │   │   ├── DelayedQuote.php
    │   │   ├── AdvancedStats.php
    │   │   ├── IntradayPrices.php
    │   │   ├── VolumeByVenue.php
    │   │   └── PreviousDayPrice.php
    │   ├── Account
    │   │   ├── Usage.php
    │   │   └── Metadata.php
    │   ├── ReferenceData
    │   │   ├── Tags.php
    │   │   ├── Search.php
    │   │   ├── Sectors.php
    │   │   ├── Symbols.php
    │   │   ├── Exchanges.php
    │   │   ├── FxSymbols.php
    │   │   ├── IEXSymbols.php
    │   │   ├── OtcSymbols.php
    │   │   ├── USExchanges.php
    │   │   ├── CryptoSymbols.php
    │   │   ├── OptionsSymbols.php
    │   │   ├── RegionSymbols.php
    │   │   ├── ExchangeSymbols.php
    │   │   ├── USHolTradeDates.php
    │   │   └── MutualFundSymbols.php
    │   ├── DataApis
    │   │   ├── DataPoints.php
    │   │   └── TimeSeries
    │   │   │   ├── Query.php
    │   │   │   └── Inventory.php
    │   ├── AlternativeData
    │   │   ├── CeoComp.php
    │   │   ├── Crypto
    │   │   │   ├── Book.php
    │   │   │   ├── Price.php
    │   │   │   └── Quote.php
    │   │   └── SocialSentiment.php
    │   ├── APISystemMetadata
    │   │   └── Status.php
    │   ├── InvestorsExchangeData
    │   │   ├── Deep.php
    │   │   ├── Last.php
    │   │   ├── Tops.php
    │   │   ├── Deep
    │   │   │   ├── Book.php
    │   │   │   ├── Trades.php
    │   │   │   ├── Auction.php
    │   │   │   ├── SsrStatus.php
    │   │   │   ├── SystemEvent.php
    │   │   │   ├── TradeBreak.php
    │   │   │   ├── OpHaltStatus.php
    │   │   │   ├── OfficialPrice.php
    │   │   │   ├── SecurityEvent.php
    │   │   │   └── TradingStatus.php
    │   │   └── Stats
    │   │   │   ├── Recent.php
    │   │   │   ├── Intraday.php
    │   │   │   └── Records.php
    │   └── ForexCurrencies
    │   │   └── ExchangeRates.php
    ├── Contracts
    │   └── IEXCloud.php
    ├── Account
    │   ├── Usage.php
    │   └── Metadata.php
    ├── ReferenceData
    │   ├── Tags.php
    │   ├── Sectors.php
    │   ├── Symbols.php
    │   ├── Exchanges.php
    │   ├── FxSymbols.php
    │   ├── IEXSymbols.php
    │   ├── OtcSymbols.php
    │   ├── CryptoSymbols.php
    │   ├── OptionsSymbols.php
    │   ├── USExchanges.php
    │   ├── MutualFundSymbols.php
    │   ├── Search.php
    │   ├── RegionSymbols.php
    │   ├── ExchangeSymbols.php
    │   └── USHolTradeDates.php
    ├── APISystemMetadata
    │   └── Status.php
    ├── DataApis
    │   ├── TimeSeries
    │   │   ├── Inventory.php
    │   │   └── Query.php
    │   └── DataPoints.php
    ├── InvestorsExchangeData
    │   ├── Stats
    │   │   ├── Recent.php
    │   │   ├── Intraday.php
    │   │   └── Records.php
    │   ├── Deep
    │   │   ├── SystemEvent.php
    │   │   ├── Book.php
    │   │   ├── Auction.php
    │   │   ├── SecurityEvent.php
    │   │   ├── SsrStatus.php
    │   │   ├── OpHaltStatus.php
    │   │   ├── OfficialPrice.php
    │   │   ├── TradingStatus.php
    │   │   ├── Trades.php
    │   │   └── TradeBreak.php
    │   ├── Deep.php
    │   ├── Tops.php
    │   └── Last.php
    ├── Stocks
    │   ├── Logo.php
    │   ├── Price.php
    │   ├── Company.php
    │   ├── PriceTarget.php
    │   ├── BalanceSheet.php
    │   ├── AdvancedStats.php
    │   ├── PreviousDayPrice.php
    │   ├── VolumeByVenue.php
    │   ├── IntradayPrices.php
    │   ├── DelayedQuote.php
    │   ├── Quote.php
    │   ├── KeyStats.php
    │   ├── News.php
    │   └── Batch.php
    ├── AlternativeData
    │   ├── CeoComp.php
    │   ├── Crypto
    │   │   ├── Book.php
    │   │   ├── Price.php
    │   │   └── Quote.php
    │   └── SocialSentiment.php
    ├── Client.php
    ├── ForexCurrencies
    │   └── ExchangeRates.php
    ├── Requests
    │   └── BaseRequest.php
    └── IexCloudSdkServiceProvider.php
├── LICENSE.md
├── composer.json
├── README.md
├── config
    └── config.php
├── CHANGELOG.md
├── CONTRIBUTING.md
└── GETTING_STARTED.md


/docs/.nojekyll:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/docs/forex.md:
--------------------------------------------------------------------------------
1 | # Forex / Currencies
2 | 
3 | ## Exchange Rates
4 | 


--------------------------------------------------------------------------------
/.styleci.yml:
--------------------------------------------------------------------------------
1 | preset: laravel
2 | 
3 | disabled:
4 |   - single_class_element_per_statement
5 | 


--------------------------------------------------------------------------------
/docs/_media/icon-color.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/digitonic/iex-cloud-sdk/HEAD/docs/_media/icon-color.png


--------------------------------------------------------------------------------
/docs/_navbar.md:
--------------------------------------------------------------------------------
1 | * IEX Cloud Support
2 |   * [Getting Started](https://iexcloud.io/support/)
3 |   * [API Docs](https://iexcloud.io/docs/api/)
4 |   * [Quickstart](https://intercom.help/iexcloud/getting-started/getting-started-with-iex-cloud)
5 |   * [Help Center](https://intercom.help/iexcloud)
6 | 


--------------------------------------------------------------------------------
/src/Exceptions/WrongData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | class WrongData extends Exception
 8 | {
 9 |     public static function invalidValuesProvided(string $message)
10 |     {
11 |         return new static($message);
12 |     }
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/Logo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Logo extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\Logo::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/News.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class News extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\News::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Account/Usage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Account;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Usage extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Account\Usage::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/Batch.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Batch extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\Batch::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/Price.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Price extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\Price::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/Quote.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Quote extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\Quote::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/Company.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Company extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\Company::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/docs/ref-data.md:
--------------------------------------------------------------------------------
 1 | ## Symbols
 2 | ## Crypto Symbols
 3 | ## Search
 4 | ## IEX Symbols
 5 | ## International Symbols (Region)
 6 | ## International Symbols (Exchange)
 7 | ## International Exchanges
 8 | ## U.S. Exchanges
 9 | ## U.S. Holidays and Trading Days
10 | ## Sectors
11 | ## Tags
12 | ## ISIN Mapping
13 | ## Mutual Fund Symbols
14 | ## OTC Symbols
15 | ## FX Symbols
16 | ## Options Symbols
17 | 


--------------------------------------------------------------------------------
/src/Facades/Account/Metadata.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Account;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Metadata extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Account\Metadata::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/KeyStats.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class KeyStats extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\KeyStats::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/Tags.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Tags extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\Tags::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/PriceTarget.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class PriceTarget extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\PriceTarget::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/DataApis/DataPoints.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\DataApis;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class DataPoints extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\DataApis\DataPoints::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/BalanceSheet.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class BalanceSheet extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\BalanceSheet::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/DelayedQuote.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class DelayedQuote extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\DelayedQuote::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/Search.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Search extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\Search::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/Sectors.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Sectors extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\Sectors::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/Symbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Symbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\Symbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/AdvancedStats.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class AdvancedStats extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\AdvancedStats::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/IntradayPrices.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class IntradayPrices extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\IntradayPrices::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/VolumeByVenue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class VolumeByVenue extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\VolumeByVenue::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/AlternativeData/CeoComp.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\AlternativeData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class CeoComp extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\AlternativeData\CeoComp::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/Exchanges.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Exchanges extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\Exchanges::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/FxSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class FxSymbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\FxSymbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/Stocks/PreviousDayPrice.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\Stocks;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class PreviousDayPrice extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\Stocks\PreviousDayPrice::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/APISystemMetadata/Status.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\APISystemMetadata;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Status extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\APISystemMetadata\Status::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/IEXSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class IEXSymbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\IEXSymbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/OtcSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class OtcSymbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\OtcSymbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/DataApis/TimeSeries/Query.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\DataApis\TimeSeries;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Query extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\DataApis\TimeSeries\Query::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Deep extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Last.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Last extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Last::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Tops.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Tops extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Tops::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/USExchanges.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class USExchanges extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\USExchanges::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/AlternativeData/Crypto/Book.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\AlternativeData\Crypto;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Book extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\AlternativeData\Crypto\Book::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/AlternativeData/Crypto/Price.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\AlternativeData\Crypto;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Price extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\AlternativeData\Crypto\Price::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/AlternativeData/Crypto/Quote.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\AlternativeData\Crypto;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Quote extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\AlternativeData\Crypto\Quote::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/CryptoSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class CryptoSymbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\CryptoSymbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/OptionsSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class OptionsSymbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\OptionsSymbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/RegionSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class RegionSymbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\RegionSymbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/DataApis/TimeSeries/Inventory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\DataApis\TimeSeries;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Inventory extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\DataApis\TimeSeries\Inventory::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ForexCurrencies/ExchangeRates.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ForexCurrencies;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class ExchangeRates extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ForexCurrencies\ExchangeRates::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/ExchangeSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class ExchangeSymbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\ExchangeSymbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/USHolTradeDates.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class USHolTradeDates extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\USHolTradeDates::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/AlternativeData/SocialSentiment.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\AlternativeData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class SocialSentiment extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\AlternativeData\SocialSentiment::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/Book.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Book extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\Book::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/ReferenceData/MutualFundSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\ReferenceData;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class MutualFundSymbols extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\ReferenceData\MutualFundSymbols::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/Trades.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Trades extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\Trades::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/Auction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Auction extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\Auction::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Stats/Recent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Stats;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Recent extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Stats\Recent::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/SsrStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class SsrStatus extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\SsrStatus::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Stats/Intraday.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Stats;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Intraday extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Stats\Intraday::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Stats/Records.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Stats;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Records extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Stats\Records::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/SystemEvent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class SystemEvent extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\SystemEvent::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/TradeBreak.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class TradeBreak extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\TradeBreak::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/docs/_sidebar.md:
--------------------------------------------------------------------------------
 1 | * [Getting Started](/getting-started.md)
 2 | * [Development](/dev-status.md)
 3 | * [Quick Start](/quickstart.md)
 4 | * [Account](account.md)
 5 | * [Data Apis](data-apis.md)
 6 | * [Alternative Data](alt-data.md)
 7 | * [Cryptocurrency](cryptocurrency.md)
 8 | * [API System Metadata](system-metadata.md)
 9 | * [Forex / Currencies](forex.md)
10 | * [Investors Exchange Data](iex-data.md)
11 | * [Reference Data](ref-data.md)
12 | * [Stocks](stocks.md)
13 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/OpHaltStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class OpHaltStatus extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\OpHaltStatus::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/OfficialPrice.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class OfficialPrice extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\OfficialPrice::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/SecurityEvent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class SecurityEvent extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\SecurityEvent::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Facades/InvestorsExchangeData/Deep/TradingStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Facades\InvestorsExchangeData\Deep;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class TradingStatus extends Facade
 8 | {
 9 |     /**
10 |      * @return string
11 |      */
12 |     protected static function getFacadeAccessor()
13 |     {
14 |         return \Digitonic\IexCloudSdk\InvestorsExchangeData\Deep\TradingStatus::class;
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Contracts/IEXCloud.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Contracts;
 4 | 
 5 | use Psr\Http\Message\RequestInterface;
 6 | use Psr\Http\Message\ResponseInterface;
 7 | 
 8 | interface IEXCloud
 9 | {
10 |     /**
11 |      * @param  RequestInterface  $request
12 |      * @param  array  $options
13 |      *
14 |      * @return ResponseInterface
15 |      */
16 |     public function send(RequestInterface $request, array $options = []): ResponseInterface;
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Exceptions/InvalidConfig.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | class InvalidConfig extends Exception
 8 | {
 9 |     public static function apiKeyNotSpecified()
10 |     {
11 |         return new static('An API key is required to access this data and no key was provided');
12 |     }
13 | 
14 |     public static function baseUrlNotSpecified()
15 |     {
16 |         return new static('You must provide a valid Base URL to query the IEX Cloud API');
17 |     }
18 | }
19 | 


--------------------------------------------------------------------------------
/docs/_coverpage.md:
--------------------------------------------------------------------------------
 1 | ![logo](_media/logo-color.svg)
 2 | 
 3 | # PHP SDK <small>0.1.0</small>
 4 | 
 5 | > An unofficial PHP package for interacting with the IEX Cloud API
 6 | 
 7 | - 99% unit test coverage
 8 | - Configurable Sandbox and Production mode
 9 | - Developed by [Steven Richardson](https://github.com/richdynamix/) for [Digitonic](https://digitonic.co.uk)
10 | 
11 | [GitHub](https://github.com/digitonic/iex-cloud-sdk/)
12 | [Get Started](/getting-started.md)
13 | [Digitonic](https://digitonic.co.uk)
14 | 
15 | ![color](#F7F8FB)
16 | 


--------------------------------------------------------------------------------
/docs/iex-data.md:
--------------------------------------------------------------------------------
 1 | # Investors Exchange Data
 2 | 
 3 | ## TOPS
 4 | ## TOPS last
 5 | ## DEEP
 6 | ## DEEP Auction
 7 | ## DEEP Book
 8 | ## DEEP Operational Halt Status
 9 | ## DEEP Official Price
10 | ## DEEP Security Event
11 | ## DEEP Short Sale Price Test Status
12 | ## DEEP System Event
13 | ## DEEP Trades
14 | ## DEEP Trade Break
15 | ## DEEP Trading Status
16 | ## Listed Regulation SHO Threshold Securities List
17 | ## Listed Short Interest List
18 | ## Stats Historical Daily
19 | ## Stats Historical Summary
20 | ## Stats Intraday
21 | ## Stats Recent
22 | ## Stats Records
23 | 


--------------------------------------------------------------------------------
/docs/system-metadata.md:
--------------------------------------------------------------------------------
 1 | # API System Metadata
 2 | 
 3 | ## Status
 4 | 
 5 | Used to retrieve current system status.
 6 | 
 7 | **Example**
 8 | 
 9 | ```php
10 | use \Digitonic\IexCloudSdk\APISystemMetadata\Status;
11 | 
12 | $endpoint = new Status($client);
13 | $response = $endpoint->get();
14 | 
15 | // Laravel
16 | use \Digitonic\IexCloudSdk\Facades\APISystemMetadata\Status;
17 | 
18 | $response = Status::get();
19 | ```
20 | 
21 | **Response**
22 | 
23 | ```php
24 | Collection {#275 ▼
25 |   #items: array:3 [▼
26 |     "status" => "up"
27 |     "version" => "1.17"
28 |     "time" => 1570900357804
29 |   ]
30 | }
31 | ```
32 | 


--------------------------------------------------------------------------------
/src/Account/Usage.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Account;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Usage extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'account/usage';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Account/Metadata.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Account;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Metadata extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'account/metadata';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/Tags.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Tags extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/tags';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/APISystemMetadata/Status.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\APISystemMetadata;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Status extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'status';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/Sectors.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Sectors extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/sectors';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/Symbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Symbols extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/symbols';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/Exchanges.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Exchanges extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/exchanges';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/FxSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class FxSymbols extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/fx/symbols';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/DataApis/TimeSeries/Inventory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\DataApis\TimeSeries;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Inventory extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'time-series';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/IEXSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class IEXSymbols extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/iex/symbols';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/OtcSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class OtcSymbols extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/otc/symbols';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Stats/Recent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Stats;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Recent extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'stats/recent';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/CryptoSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class CryptoSymbols extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/crypto/symbols';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/OptionsSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class OptionsSymbols extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/options/symbols';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/USExchanges.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class USExchanges extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/market/us/exchanges';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Stats/Intraday.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Stats;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Intraday extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'stats/intraday';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Stats/Records.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Stats;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Records extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'stats/records';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/ReferenceData/MutualFundSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class MutualFundSymbols extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'ref-data/mutual-funds/symbols';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/SystemEvent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class SystemEvent extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'deep/system-event';
11 | 
12 |     /**
13 |      * Create constructor.
14 |      *
15 |      * @param  IEXCloud  $api
16 |      */
17 |     public function __construct(IEXCloud $api)
18 |     {
19 |         parent::__construct($api);
20 |     }
21 | 
22 |     /**
23 |      * @return string
24 |      */
25 |     protected function getFullEndpoint(): string
26 |     {
27 |         return self::ENDPOINT;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/docs/getting-started.md:
--------------------------------------------------------------------------------
 1 | # Introduction
 2 | 
 3 | IEX Cloud is platform that provides an easy-to-use and cost-effective platform to access a wide breadth of high-quality, reliable financial data and services.
 4 | 
 5 | The IEX Cloud SDK for PHP is a package that allows easy and consistent integration with the IEX Cloud API.
 6 | 
 7 | All endpoints descriptions provided by IEX API Docs at the time of writing to provide a clear and concise overview.  
 8 | 
 9 | #### Development
10 | 
11 | !> Package in heavy development. Follow the [status](dev-status.md)
12 | 
13 | #### What next?
14 | Read the [Quick Start](quickstart.md) 
15 | 
16 | Read more information on [IEX Cloud](https://iexcloud.io)
17 | 
18 | ##### IEX Cloud Support
19 | * [Getting Started](https://iexcloud.io/support/)
20 | * [API Docs](https://iexcloud.io/docs/api/)
21 | * [Quickstart](https://intercom.help/iexcloud/getting-started/getting-started-with-iex-cloud)
22 | * [Help Center](https://intercom.help/iexcloud)
23 | 


--------------------------------------------------------------------------------
/src/ReferenceData/Search.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class Search extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'search/{term}';
11 | 
12 |     /**
13 |      * @var string
14 |      */
15 |     protected $term;
16 | 
17 |     /**
18 |      * Create constructor.
19 |      *
20 |      * @param  IEXCloud  $api
21 |      */
22 |     public function __construct(IEXCloud $api)
23 |     {
24 |         parent::__construct($api);
25 |     }
26 | 
27 |     /**
28 |      * @param  string  $term
29 |      *ß
30 |      *
31 |      * @return Search
32 |      */
33 |     public function setTerm(string $term): self
34 |     {
35 |         $this->term = $term;
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace('{term}', $this->term, self::ENDPOINT);
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Deep extends BaseRequest
10 | {
11 |     const ENDPOINT = 'deep?symbols={symbol}';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      */
34 |     protected function validateParams(): void
35 |     {
36 |         if (empty($this->symbol)) {
37 |             throw WrongData::invalidValuesProvided('Please provide symbol to query!');
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Stocks/Logo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Logo extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/logo';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      * @throws WrongData
34 |      */
35 |     protected function validateParams(): void
36 |     {
37 |         if (empty($this->symbol)) {
38 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
39 |         }
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/AlternativeData/CeoComp.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\AlternativeData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class CeoComp extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/ceo-compensation';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      */
34 |     protected function validateParams(): void
35 |     {
36 |         if (empty($this->symbol)) {
37 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/AlternativeData/Crypto/Book.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\AlternativeData\Crypto;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Book extends BaseRequest
10 | {
11 |     const ENDPOINT = 'crypto/{symbol}/book';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      */
34 |     protected function validateParams(): void
35 |     {
36 |         if (empty($this->symbol)) {
37 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/AlternativeData/Crypto/Price.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\AlternativeData\Crypto;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Price extends BaseRequest
10 | {
11 |     const ENDPOINT = 'crypto/{symbol}/price';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      */
34 |     protected function validateParams(): void
35 |     {
36 |         if (empty($this->symbol)) {
37 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/AlternativeData/Crypto/Quote.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\AlternativeData\Crypto;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Quote extends BaseRequest
10 | {
11 |     const ENDPOINT = 'crypto/{symbol}/quote';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      */
34 |     protected function validateParams(): void
35 |     {
36 |         if (empty($this->symbol)) {
37 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Stocks/Price.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Price extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/price';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      * @throws WrongData
34 |      */
35 |     protected function validateParams(): void
36 |     {
37 |         if (empty($this->symbol)) {
38 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
39 |         }
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Stocks/Company.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Company extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/company';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      * @throws WrongData
34 |      */
35 |     protected function validateParams(): void
36 |     {
37 |         if (empty($this->symbol)) {
38 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
39 |         }
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/Book.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Book extends BaseRequest
10 | {
11 |     const ENDPOINT = 'deep/book?symbols={symbol}';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      */
34 |     protected function validateParams(): void
35 |     {
36 |         if (empty($this->symbol)) {
37 |             throw WrongData::invalidValuesProvided('Please provide symbol to query!');
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Stocks/PriceTarget.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class PriceTarget extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/price-target';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      * @throws WrongData
34 |      */
35 |     protected function validateParams(): void
36 |     {
37 |         if (empty($this->symbol)) {
38 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
39 |         }
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/Auction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Auction extends BaseRequest
10 | {
11 |     const ENDPOINT = 'deep/auction?symbols={symbol}';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      */
34 |     protected function validateParams(): void
35 |     {
36 |         if (empty($this->symbol)) {
37 |             throw WrongData::invalidValuesProvided('Please provide symbol to query!');
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/src/Stocks/BalanceSheet.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class BalanceSheet extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/balance-sheet';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      * @throws WrongData
34 |      */
35 |     protected function validateParams(): void
36 |     {
37 |         if (empty($this->symbol)) {
38 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
39 |         }
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Stocks/AdvancedStats.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class AdvancedStats extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/advanced-stats';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      * @throws WrongData
34 |      */
35 |     protected function validateParams(): void
36 |     {
37 |         if (empty($this->symbol)) {
38 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
39 |         }
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/Stocks/PreviousDayPrice.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class PreviousDayPrice extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/previous';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      * @throws WrongData
34 |      */
35 |     protected function validateParams(): void
36 |     {
37 |         if (empty($this->symbol)) {
38 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
39 |         }
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/SecurityEvent.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class SecurityEvent extends BaseRequest
10 | {
11 |     const ENDPOINT = 'deep/security-event?symbols={symbol}';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * @return string
25 |      */
26 |     protected function getFullEndpoint(): string
27 |     {
28 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
29 |     }
30 | 
31 |     /**
32 |      * @return bool|void
33 |      */
34 |     protected function validateParams(): void
35 |     {
36 |         if (empty($this->symbol)) {
37 |             throw WrongData::invalidValuesProvided('Please provide symbol to query!');
38 |         }
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) Steven Richardson
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------
/src/Stocks/VolumeByVenue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class VolumeByVenue extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/volume-by-venue';
12 | 
13 |     /**
14 |      * Create constructor.
15 |      *
16 |      * @param  IEXCloud  $api
17 |      */
18 |     public function __construct(IEXCloud $api)
19 |     {
20 |         parent::__construct($api);
21 |     }
22 | 
23 |     /**
24 |      * If the field property is set, add it to the end of the endpoint string.
25 |      *
26 |      * @return string
27 |      */
28 |     protected function getFullEndpoint(): string
29 |     {
30 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
31 |     }
32 | 
33 |     /**
34 |      * @return bool|void
35 |      * @throws WrongData
36 |      */
37 |     protected function validateParams(): void
38 |     {
39 |         if (empty($this->symbol)) {
40 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
41 |         }
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 | <head>
 4 |   <meta charset="UTF-8">
 5 |   <title>Document</title>
 6 |   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
 7 |   <meta name="description" content="Description">
 8 |   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
 9 |   <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
10 |     <style>
11 |         .cover-main img {
12 |             max-width: 300px;
13 |         }
14 |     </style>
15 | </head>
16 | <body>
17 |   <div id="app"></div>
18 |   <script>
19 |     window.$docsify = {
20 |         coverpage: true,
21 |         onlyCover: false,
22 |         loadSidebar: true,
23 |         subMaxLevel: 2,
24 |         loadNavbar: true,
25 |         themeColor: '#EF0073',
26 |         name: 'IEX Cloud PHP SDK',
27 |         repo: 'digitonic/iex-cloud-sdk'
28 |     }
29 |   </script>
30 |   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
31 |   <script src="//unpkg.com/prismjs/components/prism-php.min.js"></script>
32 |   <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
33 | </body>
34 | </html>
35 | 


--------------------------------------------------------------------------------
/src/Stocks/IntradayPrices.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | /**
10 |  * Class IntradayPrices
11 |  * @package Digitonic\IexCloudSdk\Stocks
12 |  * todo - Currently there is no mechanism for optional fields to be passed.
13 |  */
14 | class IntradayPrices extends BaseRequest
15 | {
16 |     const ENDPOINT = 'stock/{symbol}/intraday-prices';
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * If the oddLot property is set, add it to the end of the endpoint string.
30 |      *
31 |      * @return string
32 |      */
33 |     protected function getFullEndpoint(): string
34 |     {
35 |         return str_replace('{symbol}', $this->symbol, self::ENDPOINT);
36 |     }
37 | 
38 |     /**
39 |      * @return bool|void
40 |      * @throws WrongData
41 |      */
42 |     protected function validateParams(): void
43 |     {
44 |         if (empty($this->symbol)) {
45 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
46 |         }
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Tops.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Tops extends BaseRequest
10 | {
11 |     const ENDPOINT = 'tops?symbols={symbols}';
12 | 
13 |     protected $symbols;
14 | 
15 |     /**
16 |      * Create constructor.
17 |      *
18 |      * @param  IEXCloud  $api
19 |      */
20 |     public function __construct(IEXCloud $api)
21 |     {
22 |         parent::__construct($api);
23 |     }
24 | 
25 |     /**
26 |      * @param  mixed  ...$symbols
27 |      *
28 |      * @return Tops
29 |      */
30 |     public function setSymbols(...$symbols): self
31 |     {
32 |         $this->symbols = implode(',', $symbols);
33 | 
34 |         return $this;
35 |     }
36 | 
37 |     /**
38 |      * @return string
39 |      */
40 |     protected function getFullEndpoint(): string
41 |     {
42 |         return str_replace('{symbols}', $this->symbols, self::ENDPOINT);
43 |     }
44 | 
45 |     /**
46 |      * @return bool|void
47 |      */
48 |     protected function validateParams(): void
49 |     {
50 |         if (empty($this->symbols)) {
51 |             throw WrongData::invalidValuesProvided('Please provide symbol(s) to query!');
52 |         }
53 |     }
54 | }
55 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Last.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Last extends BaseRequest
10 | {
11 |     const ENDPOINT = 'tops/last?symbols={symbols}';
12 | 
13 |     protected $symbols;
14 | 
15 |     /**
16 |      * Create constructor.
17 |      *
18 |      * @param  IEXCloud  $api
19 |      */
20 |     public function __construct(IEXCloud $api)
21 |     {
22 |         parent::__construct($api);
23 |     }
24 | 
25 |     /**
26 |      * @param  mixed  ...$symbols
27 |      *
28 |      * @return Last
29 |      */
30 |     public function setSymbols(...$symbols): self
31 |     {
32 |         $this->symbols = implode(',', $symbols);
33 | 
34 |         return $this;
35 |     }
36 | 
37 |     /**
38 |      * @return string
39 |      */
40 |     protected function getFullEndpoint(): string
41 |     {
42 |         return str_replace('{symbols}', $this->symbols, self::ENDPOINT);
43 |     }
44 | 
45 |     /**
46 |      * @return bool|void
47 |      */
48 |     protected function validateParams(): void
49 |     {
50 |         if (empty($this->symbols)) {
51 |             throw WrongData::invalidValuesProvided('Please provide symbol(s) to query!');
52 |         }
53 |     }
54 | }
55 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/SsrStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class SsrStatus extends BaseRequest
10 | {
11 |     const ENDPOINT = 'deep/ssr-status?symbols={symbols}';
12 | 
13 |     /**
14 |      * @var string
15 |      */
16 |     private $symbols;
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * @param  mixed  ...$symbols
30 |      *
31 |      * @return SsrStatus
32 |      */
33 |     public function setSymbols(...$symbols): self
34 |     {
35 |         $this->symbols = implode(',', $symbols);
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace('{symbols}', $this->symbols, self::ENDPOINT);
46 |     }
47 | 
48 |     /**
49 |      * @return bool|void
50 |      */
51 |     protected function validateParams(): void
52 |     {
53 |         if (empty($this->symbols)) {
54 |             throw WrongData::invalidValuesProvided('Please provide symbol(s) to query!');
55 |         }
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/OpHaltStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class OpHaltStatus extends BaseRequest
10 | {
11 |     const ENDPOINT = 'deep/op-halt-status?symbols={symbols}';
12 | 
13 |     /**
14 |      * @var string
15 |      */
16 |     private $symbols;
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * @param  mixed  ...$symbols
30 |      *
31 |      * @return OpHaltStatus
32 |      */
33 |     public function setSymbols(...$symbols): self
34 |     {
35 |         $this->symbols = implode(',', $symbols);
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace('{symbols}', $this->symbols, self::ENDPOINT);
46 |     }
47 | 
48 |     /**
49 |      * @return bool|void
50 |      */
51 |     protected function validateParams(): void
52 |     {
53 |         if (empty($this->symbols)) {
54 |             throw WrongData::invalidValuesProvided('Please provide symbol(s) to query!');
55 |         }
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/OfficialPrice.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class OfficialPrice extends BaseRequest
10 | {
11 |     const ENDPOINT = 'deep/official-price?symbols={symbols}';
12 | 
13 |     /**
14 |      * @var string
15 |      */
16 |     private $symbols;
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * @param  mixed  ...$symbols
30 |      *
31 |      * @return OfficialPrice
32 |      */
33 |     public function setSymbols(...$symbols): self
34 |     {
35 |         $this->symbols = implode(',', $symbols);
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace('{symbols}', $this->symbols, self::ENDPOINT);
46 |     }
47 | 
48 |     /**
49 |      * @return bool|void
50 |      */
51 |     protected function validateParams(): void
52 |     {
53 |         if (empty($this->symbols)) {
54 |             throw WrongData::invalidValuesProvided('Please provide symbol(s) to query!');
55 |         }
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/TradingStatus.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class TradingStatus extends BaseRequest
10 | {
11 |     const ENDPOINT = 'deep/trading-status?symbols={symbols}';
12 | 
13 |     /**
14 |      * @var string
15 |      */
16 |     private $symbols;
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * @param  mixed  ...$symbols
30 |      *
31 |      * @return TradingStatus
32 |      */
33 |     public function setSymbols(...$symbols): self
34 |     {
35 |         $this->symbols = implode(',', $symbols);
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace('{symbols}', $this->symbols, self::ENDPOINT);
46 |     }
47 | 
48 |     /**
49 |      * @return bool|void
50 |      */
51 |     protected function validateParams(): void
52 |     {
53 |         if (empty($this->symbols)) {
54 |             throw WrongData::invalidValuesProvided('Please provide symbol(s) to query!');
55 |         }
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/Trades.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\InvestorsExchangeData\Last;
 8 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 9 | 
10 | class Trades extends BaseRequest
11 | {
12 |     const ENDPOINT = 'deep/trades?symbols={symbols}';
13 | 
14 |     /**
15 |      * @var string
16 |      */
17 |     private $symbols;
18 | 
19 |     /**
20 |      * Create constructor.
21 |      *
22 |      * @param  IEXCloud  $api
23 |      */
24 |     public function __construct(IEXCloud $api)
25 |     {
26 |         parent::__construct($api);
27 |     }
28 | 
29 |     /**
30 |      * @param  mixed  ...$symbols
31 |      *
32 |      * @return Trades
33 |      */
34 |     public function setSymbols(...$symbols): self
35 |     {
36 |         $this->symbols = implode(',', $symbols);
37 | 
38 |         return $this;
39 |     }
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace('{symbols}', $this->symbols, self::ENDPOINT);
46 |     }
47 | 
48 |     /**
49 |      * @return bool|void
50 |      */
51 |     protected function validateParams(): void
52 |     {
53 |         if (empty($this->symbols)) {
54 |             throw WrongData::invalidValuesProvided('Please provide symbol(s) to query!');
55 |         }
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/Client.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk;
 4 | 
 5 | use GuzzleHttp\Client as Guzzle;
 6 | use GuzzleHttp\Exception\ClientException;
 7 | use GuzzleHttp\Exception\GuzzleException;
 8 | use Psr\Http\Message\RequestInterface;
 9 | use Psr\Http\Message\ResponseInterface;
10 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
11 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
12 | 
13 | class Client implements IEXCloud
14 | {
15 |     /**
16 |      * @var Guzzle|null
17 |      */
18 |     private $client = null;
19 | 
20 |     /**
21 |      * Client constructor.
22 |      *
23 |      * @param  Guzzle  $client
24 |      */
25 |     public function __construct(Guzzle $client)
26 |     {
27 |         $this->client = $client;
28 |     }
29 | 
30 |     /**
31 |      * @param  RequestInterface  $request
32 |      * @param  array  $options
33 |      *
34 |      * @return ResponseInterface
35 |      * @throws GuzzleException
36 |      * @throws WrongData
37 |      */
38 |     public function send(RequestInterface $request, array $options = []): ResponseInterface
39 |     {
40 |         try {
41 |             parse_str(parse_url($request->getUri(), PHP_URL_QUERY), $query);
42 | 
43 |             return $this->client->send($request, [
44 |                 'query' => array_merge($this->client->getConfig('query') ?? [], $query)
45 |             ]);
46 |         }
47 |         catch (ClientException $e) {
48 |             throw WrongData::invalidValuesProvided($e->getMessage());
49 |         }
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/src/DataApis/DataPoints.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\DataApis;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class DataPoints extends BaseRequest
10 | {
11 |     const ENDPOINT = 'data-points/{symbol}/{key}';
12 | 
13 |     /**
14 |      * @var string
15 |      */
16 |     protected $key = '';
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * @param  string  $key
30 |      *
31 |      * @return DataPoints
32 |      */
33 |     public function setKey(string $key): self
34 |     {
35 |         $this->key = $key;
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace(
46 |             '{symbol}',
47 |             $this->symbol,
48 |             str_replace(
49 |                 '{key}',
50 |                 $this->key,
51 |                 self::ENDPOINT
52 |             )
53 |         );
54 |     }
55 | 
56 |     protected function validateParams()
57 |     {
58 |         if (empty($this->symbol)) {
59 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
60 |         }
61 |     }
62 | }
63 | 


--------------------------------------------------------------------------------
/docs/account.md:
--------------------------------------------------------------------------------
 1 | # Account
 2 | 
 3 | ## Metadata
 4 | 
 5 | Used to retrieve account details such as current tier, payment status, message quote usage, etc.
 6 | 
 7 | **Example**
 8 | 
 9 | ```php
10 | use \Digitonic\IexCloudSdk\Account\Metadata;
11 | 
12 | $endpoint = new Metadata($client);
13 | $response = $endpoint->get();
14 | 
15 | // Laravel
16 | use \Digitonic\IexCloudSdk\Facades\Account\Metadata;
17 | 
18 | $response = Metadata::get();
19 | ```
20 | 
21 | **Response**
22 | 
23 | ```php
24 | Collection {#275 ▼
25 |   #items: array:7 [▼
26 |     "payAsYouGoEnabled" => false
27 |     "effectiveDate" => 1621337109805
28 |     "subscriptionTermType" => "mnlhyto"
29 |     "tierName" => "tstar"
30 |     "messageLimit" => 514440
31 |     "messagesUsed" => 13578
32 |     "circuitBreaker" => null
33 |   ]
34 | }
35 | ```
36 | 
37 | ## Usage
38 | 
39 | Used to retrieve current month usage for your account.
40 | 
41 | **Example**
42 | 
43 | ```php
44 | use \Digitonic\IexCloudSdk\Account\Usage;
45 | 
46 | $endpoint = new Usage($client);
47 | $response = $endpoint->get();
48 | 
49 | // Laravel
50 | use \Digitonic\IexCloudSdk\Facades\Account\Usage;
51 | 
52 | $response = Usage::get();
53 | ```
54 | 
55 | **Response**
56 | 
57 | ```php
58 | Collection {#265 ▼
59 |   #items: array:2 [▼
60 |     "messages" => {#275 ▼
61 |       +"dailyUsage": {#277 ▶}
62 |       +"monthlyUsage": 12778
63 |       +"monthlyPayAsYouGo": 0
64 |       +"tokenUsage": {#278 ▶}
65 |       +"keyUsage": {#272 ▶}
66 |     }
67 |     "rules" => []
68 |   ]
69 | }
70 | ```
71 | 


--------------------------------------------------------------------------------
/src/ReferenceData/RegionSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class RegionSymbols extends BaseRequest
10 | {
11 |     const ENDPOINT = 'ref-data/region/{region}/symbols';
12 | 
13 |     /**
14 |      * @var string
15 |      */
16 |     private $region;
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * @param  string  $region
30 |      *
31 |      * @return RegionSymbols
32 |      */
33 |     public function setRegion(string $region): self
34 |     {
35 |         $this->region = $region;
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace('{region}', $this->region, self::ENDPOINT);
46 |     }
47 | 
48 |     /**
49 |      * @return bool|void
50 |      */
51 |     protected function validateParams(): void
52 |     {
53 |         if (empty($this->region)) {
54 |             throw WrongData::invalidValuesProvided(
55 |                 'Region required using 2 letter case insensitive string of country codes using ISO 3166-1 alpha-2'
56 |             );
57 |         }
58 |     }
59 | }
60 | 


--------------------------------------------------------------------------------
/src/Stocks/DelayedQuote.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class DelayedQuote extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/delayed-quote';
12 | 
13 |     /**
14 |      * @var bool
15 |      */
16 |     protected $oddLot = false;
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * If the oddLot property is set, add it to the end of the endpoint string.
30 |      *
31 |      * @return string
32 |      */
33 |     protected function getFullEndpoint(): string
34 |     {
35 |         $endpoint = str_replace('{symbol}', $this->symbol, self::ENDPOINT);
36 | 
37 |         return $this->oddLot ? "$endpoint/oddLot=$this->oddLot" : $endpoint;
38 |     }
39 | 
40 |     /**
41 |      * @return bool|void
42 |      * @throws WrongData
43 |      */
44 |     protected function validateParams(): void
45 |     {
46 |         if (empty($this->symbol)) {
47 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
48 |         }
49 |     }
50 | 
51 |     public function oddLot(bool $oddLot = true): self
52 |     {
53 |         $this->oddLot = $oddLot;
54 | 
55 |         return $this;
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/ReferenceData/ExchangeSymbols.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ReferenceData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class ExchangeSymbols extends BaseRequest
10 | {
11 |     const ENDPOINT = 'ref-data/exchange/{exchange}/symbols';
12 | 
13 |     /**
14 |      * @var string
15 |      */
16 |     private $exchange;
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * @param  string  $exchange
30 |      *
31 |      * @return ExchangeSymbols
32 |      */
33 |     public function setExchange(string $exchange): self
34 |     {
35 |         $this->exchange = $exchange;
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     /**
41 |      * @return string
42 |      */
43 |     protected function getFullEndpoint(): string
44 |     {
45 |         return str_replace('{exchange}', $this->exchange, self::ENDPOINT);
46 |     }
47 | 
48 |     /**
49 |      * @return bool|void
50 |      */
51 |     protected function validateParams(): void
52 |     {
53 |         if (empty($this->exchange)) {
54 |             throw WrongData::invalidValuesProvided(
55 |                 'Required case insensitive string of Exchange using IEX Supported Exchanges list'
56 |             );
57 |         }
58 |     }
59 | }
60 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "digitonic/iex-cloud-sdk",
 3 |     "description": "Unofficial PHP SDK for IEX Cloud API",
 4 |     "keywords": [
 5 |         "digitonic",
 6 |         "iex-cloud-sdk"
 7 |     ],
 8 |     "homepage": "https://github.com/digitonic/iex-cloud-sdk",
 9 |     "license": "MIT",
10 |     "type": "library",
11 |     "authors": [
12 |         {
13 |             "name": "Steven Richardson",
14 |             "email": "steven@digitonic.co.uk",
15 |             "role": "Developer"
16 |         }
17 |     ],
18 |     "require": {
19 |         "php": "^7.1",
20 |         "ext-json": "*",
21 |         "guzzlehttp/guzzle": "^6.3",
22 |         "illuminate/support": "5.8.*|6.*|7.*|8.*"
23 |     },
24 |     "require-dev": {
25 |         "orchestra/testbench": "3.8.*",
26 |         "phpunit/phpunit": "^7.0"
27 |     },
28 |     "autoload": {
29 |         "psr-4": {
30 |             "Digitonic\\IexCloudSdk\\": "src"
31 |         }
32 |     },
33 |     "autoload-dev": {
34 |         "psr-4": {
35 |             "Digitonic\\IexCloudSdk\\Tests\\": "tests"
36 |         }
37 |     },
38 |     "scripts": {
39 |         "test": "vendor/bin/phpunit",
40 |         "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
41 | 
42 |     },
43 |     "config": {
44 |         "sort-packages": true
45 |     },
46 |     "extra": {
47 |         "laravel": {
48 |             "providers": [
49 |                 "Digitonic\\IexCloudSdk\\IexCloudSdkServiceProvider"
50 |             ],
51 |             "aliases": {
52 |                 "IexCloudSdk": "Digitonic\\IexCloudSdk\\IexCloudSdkFacade"
53 |             }
54 |         }
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/src/ForexCurrencies/ExchangeRates.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\ForexCurrencies;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 7 | 
 8 | class ExchangeRates extends BaseRequest
 9 | {
10 |     const ENDPOINT = 'fx/rate/{from}/{to}';
11 | 
12 |     /**
13 |      * @var string
14 |      */
15 |     private $fromCurrency = 'USD';
16 | 
17 |     /**
18 |      * @var string
19 |      */
20 |     private $toCurrency = 'GBP';
21 | 
22 |     /**
23 |      * Create constructor.
24 |      *
25 |      * @param  IEXCloud  $api
26 |      */
27 |     public function __construct(IEXCloud $api)
28 |     {
29 |         parent::__construct($api);
30 |     }
31 | 
32 |     /**
33 |      * @param  string  $fromCurrency
34 |      *
35 |      * @return ExchangeRates
36 |      */
37 |     public function setFrom(string $fromCurrency): self
38 |     {
39 |         $this->fromCurrency = $fromCurrency;
40 | 
41 |         return $this;
42 |     }
43 | 
44 |     /**
45 |      * @param  string  $toCurrency
46 |      *
47 |      * @return ExchangeRates
48 |      */
49 |     public function setTo(string $toCurrency): self
50 |     {
51 |         $this->toCurrency = $toCurrency;
52 | 
53 |         return $this;
54 |     }
55 | 
56 |     /**
57 |      * @return string
58 |      */
59 |     protected function getFullEndpoint(): string
60 |     {
61 |         return str_replace(
62 |             '{from}',
63 |             $this->fromCurrency,
64 |             str_replace(
65 |                 '{to}',
66 |                 $this->toCurrency,
67 |                 self::ENDPOINT
68 |             )
69 |         );
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/src/Requests/BaseRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Requests;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use GuzzleHttp\Psr7\Request;
 8 | use Illuminate\Support\Collection;
 9 | 
10 | abstract class BaseRequest
11 | {
12 |     const ENDPOINT = '';
13 | 
14 |     protected $method = 'GET';
15 | 
16 |     protected $payload = [];
17 | 
18 |     protected $api;
19 | 
20 |     protected $symbol = '';
21 | 
22 |     public function __construct(IEXCloud $api)
23 |     {
24 |         $this->api = $api;
25 |     }
26 | 
27 |     public function setSymbol(string $symbol): self
28 |     {
29 |         $this->symbol = $symbol;
30 | 
31 |         return $this;
32 |     }
33 | 
34 |     public function send(): Collection
35 |     {
36 |         $this->validateParams();
37 | 
38 |         $request = new Request($this->method, $this->getFullEndpoint(), [], json_encode($this->payload));
39 | 
40 |         $response = $this->api->send($request);
41 | 
42 |         return collect(json_decode($response->getBody()->getContents()));
43 |     }
44 | 
45 |     public function get(): Collection
46 |     {
47 |         $this->method = 'GET';
48 | 
49 |         return $this->send();
50 |     }
51 | 
52 |     public function post(): Collection
53 |     {
54 |         $this->method = 'POST';
55 | 
56 |         if (empty($this->payload)) {
57 |             throw WrongData::invalidValuesProvided('Payload required to perform a POST request');
58 |         }
59 | 
60 |         return $this->send();
61 |     }
62 | 
63 |     abstract protected function getFullEndpoint(): string;
64 | 
65 |     protected function validateParams()
66 |     {
67 |         return true;
68 |     }
69 | }
70 | 


--------------------------------------------------------------------------------
/src/Stocks/Quote.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class Quote extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/quote';
12 | 
13 |     /**
14 |      * IEX Cloud Documentation provides for the optional field to be added to
15 |      * the end of the endpoint uri in order to retrieve a specific field.
16 |      * This property allows that functionality to be used in this SDK.
17 |      */
18 |     public $field;
19 | 
20 |     /**
21 |      * Create constructor.
22 |      *
23 |      * @param  IEXCloud  $api
24 |      */
25 |     public function __construct(IEXCloud $api)
26 |     {
27 |         parent::__construct($api);
28 |     }
29 | 
30 |     /**
31 |      * If the field property is set, add it to the end of the endpoint string.
32 |      *
33 |      * @return string
34 |      */
35 |     protected function getFullEndpoint(): string
36 |     {
37 |         $endpoint = str_replace('{symbol}', $this->symbol, self::ENDPOINT);
38 | 
39 |         return $this->field ? "$endpoint/$this->field" : $endpoint;
40 |     }
41 | 
42 |     /**
43 |      * @return bool|void
44 |      * @throws WrongData
45 |      */
46 |     protected function validateParams(): void
47 |     {
48 |         if (empty($this->symbol)) {
49 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
50 |         }
51 |     }
52 | 
53 |     /**
54 |      * Setter for field property
55 |      *
56 |      * @param  string  $field
57 |      *
58 |      * @return Quote
59 |      */
60 |     public function only(string $field): self
61 |     {
62 |         $this->field = $field;
63 | 
64 |         return $this;
65 |     }
66 | }
67 | 


--------------------------------------------------------------------------------
/src/Stocks/KeyStats.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class KeyStats extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/stats';
12 | 
13 |     /**
14 |      * IEX Cloud Documentation provides for the optional field to be added to
15 |      * the end of the endpoint uri in order to retrieve a specific field.
16 |      * This property allows that functionality to be used in this SDK.
17 |      */
18 |     public $field;
19 | 
20 |     /**
21 |      * Create constructor.
22 |      *
23 |      * @param  IEXCloud  $api
24 |      */
25 |     public function __construct(IEXCloud $api)
26 |     {
27 |         parent::__construct($api);
28 |     }
29 | 
30 |     /**
31 |      * If the field property is set, add it to the end of the endpoint string.
32 |      *
33 |      * @return string
34 |      */
35 |     protected function getFullEndpoint(): string
36 |     {
37 |         $endpoint = str_replace('{symbol}', $this->symbol, self::ENDPOINT);
38 | 
39 |         return $this->field ? "$endpoint/$this->field" : $endpoint;
40 |     }
41 | 
42 |     /**
43 |      * @return bool|void
44 |      * @throws WrongData
45 |      */
46 |     protected function validateParams(): void
47 |     {
48 |         if (empty($this->symbol)) {
49 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
50 |         }
51 |     }
52 | 
53 |     /**
54 |      * Setter for field property
55 |      *
56 |      * @param  string  $field
57 |      *
58 |      * @return KeyStats
59 |      */
60 |     public function only(string $field): self
61 |     {
62 |         $this->field = $field;
63 | 
64 |         return $this;
65 |     }
66 | }
67 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # IEX Cloud SDK
 2 | 
 3 | [![Latest Version on Packagist](https://img.shields.io/packagist/v/digitonic/iex-cloud-sdk.svg?style=flat-square)](https://packagist.org/packages/digitonic/iex-cloud-sdk)
 4 | [![Build Status](https://travis-ci.com/digitonic/iex-cloud-sdk.svg?branch=master)](https://travis-ci.com/digitonic/iex-cloud-sdk)
 5 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/?branch=master)
 6 | [![Code Coverage](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/?branch=master)
 7 | [![Total Downloads](https://img.shields.io/packagist/dt/digitonic/iex-cloud-sdk.svg?style=flat-square)](https://packagist.org/packages/digitonic/iex-cloud-sdk)
 8 | 
 9 | A PHP package for accessing the IEX Cloud API. It focuses heavily on the Laravel Framework however it will work in any standalone project with usage of Composer.
10 | 
11 | ## Installation
12 | 
13 | You can install the package via composer:
14 | 
15 | ```bash
16 | composer require digitonic/iex-cloud-sdk
17 | ```
18 | 
19 | ## Usage
20 | 
21 | Please see the [documentation](https://digitonic.github.io/iex-cloud-sdk/#/) for details.
22 | 
23 | ### Testing
24 | 
25 | ``` bash
26 | composer test
27 | ```
28 | 
29 | ### Changelog
30 | 
31 | Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
32 | 
33 | ## Contributing
34 | 
35 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
36 | 
37 | ### Security
38 | 
39 | If you discover any security related issues, please email steven@digitonic.co.uk instead of using the issue tracker.
40 | 
41 | ## Credits
42 | 
43 | - [Steven Richardson](https://github.com/richdynamix)
44 | - [All Contributors](../../contributors)
45 | 
46 | ## License
47 | 
48 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
49 | 


--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
 1 | # IEX Cloud SDK
 2 | 
 3 | [![Latest Version on Packagist](https://img.shields.io/packagist/v/digitonic/iex-cloud-sdk.svg?style=flat-square)](https://packagist.org/packages/digitonic/iex-cloud-sdk)
 4 | [![Build Status](https://travis-ci.com/digitonic/iex-cloud-sdk.svg?branch=master)](https://travis-ci.com/digitonic/iex-cloud-sdk)
 5 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/?branch=master)
 6 | [![Code Coverage](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/digitonic/iex-cloud-sdk/?branch=master)
 7 | [![Total Downloads](https://img.shields.io/packagist/dt/digitonic/iex-cloud-sdk.svg?style=flat-square)](https://packagist.org/packages/digitonic/iex-cloud-sdk)
 8 | 
 9 | A PHP package for accessing the IEX Cloud API. It focuses heavily on the Laravel Framework however it will work in any standalone project with usage of Composer.
10 | 
11 | ## Installation
12 | 
13 | You can install the package via composer:
14 | 
15 | ```bash
16 | composer require digitonic/iex-cloud-sdk
17 | ```
18 | 
19 | ## Usage
20 | 
21 | Please see the [documentation](https://digitonic.github.io/iex-cloud-sdk/#/) for details.
22 | 
23 | ### Testing
24 | 
25 | ``` bash
26 | composer test
27 | ```
28 | 
29 | ### Changelog
30 | 
31 | Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
32 | 
33 | ## Contributing
34 | 
35 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
36 | 
37 | ### Security
38 | 
39 | If you discover any security related issues, please email steven@digitonic.co.uk instead of using the issue tracker.
40 | 
41 | ## Credits
42 | 
43 | - [Steven Richardson](https://github.com/richdynamix)
44 | - [All Contributors](../../contributors)
45 | 
46 | ## License
47 | 
48 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
49 | 


--------------------------------------------------------------------------------
/src/Stocks/News.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\Stocks;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class News extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/news{last}';
12 | 
13 |     /**
14 |      * @var int
15 |      */
16 |     private $last;
17 | 
18 |     /**
19 |      * Create constructor.
20 |      *
21 |      * @param  IEXCloud  $api
22 |      */
23 |     public function __construct(IEXCloud $api)
24 |     {
25 |         parent::__construct($api);
26 |     }
27 | 
28 |     /**
29 |      * @param  int  $take
30 |      *
31 |      * @return $this
32 |      * @throws WrongData
33 |      */
34 |     public function take(int $take): self
35 |     {
36 |         $this->validateLastParam($take);
37 | 
38 |         $this->last = $take;
39 | 
40 |         return $this;
41 |     }
42 | 
43 |     /**
44 |      * @return string
45 |      */
46 |     protected function getFullEndpoint(): string
47 |     {
48 |         $endpoint = str_replace('{symbol}', $this->symbol, self::ENDPOINT);
49 |         $endpoint = str_replace('{last}', "/last/$this->last", $endpoint);
50 | 
51 |         return $endpoint;
52 |     }
53 | 
54 |     /**
55 |      * @return bool|void
56 |      * @throws WrongData
57 |      */
58 |     protected function validateParams(): void
59 |     {
60 |         if (empty($this->symbol)) {
61 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
62 |         }
63 |     }
64 | 
65 |     /**
66 |      * @param  int  $take
67 |      *
68 |      * @throws WrongData
69 |      */
70 |     private function validateLastParam(int $take)
71 |     {
72 |         if ($take < 1) {
73 |             throw WrongData::invalidValuesProvided('Must take at least one item.');
74 |         }
75 | 
76 |         if ($take > 50) {
77 |             throw WrongData::invalidValuesProvided('Cannot take more than 50 items in one call');
78 |         }
79 |     }
80 | }
81 | 


--------------------------------------------------------------------------------
/src/IexCloudSdkServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk;
 4 | 
 5 | use GuzzleHttp\Client;
 6 | use Illuminate\Support\ServiceProvider;
 7 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 8 | use Digitonic\IexCloudSdk\Exceptions\InvalidConfig;
 9 | 
10 | class IexCloudSdkServiceProvider extends ServiceProvider
11 | {
12 |     /**
13 |      * Bootstrap the application services.
14 |      */
15 |     public function boot()
16 |     {
17 |         if ($this->app->runningInConsole()) {
18 |             $this->publishes([
19 |                 __DIR__.'/../config/config.php' => config_path('iex-cloud-sdk.php'),
20 |             ], 'config');
21 |         }
22 |     }
23 | 
24 |     /**
25 |      * Register the application services.
26 |      */
27 |     public function register()
28 |     {
29 |         $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'iex-cloud-sdk');
30 | 
31 |         $this->app->bind(IEXCloud::class, function () {
32 |             $config = config('iex-cloud-sdk');
33 | 
34 |             $this->guardAgainstInvalidConfig($config);
35 | 
36 |             $guzzle = new Client([
37 |                 'base_uri' => $config['sandbox'] ? $config['sandbox_base_url'] : $config['base_url'],
38 |                 'headers' => [
39 |                     'Accept' => 'application/json',
40 |                     'Content-Type' => 'application/json'
41 |                 ],
42 |                 'query' => ['token' => $config['secret_key']]
43 |             ]);
44 | 
45 |             return new \Digitonic\IexCloudSdk\Client($guzzle);
46 |         });
47 |     }
48 | 
49 |     /**
50 |      * @param  array|null  $config
51 |      */
52 |     protected function guardAgainstInvalidConfig(array $config = null)
53 |     {
54 |         if (empty($config['base_url'])) {
55 |             throw InvalidConfig::baseUrlNotSpecified();
56 |         }
57 | 
58 |         if (empty($config['secret_key'])) {
59 |             throw InvalidConfig::apiKeyNotSpecified();
60 |         }
61 | 
62 |         if (empty($config['public_key'])) {
63 |             throw InvalidConfig::apiKeyNotSpecified();
64 |         }
65 |     }
66 | }
67 | 


--------------------------------------------------------------------------------
/src/AlternativeData/SocialSentiment.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\AlternativeData;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 8 | 
 9 | class SocialSentiment extends BaseRequest
10 | {
11 |     const ENDPOINT = 'stock/{symbol}/sentiment/{type}/{date}';
12 | 
13 |     /**
14 |      * @var string
15 |      */
16 |     private $type = 'daily';
17 | 
18 |     /**
19 |      * @var string
20 |      */
21 |     private $date;
22 | 
23 |     /**
24 |      * Create constructor.
25 |      *
26 |      * @param  IEXCloud  $api
27 |      */
28 |     public function __construct(IEXCloud $api)
29 |     {
30 |         parent::__construct($api);
31 |     }
32 | 
33 |     public function setType(string $type): self
34 |     {
35 |         $this->type = $type;
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     public function setDate(string $date): self
41 |     {
42 |         $this->validateDate($date);
43 | 
44 |         $this->date = $date;
45 | 
46 |         return $this;
47 |     }
48 | 
49 |     /**
50 |      * @return string
51 |      */
52 |     protected function getFullEndpoint(): string
53 |     {
54 |         $endpoint = str_replace('{symbol}', $this->symbol, self::ENDPOINT);
55 |         $endpoint = str_replace('{type}', $this->type, $endpoint);
56 |         $endpoint = str_replace('{date}', $this->date, $endpoint);
57 | 
58 |         return $endpoint;
59 | 
60 |     }
61 | 
62 |     /**
63 |      * @return bool|void
64 |      * @throws WrongData
65 |      */
66 |     protected function validateParams(): void
67 |     {
68 |         if (empty($this->symbol)) {
69 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
70 |         }
71 |     }
72 | 
73 |     private function validateDate(string $date)
74 |     {
75 |         $re = '/(20\d{2})(\d{2})(\d{2})/mi';
76 | 
77 |         preg_match_all($re, $date, $matches, PREG_SET_ORDER, 0);
78 | 
79 |         if (empty($matches)) {
80 |             throw WrongData::invalidValuesProvided('Format date to use YYYYMMDD to fetch sentiment data.');
81 |         }
82 |     }
83 | }
84 | 


--------------------------------------------------------------------------------
/src/InvestorsExchangeData/Deep/TradeBreak.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Digitonic\IexCloudSdk\InvestorsExchangeData\Deep;
 4 | 
 5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
 6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
 7 | use Digitonic\IexCloudSdk\InvestorsExchangeData\Last;
 8 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
 9 | 
10 | class TradeBreak extends BaseRequest
11 | {
12 |     const ENDPOINT = 'deep/trade-breaks?symbols={symbols}&last={last}';
13 | 
14 |     /**
15 |      * @var string
16 |      */
17 |     private $symbols;
18 | 
19 |     /**
20 |      * @var int
21 |      */
22 |     private $last = 20;
23 | 
24 |     /**
25 |      * Create constructor.
26 |      *
27 |      * @param  IEXCloud  $api
28 |      */
29 |     public function __construct(IEXCloud $api)
30 |     {
31 |         parent::__construct($api);
32 |     }
33 | 
34 |     /**
35 |      * @param  mixed  ...$symbols
36 |      *
37 |      * @return TradeBreak
38 |      */
39 |     public function setSymbols(...$symbols): self
40 |     {
41 |         $this->symbols = implode(',', $symbols);
42 | 
43 |         return $this;
44 |     }
45 | 
46 |     /**
47 |      * @param  int  $last
48 |      *
49 |      * @return TradeBreak
50 |      */
51 |     public function setLast(int $last): self
52 |     {
53 |         $this->validateLast($last);
54 | 
55 |         $this->last = $last;
56 | 
57 |         return $this;
58 |     }
59 | 
60 |     /**
61 |      * @return string
62 |      */
63 |     protected function getFullEndpoint(): string
64 |     {
65 |         $endpoint = str_replace('{symbols}', $this->symbols, self::ENDPOINT);
66 |         $endpoint = str_replace('{last}', $this->last, $endpoint);
67 | 
68 |         return $endpoint;
69 |     }
70 | 
71 |     /**
72 |      * @return bool|void
73 |      */
74 |     protected function validateParams(): void
75 |     {
76 |         if (empty($this->symbols)) {
77 |             throw WrongData::invalidValuesProvided('Please provide symbol(s) to query!');
78 |         }
79 |     }
80 | 
81 |     private function validateLast(int $last)
82 |     {
83 |         if ($last > 500) {
84 |             throw WrongData::invalidValuesProvided('Last query param must be less than 500');
85 |         }
86 |     }
87 | }
88 | 


--------------------------------------------------------------------------------
/config/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | Sandbox Mode
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | When sandbopx mode is enabled all apis will be performed against the
11 |     | sandbox base url by default. All data returned from this endpoint
12 |     | will be manipulated values and won't contain real data.
13 |     |
14 |     */
15 |     'sandbox' => env('IEX_CLOUD_SANDBOX', false),
16 | 
17 |     /*
18 |     |--------------------------------------------------------------------------
19 |     | Sandbox Base URL
20 |     |--------------------------------------------------------------------------
21 |     |
22 |     | Specify which Sandbox API should be used when sandbox = true
23 |     |
24 |     */
25 |     'sandbox_base_url' => 'https://sandbox.iexapis.com/v1/',
26 | 
27 |     /*
28 |     |--------------------------------------------------------------------------
29 |     | Base URL
30 |     |--------------------------------------------------------------------------
31 |     |
32 |     | IEX Cloud will release new versions when they make backwards-incompatible
33 |     | changes to the API. Use the Base URL configuration to determine which
34 |     | version of the API should be used.
35 |     |
36 |     */
37 |     'base_url' => env('IEX_CLOUD_BASE_URL', 'https://cloud.iexapis.com/v1/'),
38 | 
39 |     /*
40 |     |--------------------------------------------------------------------------
41 |     | Secret API Token
42 |     |--------------------------------------------------------------------------
43 |     |
44 |     | Secret API tokens should be kept confidential and only stored on your
45 |     | own servers. Your account’s secret API token can perform any
46 |     | API request to IEX Cloud.
47 |     |
48 |     */
49 |     'secret_key' => env('IEX_CLOUD_SECRET_KEY'),
50 | 
51 |     /*
52 |     |--------------------------------------------------------------------------
53 |     | Publishable API Token
54 |     |--------------------------------------------------------------------------
55 |     |
56 |     | Publishable API tokens are meant solely to identify your account with
57 |     | IEX Cloud, they aren’t secret. They can be published in places like
58 |     | your website JavaScript code, or in an iPhone or Android app.
59 |     |
60 |     */
61 |     'public_key' => env('IEX_CLOUD_PUBLIC_KEY')
62 | ];
63 | 


--------------------------------------------------------------------------------
/src/DataApis/TimeSeries/Query.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Digitonic\IexCloudSdk\DataApis\TimeSeries;
  4 | 
  5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
  6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
  7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
  8 | 
  9 | class Query extends BaseRequest
 10 | {
 11 |     const ENDPOINT = 'time-series/{id}/{key}/{subKey}';
 12 | 
 13 |     /**
 14 |      * @var string
 15 |      */
 16 |     protected $id = '';
 17 | 
 18 |     /**
 19 |      * @var string
 20 |      */
 21 |     protected $key = '';
 22 | 
 23 |     /**
 24 |      * @var string
 25 |      */
 26 |     protected $subKey = '';
 27 | 
 28 |     /**
 29 |      * Create constructor.
 30 |      *
 31 |      * @param  IEXCloud  $api
 32 |      */
 33 |     public function __construct(IEXCloud $api)
 34 |     {
 35 |         parent::__construct($api);
 36 |     }
 37 | 
 38 |     /**
 39 |      * @param  string  $id
 40 |      *
 41 |      * @return Query
 42 |      */
 43 |     public function setId(string $id): self
 44 |     {
 45 |         $this->id = $id;
 46 | 
 47 |         return $this;
 48 |     }
 49 | 
 50 |     /**
 51 |      * @param  string  $key
 52 |      *
 53 |      * @return Query
 54 |      */
 55 |     public function setKey(string $key): self
 56 |     {
 57 |         $this->key = $key;
 58 | 
 59 |         return $this;
 60 |     }
 61 | 
 62 |     /**
 63 |      * @param  string  $subKey
 64 |      *
 65 |      * @return Query
 66 |      */
 67 |     public function setSubKey(string $subKey): self
 68 |     {
 69 |         $this->subKey = $subKey;
 70 | 
 71 |         return $this;
 72 |     }
 73 | 
 74 |     /**
 75 |      * @return string
 76 |      */
 77 |     protected function getFullEndpoint(): string
 78 |     {
 79 |         $endpoint = str_replace('{id}', $this->id, self::ENDPOINT);
 80 |         $endpoint = str_replace('{key}', $this->key, $endpoint);
 81 |         $endpoint = str_replace('{subKey}', $this->subKey, $endpoint);
 82 | 
 83 |         return $endpoint;
 84 |     }
 85 | 
 86 |     /**
 87 |      * @return bool|void
 88 |      */
 89 |     protected function validateParams()
 90 |     {
 91 |         if (empty($this->id)) {
 92 |             throw WrongData::invalidValuesProvided('ID required to identify a time series dataset.');
 93 |         }
 94 | 
 95 |         if (empty($this->key)) {
 96 |             throw WrongData::invalidValuesProvided(
 97 |                 'Key required to identify data within a dataset. A common example is a symbol such as AAPL.'
 98 |             );
 99 |         }
100 |     }
101 | }
102 | 


--------------------------------------------------------------------------------
/docs/alt-data.md:
--------------------------------------------------------------------------------
  1 | # Alternative Data
  2 | 
  3 | ## Social Sentiment
  4 | 
  5 | This endpoint provides social sentiment data from StockTwits. Data can be viewed as a daily value, or by minute for a given date.
  6 | 
  7 | ```php
  8 | use \Digitonic\IexCloudSdk\AlternativeData\SocialSentiment;
  9 | 
 10 | $endpoint = new SocialSentiment($client);
 11 | $response = $endpoint->setSymbol('aapl')
 12 |                 ->setDate('20191012') // optional
 13 |                 ->setType('minute') // optional
 14 |                 ->get();
 15 | 
 16 | // Laravel
 17 | use \Digitonic\IexCloudSdk\Facades\AlternativeData\SocialSentiment;
 18 | 
 19 | $response = SocialSentiment::setSymbol('aapl')
 20 |                 ->setDate('20191012') // optional
 21 |                 ->setType('minute') // optional
 22 |                 ->get();
 23 | ```
 24 | 
 25 | **Response**
 26 | 
 27 | ```php
 28 | // Default daily 
 29 | Collection {#275 ▼
 30 |   #items: array:4 [▼
 31 |     "sentiment" => -0.03563327966
 32 |     "totalScores" => 133
 33 |     "positive" => 0.77
 34 |     "negative" => 0.26
 35 |   ]
 36 | }
 37 | 
 38 | // Minute
 39 | Collection {#390 ▼
 40 |   #items: array:119 [▼
 41 |     0 => {#277 ▼
 42 |       +"sentiment": 0
 43 |       +"totalScores": 1
 44 |       +"positive": 1
 45 |       +"negative": 0
 46 |       +"minute": "0006"
 47 |     }
 48 |     1 => {#275 ▼
 49 |       +"sentiment": 0.5764
 50 |       +"totalScores": 1
 51 |       +"positive": 1
 52 |       +"negative": 0
 53 |       +"minute": "0009"
 54 |     }
 55 |     2 => {#278 ▼
 56 |       +"sentiment": 0
 57 |       +"totalScores": 1
 58 |       +"positive": 1
 59 |       +"negative": 0
 60 |       +"minute": "0011"
 61 |     }
 62 |     3 => {#272 ▶}
 63 | ...
 64 | ```
 65 | 
 66 | 
 67 | 
 68 | ## CEO Compensation
 69 | 
 70 | This endpoint provides CEO compensation for a company by symbol.
 71 | 
 72 | **Example**
 73 | 
 74 | ```php
 75 | use \Digitonic\IexCloudSdk\AlternativeData\CeoComp;
 76 | 
 77 | $endpoint = new CeoComp($client);
 78 | $response = $endpoint->setSymbol('aapl')->get();
 79 | 
 80 | // Laravel
 81 | use \Digitonic\IexCloudSdk\Facades\AlternativeData\CeoComp;
 82 | 
 83 | $response = CeoComp::setSymbol('aapl')->get();
 84 | ```
 85 | 
 86 | **Response**
 87 | 
 88 | ```php
 89 | Collection {#275 ▼
 90 |   #items: array:13 [▼
 91 |     "symbol" => "AAPL"
 92 |     "name" => "oykh CtmooiT"
 93 |     "companyName" => "Apple Inc."
 94 |     "location" => "pCu,nACrt oei"
 95 |     "salary" => 3027049
 96 |     "bonus" => 0
 97 |     "stockAwards" => 0
 98 |     "optionAwards" => 0
 99 |     "nonEquityIncentives" => 12413724
100 |     "pensionAndDeferred" => 0
101 |     "otherComp" => 687647
102 |     "total" => 16079556
103 |     "year" => "2047"
104 |   ]
105 | }
106 | ```
107 | 


--------------------------------------------------------------------------------
/docs/cryptocurrency.md:
--------------------------------------------------------------------------------
  1 | # Cryptocurrency
  2 | 
  3 | ## Crypto Book
  4 | 
  5 | This returns a current snapshot of the book for a specified cryptocurrency.
  6 | 
  7 | **Example**
  8 | 
  9 | ```php
 10 | use \Digitonic\IexCloudSdk\AlternativeData\Crypto\Book;
 11 | 
 12 | $endpoint = new Book($client);
 13 | $response = $endpoint->setSymbol('BTCUSDT')->get();
 14 | 
 15 | // Laravel
 16 | use \Digitonic\IexCloudSdk\Facades\AlternativeData\Crypto\Book;
 17 | 
 18 | $response = Book::setSymbol('BTCUSDT')->get();
 19 | ```
 20 | 
 21 | **Response**
 22 | 
 23 | ```php
 24 | Collection {#272 ▼
 25 |   #items: array:2 [▼
 26 |     "bids" => array:1 [▼
 27 |       0 => {#277 ▼
 28 |         +"price": "8400.34"
 29 |         +"size": "0.054989"
 30 |         +"timestamp": 1615268896297
 31 |       }
 32 |     ]
 33 |     "asks" => array:1 [▼
 34 |       0 => {#278 ▼
 35 |         +"price": "8479.93"
 36 |         +"size": "0.033894"
 37 |         +"timestamp": 1630724675505
 38 |       }
 39 |     ]
 40 |   ]
 41 | }
 42 | ```
 43 | 
 44 | ## Crypto Price
 45 | 
 46 | This returns the price for a specified cryptocurrency.
 47 | 
 48 | **Example**
 49 | 
 50 | ```php
 51 | use \Digitonic\IexCloudSdk\AlternativeData\Crypto\Price;
 52 | 
 53 | $endpoint = new Price($client);
 54 | $response = $endpoint->setSymbol('BTCUSDT')->get();
 55 | 
 56 | // Laravel
 57 | use \Digitonic\IexCloudSdk\Facades\AlternativeData\Crypto\Price;
 58 | 
 59 | $response = Price::setSymbol('BTCUSDT')->get();
 60 | ```
 61 | 
 62 | **Response**
 63 | 
 64 | ```php
 65 | Collection {#275 ▼
 66 |   #items: array:2 [▼
 67 |     "price" => "8598.47"
 68 |     "symbol" => "BTCUSDT"
 69 |   ]
 70 | }
 71 | ```
 72 | 
 73 | ## Crypto Quote
 74 | 
 75 | This returns the quote for a specified cryptocurrency.
 76 | 
 77 | **Example**
 78 | 
 79 | ```php
 80 | use \Digitonic\IexCloudSdk\AlternativeData\Crypto\Quote;
 81 | 
 82 | $endpoint = new Quote($client);
 83 | $response = $endpoint->setSymbol('BTCUSDT')->get();
 84 | 
 85 | // Laravel
 86 | use \Digitonic\IexCloudSdk\Facades\AlternativeData\Crypto\Quote;
 87 | 
 88 | $response = Quote::setSymbol('BTCUSDT')->get();
 89 | ```
 90 | 
 91 | **Response**
 92 | 
 93 | ```php
 94 | Collection {#275 ▼
 95 |   #items: array:15 [▼
 96 |     "symbol" => "BTCUSDT"
 97 |     "primaryExchange" => "0"
 98 |     "sector" => "nrcpercyuytrco"
 99 |     "calculationPrice" => "realtime"
100 |     "latestPrice" => "8498.33"
101 |     "latestSource" => "Real time price"
102 |     "latestUpdate" => 1597241012754
103 |     "latestVolume" => null
104 |     "bidPrice" => "8438.55"
105 |     "bidSize" => "0.026231"
106 |     "askPrice" => "8357"
107 |     "askSize" => "0.237439"
108 |     "high" => null
109 |     "low" => null
110 |     "previousClose" => null
111 |   ]
112 | }
113 | ```
114 | 


--------------------------------------------------------------------------------
/src/Stocks/Batch.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Digitonic\IexCloudSdk\Stocks;
  4 | 
  5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
  6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
  7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
  8 | 
  9 | class Batch extends BaseRequest
 10 | {
 11 |     const ENDPOINT = 'stock/{symbol}/batch?';
 12 | 
 13 |     protected $symbol = 'market';
 14 | 
 15 |     /**
 16 |      * @var string
 17 |      */
 18 |     private $symbols;
 19 | 
 20 |     /**
 21 |      * @var string
 22 |      */
 23 |     private $types;
 24 | 
 25 |     /**
 26 |      * @var string
 27 |      */
 28 |     private $range;
 29 | 
 30 |     /**
 31 |      * Create constructor.
 32 |      *
 33 |      * @param  IEXCloud  $api
 34 |      */
 35 |     public function __construct(IEXCloud $api)
 36 |     {
 37 |         parent::__construct($api);
 38 |     }
 39 | 
 40 |     public function setSymbols(...$symbols): self
 41 |     {
 42 |         if (count($symbols) === 1) {
 43 |             $this->symbol = $symbols[0];
 44 |         }
 45 | 
 46 |         $this->symbols = implode(',', $symbols);
 47 | 
 48 |         return $this;
 49 |     }
 50 | 
 51 |     public function setTypes(...$types): self
 52 |     {
 53 |         $this->types = implode(',', $types);
 54 | 
 55 |         return $this;
 56 |     }
 57 | 
 58 |     public function setRange(string $range): self
 59 |     {
 60 |         $this->range = $range;
 61 | 
 62 |         return $this;
 63 |     }
 64 | 
 65 |     /**
 66 |      * @return string
 67 |      */
 68 |     public function getFullEndpoint(): string
 69 |     {
 70 |         $params = [
 71 |             'types' => $this->types,
 72 |         ];
 73 | 
 74 |         if (count(explode(',', $this->symbols)) > 1) {
 75 |             $params['symbols'] = $this->symbols;
 76 |         }
 77 | 
 78 |         if ($this->range) {
 79 |             if (in_array('chart', explode(',', $this->types))) {
 80 |                 $params['range'] = $this->range;
 81 |             }
 82 |         }
 83 | 
 84 |         $query = http_build_query($params);
 85 | 
 86 |         $endpoint = str_replace('{symbol}', $this->symbol, self::ENDPOINT);
 87 |         $endpoint = $endpoint . $query;
 88 | 
 89 |         return $endpoint;
 90 |     }
 91 | 
 92 |     /**
 93 |      * @return bool|void
 94 |      * @throws WrongData
 95 |      */
 96 |     protected function validateParams(): void
 97 |     {
 98 |         if (empty($this->symbols)) {
 99 |             throw WrongData::invalidValuesProvided('Please provide a symbol to query!');
100 |         }
101 | 
102 |         if (empty($this->types)) {
103 |             throw WrongData::invalidValuesProvided(
104 |                 'Types Required: comma delimited list of endpoints to call. ' .
105 |                 'The names should match the individual endpoint names. Limited to 10 endpoints.'
106 |             );
107 |         }
108 |     }
109 | }
110 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | # Changelog
  2 | 
  3 | All notable changes to `iex-cloud-sdk` will be documented in this file
  4 | 
  5 | ## v0.1.1 - 2020-06-24
  6 | 
  7 | ### Added
  8 | 
  9 | ##### Stocks
 10 | 
 11 | - Quote
 12 | 
 13 | ### Changed
 14 | 
 15 | - Docs - Updated docs to include new endpoints
 16 | 
 17 | ## v0.1.0 - 2019-10-15
 18 | 
 19 | ### Added
 20 | 
 21 | ##### Stocks
 22 | 
 23 | - Company
 24 | - News
 25 | - Logo
 26 | - Previous Day Price
 27 | - Price
 28 | - Price Target
 29 | 
 30 | ### Changed
 31 | 
 32 | - Docs - Updated docs to include new endpoints
 33 | 
 34 | ## v0.1.0-beta.10 - 2019-10-08
 35 | 
 36 | ### Added
 37 | 
 38 | - Docs - New documentation section hosted on GitHub pages
 39 | 
 40 | ## v0.1.0-beta.9 - 2019-10-05
 41 | 
 42 | ### Changed
 43 | 
 44 | - Refactored Tests for consistency
 45 | - Use a `get()` method for returning from GET requests
 46 | 
 47 | ## v0.1.0-beta.8 - 2019-10-05
 48 | 
 49 | ### Added
 50 | 
 51 | ##### Stocks
 52 | 
 53 | - Advanced Stats
 54 | - Balance Sheet
 55 | - Batch Requests
 56 | 
 57 | ## v0.1.0-beta.7 - 2019-10-04
 58 | 
 59 | ### Added
 60 | 
 61 | ##### Reference Data
 62 | 
 63 | - International Symbols (Region)
 64 | - International Symbols (Exchange)
 65 | - International Exchanges
 66 | - U.S. Exchanges
 67 | - U.S. Holidays and Trading Days
 68 | - Sectors
 69 | - Tags
 70 | - Mutual Fund Symbols
 71 | - OTC Symbols
 72 | - FX Symbols
 73 | - Options Symbols
 74 | 
 75 | ## v0.1.0-beta.6 - 2019-10-03
 76 | 
 77 | ### Added
 78 | 
 79 | ##### Alternative Data
 80 | 
 81 | - Social Sentiment
 82 | 
 83 | ##### Investors Exchange Data
 84 | 
 85 | - DEEP Operational Halt Status
 86 | - DEEP Official Price
 87 | - DEEP Short Sale Price Test Status
 88 | - DEEP Trade Break
 89 | - DEEP Trading Status
 90 | 
 91 | ##### Reference Data
 92 | 
 93 | - Search
 94 | 
 95 | ## v0.1.0-beta.5 - 2019-10-02
 96 | 
 97 | ### Added
 98 | 
 99 | ##### Alternative Data
100 | 
101 | - Crypto Price
102 | - Crypto Book
103 | - Crypto Symbols
104 | 
105 | ### Changed
106 | 
107 | - Crypto Quote
108 | 
109 | ## v0.1.0-beta.4 - 2019-10-01
110 | 
111 | ### Added
112 | 
113 | ##### Investors Exchange Data
114 | 
115 | - DEEP System Event
116 | - DEEP Trades
117 | - Stats Intraday
118 | - Stats Recent
119 | - Stats Records
120 | 
121 | ## v0.1.0-beta.3 - 2019-10-01
122 | 
123 | ### Added
124 | 
125 | ##### Alternative Data
126 | 
127 | - Crypto
128 | - CEO Compensation
129 | 
130 | ##### Investors Exchange Data
131 | 
132 | - TOPS
133 | - TOPS Last
134 | - DEEP
135 | - DEEP Auction
136 | - DEEP Book
137 | - DEEP Security Event
138 | 
139 | ## v0.1.0-beta.2 - 2019-09-30
140 | 
141 | ### Added
142 | 
143 | ##### Data Apis
144 | 
145 | - Data Points
146 | - Time Series Inventory
147 | - Time Series Query
148 | 
149 | ## v0.1.0-beta.1 - 2019-09-26
150 | 
151 | ### Added
152 | 
153 | ##### Account
154 | 
155 | - Metadata
156 | - Usage
157 | 
158 | ##### API System Metadata
159 | 
160 | - Status
161 | 
162 | ##### Forex / Currencies
163 | 
164 | - Exchange Rates
165 | 
166 | ##### Reference Data
167 | 
168 | - Symbols
169 | - IEX Symbols
170 | 


--------------------------------------------------------------------------------
/docs/dev-status.md:
--------------------------------------------------------------------------------
  1 | # Development Status
  2 | 
  3 | #### Active Development
  4 | 
  5 | Below is a list of endpoints to be implemented. (53/97)
  6 | 
  7 | !> **TODO** Optional query parameters
  8 | 
  9 | ### Account
 10 | 
 11 | - [x] Metadata
 12 | - [x] Usage
 13 | - [ ] Pay as you go toggle
 14 | - [ ] Message Cutoff
 15 | 
 16 | ### Data Apis
 17 | 
 18 | - [x] Data Points
 19 | - [x] Time Series Inventory
 20 | - [x] Time Series Query
 21 | 
 22 | ### Alternative Data
 23 | 
 24 | - [x] Social Sentiment
 25 | - [x] CEO Compensation
 26 | - [x] Crypto Book
 27 | - [ ] ~~Crypto Events~~ (Streaming Only)
 28 | - [x] Crypto Price
 29 | - [x] Crypto Quote
 30 | 
 31 | ### API System Metadata
 32 | 
 33 | - [x] Status
 34 | 
 35 | ### Forex / Currencies
 36 | 
 37 | - [x] Exchange Rates
 38 | 
 39 | ### Investors Exchange Data
 40 | 
 41 | - [x] TOPS
 42 | - [x] TOPS last
 43 | - [x] DEEP
 44 | - [x] DEEP Auction
 45 | - [x] DEEP Book
 46 | - [x] DEEP Operational Halt Status
 47 | - [x] DEEP Official Price
 48 | - [x] DEEP Security Event
 49 | - [x] DEEP Short Sale Price Test Status
 50 | - [x] DEEP System Event
 51 | - [x] DEEP Trades
 52 | - [x] DEEP Trade Break
 53 | - [x] DEEP Trading Status
 54 | - [ ] Listed Regulation SHO Threshold Securities List
 55 | - [ ] Listed Short Interest List
 56 | - [ ] Stats Historical Daily
 57 | - [ ] Stats Historical Summary
 58 | - [x] Stats Intraday
 59 | - [x] Stats Recent
 60 | - [x] Stats Records
 61 | 
 62 | ### Reference Data
 63 | 
 64 | - [x] Symbols
 65 | - [x] Crypto Symbols
 66 | - [x] Search
 67 | - [x] IEX Symbols
 68 | - [x] International Symbols (Region)
 69 | - [x] International Symbols (Exchange)
 70 | - [x] International Exchanges
 71 | - [x] U.S. Exchanges
 72 | - [x] U.S. Holidays and Trading Days
 73 | - [x] Sectors
 74 | - [x] Tags
 75 | - [ ] ISIN Mapping
 76 | - [x] Mutual Fund Symbols
 77 | - [x] OTC Symbols
 78 | - [x] FX Symbols
 79 | - [x] Options Symbols
 80 | 
 81 | ### Stocks
 82 | 
 83 | - [x] Advanced Stats
 84 | - [x] Balance Sheet
 85 | - [x] Batch Requests
 86 | - [ ] Book
 87 | - [ ] Cash Flow
 88 | - [ ] Collections
 89 | - [x] Company
 90 | - [ ] Delayed Quote
 91 | - [ ] Dividends
 92 | - [ ] Earnings
 93 | - [ ] Earnings Today
 94 | - [ ] Estimates
 95 | - [ ] Financials
 96 | - [ ] Fund Ownership
 97 | - [ ] Historical Prices
 98 | - [ ] Income Statement
 99 | - [ ] Insider Roster
100 | - [ ] Insider Summary
101 | - [ ] Insider Transactions
102 | - [ ] Intraday Prices
103 | - [ ] Institutional Ownership
104 | - [ ] IPO Calendar (upcoming)
105 | - [ ] IPO Calendar (today)
106 | - [ ] Key Stats
107 | - [ ] Largest Trades
108 | - [ ] List
109 | - [x] Logo
110 | - [ ] Market Volume
111 | - [x] News
112 | - [ ] OHLC
113 | - [ ] Options (exp dates)
114 | - [ ] Options (data)
115 | - [ ] Peers
116 | - [x] Previous Day Prices
117 | - [x] Price
118 | - [x] Price Target
119 | - [x] Quote
120 | - [ ] Recommendation Trends
121 | - [ ] Sector Performance
122 | - [ ] Splits
123 | - [ ] Upcoming Events (All)
124 | - [ ] Upcoming Events (earnings)
125 | - [ ] Upcoming Events (dividends)
126 | - [ ] Upcoming Events (splits)
127 | - [ ] Upcoming Events (ipos)
128 | - [ ] Volume by Venue
129 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | Contributions are **welcome** and will be fully **credited**.
 4 | 
 5 | Please read and understand the contribution guide before creating an issue or pull request.
 6 | 
 7 | ## Etiquette
 8 | 
 9 | This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10 | held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11 | extremely unfair for them to suffer abuse or anger for their hard work.
12 | 
13 | Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14 | world that developers are civilized and selfless people.
15 | 
16 | It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17 | quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
18 | 
19 | ## Viability
20 | 
21 | When requesting or submitting new features, first consider whether it might be useful to others. Open
22 | source projects are used by many developers, who may have entirely different needs to your own. Think about
23 | whether or not your feature is likely to be used by other users of the project.
24 | 
25 | ## Procedure
26 | 
27 | Before filing an issue:
28 | 
29 | - Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30 | - Check to make sure your feature suggestion isn't already present within the project.
31 | - Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32 | - Check the pull requests tab to ensure that the feature isn't already in progress.
33 | 
34 | Before submitting a pull request:
35 | 
36 | - Check the codebase to ensure that your feature doesn't already exist.
37 | - Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38 | 
39 | ## Requirements
40 | 
41 | If the project maintainer has any additional requirements, you will find them listed here.
42 | 
43 | - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
44 | 
45 | - **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46 | 
47 | - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48 | 
49 | - **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
50 | 
51 | - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52 | 
53 | - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54 | 
55 | **Happy coding**!
56 | 


--------------------------------------------------------------------------------
/src/ReferenceData/USHolTradeDates.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Digitonic\IexCloudSdk\ReferenceData;
  4 | 
  5 | use Digitonic\IexCloudSdk\Contracts\IEXCloud;
  6 | use Digitonic\IexCloudSdk\Exceptions\WrongData;
  7 | use Digitonic\IexCloudSdk\Requests\BaseRequest;
  8 | 
  9 | class USHolTradeDates extends BaseRequest
 10 | {
 11 |     const ENDPOINT = 'ref-data/us/dates/{type}/{direction}/{last}/{startDate}';
 12 | 
 13 |     /**
 14 |      * @var string
 15 |      */
 16 |     protected $direction = 'next';
 17 | 
 18 |     /**
 19 |      * @var string
 20 |      */
 21 |     protected $type = 'trade';
 22 | 
 23 |     /**
 24 |      * @var int
 25 |      */
 26 |     protected $last = 1;
 27 | 
 28 |     /**
 29 |      * @var string
 30 |      */
 31 |     protected $startDate = '';
 32 | 
 33 |     /**
 34 |      * Create constructor.
 35 |      *
 36 |      * @param  IEXCloud  $api
 37 |      */
 38 |     public function __construct(IEXCloud $api)
 39 |     {
 40 |         parent::__construct($api);
 41 |     }
 42 | 
 43 |     /**
 44 |      * @param  string  $type
 45 |      *
 46 |      * @return USHolTradeDates
 47 |      */
 48 |     public function setType(string $type): self
 49 |     {
 50 |         $this->validateInput($type, '/(trade|holiday)/mi', 'Type can be trade or holiday');
 51 | 
 52 |         $this->type = $type;
 53 | 
 54 |         return $this;
 55 |     }
 56 | 
 57 |     /**
 58 |      * @param  string  $direction
 59 |      *
 60 |      * @return USHolTradeDates
 61 |      */
 62 |     public function setDirection(string $direction): self
 63 |     {
 64 |         $this->validateInput($direction, '/(next|last)/mi', 'Direction can be next or last');
 65 | 
 66 |         $this->direction = $direction;
 67 | 
 68 |         return $this;
 69 |     }
 70 | 
 71 |     /**
 72 |      * @param  string  $last
 73 |      *
 74 |      * @return USHolTradeDates
 75 |      */
 76 |     public function setLast(string $last): self
 77 |     {
 78 |         $this->last = (int) $last;
 79 | 
 80 |         return $this;
 81 |     }
 82 | 
 83 |     /**
 84 |      * @param  string  $startDate
 85 |      *
 86 |      * @return USHolTradeDates
 87 |      */
 88 |     public function setStartDate(string $startDate): self
 89 |     {
 90 |         $this->validateInput(
 91 |             $startDate,
 92 |             '/(20\d{2})(\d{2})(\d{2})/mi',
 93 |             'Format date to use YYYYMMDD to fetch sentiment data.'
 94 |         );
 95 | 
 96 |         $this->startDate = $startDate;
 97 | 
 98 |         return $this;
 99 |     }
100 | 
101 |     /**
102 |      * @return string
103 |      */
104 |     protected function getFullEndpoint(): string
105 |     {
106 |         return self::ENDPOINT;
107 |     }
108 | 
109 |     /**
110 |      * @param  string  $input
111 |      * @param  string  $pattern
112 |      * @param  string  $errorMessage
113 |      */
114 |     private function validateInput(string $input, string $pattern, string $errorMessage): void
115 |     {
116 |         preg_match_all($pattern, $input, $matches, PREG_SET_ORDER, 0);
117 | 
118 |         if (empty($matches)) {
119 |             throw WrongData::invalidValuesProvided($errorMessage);
120 |         }
121 |     }
122 | }
123 | 


--------------------------------------------------------------------------------
/GETTING_STARTED.md:
--------------------------------------------------------------------------------
 1 | # Getting Started
 2 | 
 3 | ```php
 4 | $baseUrl = 'https://cloud.iexapis.com/v1/';
 5 | $secretKey = 'xFiXd5RnPhUD8Qz1Q2esNVIFfqmrqgB';
 6 | ```
 7 | 
 8 | ```php
 9 | // Instantiate a new Guzzle client
10 | $guzzle = new Client([
11 |     'base_uri' => $baseUrl,
12 |     'headers' => [
13 |         'Accept' => 'application/json',
14 |         'Content-Type' => 'application/json'
15 |     ],
16 |     'query' => ['token' => $secretKey]
17 | ]);
18 | ```
19 | 
20 | ```php
21 | // Instantiate a new IEX API client with the Guzzle dependency.
22 | $iexApi = new \Digitonic\IexCloudSdk\Client($guzzle);
23 | ```
24 | 
25 | The IEX API client can now be used as a dependency for communicating with various endpoints. for example, to call the `account/metadata` endpoint - 
26 | 
27 | ```php
28 | $metadata = new \Digitonic\IexCloudSdk\Account\Metadata($iexApi);
29 | $response = $metadata->get();
30 | 
31 | print_r($response);
32 | ```
33 | 
34 | All endpoints that return data will return data as a `\Illuminate\Support\Collection`. This will provide various utility methods when searching the response. For more information on Laravel Collections see [https://laravel.com/docs/6.x/collections](https://laravel.com/docs/6.x/collections). Please note, this package does not require the full Laravel framework to be used.
35 | 
36 | ```php
37 | Collection {#275 ▼
38 |   #items: array:7 [▼
39 |     "payAsYouGoEnabled" => false
40 |     "effectiveDate" => 1621337109805
41 |     "subscriptionTermType" => "mnlhyto"
42 |     "tierName" => "tstar"
43 |     "messageLimit" => 514440
44 |     "messagesUsed" => 13578
45 |     "circuitBreaker" => null
46 |   ]
47 | }
48 | ```
49 | 
50 | ### Laravel >5.8 Usage
51 | 
52 | The package will auto register the service provider and all Facades.
53 | 
54 | You can publish the config file of this package with this command:
55 | 
56 | ``` bash
57 | php artisan vendor:publish --provider="Digitonic\IexCloudSdk\IexCloudSdkServiceProvider"
58 | ```
59 | 
60 | The following [config](config/config.php) file will be published in `config/iex-cloud-sdk.php`
61 | 
62 | Once you have installed the package, configure your `.env` with the following keys setting the correct values for your account.
63 | 
64 | ```bash
65 | IEX_CLOUD_SANDBOX=true
66 | IEX_CLOUD_SECRET_KEY=Tsk_1234567899876543211236547896541c
67 | IEX_CLOUD_PUBLIC_KEY=Tpk_1234567899876543211236547896541c
68 | ```
69 | 
70 | #### IoC container
71 | 
72 | The IoC container will automatically resolve the `IEX API` dependencies for you when calling any endpoint. Which means you can just type hint your endpoint to retrieve the object from the container with all configurations in place.
73 | 
74 | ```php
75 | // From a constructor
76 | class FooClass {
77 |     public function __construct(Digitonic\IexCloudSdk\Account\Metadata $metadata) {
78 |        $response = $metadata->get();
79 |     }
80 | }
81 | 
82 | // From a method
83 | class BarClass {
84 |     public function barMethod(Digitonic\IexCloudSdk\Account\Metadata $metadata) {
85 |        $response = $metadata->get();
86 |     }
87 | }
88 | ```
89 | 
90 | Alternatively you may use the facades directly which provides a much faster and fluent interface.
91 | 
92 | ```php
93 | $response = Digitonic\IexCloudSdk\Facades\Account\Metadata::get();
94 | ```
95 | 


--------------------------------------------------------------------------------
/docs/quickstart.md:
--------------------------------------------------------------------------------
  1 | # Quick Start
  2 | 
  3 | Although the SDK can be used in a standalone application with composer, it works best when it is included with a Laravel application.
  4 | 
  5 | ## Installation
  6 | 
  7 | You can install the package via composer:
  8 | 
  9 | ```bash
 10 | composer require digitonic/iex-cloud-sdk
 11 | ```
 12 | 
 13 | ## Basic Usage 
 14 | 
 15 | Obtain your secret and public keys from the IEX Console. The base URL can be swapped out for the sandbox URL and paired with sandbox keys will allow your to work in development mode.
 16 | ```php
 17 | $baseUrl = 'https://cloud.iexapis.com/v1/';
 18 | $secretKey = 'sFiXd5RnPhUD8Qz1Q2esNVIFfqmrqgB';
 19 | $publicKey = 'pFiXd5RnPhUD8Qz1Q2esNVIFfqmrqgB';
 20 | ```
 21 | 
 22 | The SDK uses Guzzle as dependency for interacting with the HTTP layer. You should instantiate a new Guzzle client with your `$baseUrl` and `$secretKey` as shown below.
 23 | 
 24 | ```php
 25 | $guzzle = new Client([
 26 |     'base_uri' => $baseUrl,
 27 |     'headers' => [
 28 |         'Accept' => 'application/json',
 29 |         'Content-Type' => 'application/json'
 30 |     ],
 31 |     'query' => ['token' => $secretKey]
 32 | ]);
 33 | ```
 34 | 
 35 | You can now use the Guzzle client as a dependency for the IEX SDK client. The IEX Client is nothing more than a simple configuration wrapper for the Guzzle client that exposes one method `send()`, this `send` method is public which means you are free to override this or call it directly should you wish. The send method will be used for all endpoints exposed in the SDK and will catch and display any and all data related errors. 
 36 | 
 37 | ```php
 38 | $client = new \Digitonic\IexCloudSdk\Client($guzzle);
 39 | ```
 40 | 
 41 | The IEX API client can now be used as a dependency for communicating with various endpoints. for example, to call the `account/metadata` endpoint - 
 42 | 
 43 | ```php
 44 | use \Digitonic\IexCloudSdk\Account\Metadata;
 45 | 
 46 | $metadata = new Metadata($client);
 47 | $response = $metadata->get();
 48 | 
 49 | print_r($response);
 50 | ```
 51 | 
 52 | All endpoints that return data will return data as a `\Illuminate\Support\Collection`. This will provide various utility methods when searching the response. For more information on Laravel Collections see [https://laravel.com/docs/6.x/collections](https://laravel.com/docs/6.x/collections).
 53 | 
 54 | ```php
 55 | Collection {#275 ▼
 56 |   #items: array:7 [▼
 57 |     "payAsYouGoEnabled" => false
 58 |     "effectiveDate" => 1621337109805
 59 |     "subscriptionTermType" => "mnlhyto"
 60 |     "tierName" => "tstar"
 61 |     "messageLimit" => 514440
 62 |     "messagesUsed" => 13578
 63 |     "circuitBreaker" => null
 64 |   ]
 65 | }
 66 | ```
 67 | 
 68 | ## Laravel Usage
 69 | 
 70 | The SDK comes with a Laravel Service Provider to facilitate a much cleaner and streamlined setup. The SDK will only work with Laravel 5.8 and above and as such the package will automatically register the provider and the facades.
 71 | 
 72 | You can publish the config file of this package with this command:
 73 | 
 74 | ``` bash
 75 | php artisan vendor:publish --provider="Digitonic\IexCloudSdk\IexCloudSdkServiceProvider"
 76 | ```
 77 | 
 78 | The following [config](config/config.php) file will be published in `config/iex-cloud-sdk.php`
 79 | 
 80 | Once you have installed the package, configure your `.env` with the following keys setting the correct values for your account.
 81 | 
 82 | ```bash
 83 | IEX_CLOUD_SANDBOX=true
 84 | IEX_CLOUD_SECRET_KEY=Tsk_1234567899876543211236547896541c
 85 | IEX_CLOUD_PUBLIC_KEY=Tpk_1234567899876543211236547896541c
 86 | ```
 87 | 
 88 | #### IoC container
 89 | 
 90 | The IoC container will automatically resolve the `IEX API Client` dependencies for you when calling any endpoint. Which means you can just type hint your endpoint to retrieve the object from the container with all configurations in place.
 91 | 
 92 | ```php
 93 | use \Digitonic\IexCloudSdk\Account\Metadata;
 94 | 
 95 | // From a constructor
 96 | class FooClass {
 97 |     public function __construct(Metadata $metadata) {
 98 |        $response = $metadata->get();
 99 |     }
100 | }
101 | 
102 | // From a method
103 | class BarClass {
104 |     public function barMethod(Metadata $metadata) {
105 |        $response = $metadata->get();
106 |     }
107 | }
108 | ```
109 | 
110 | Alternatively you may use the facades directly which provides a much faster and fluent interface.
111 | 
112 | ```php
113 | use \Digitonic\IexCloudSdk\Facades\Account\Metadata;
114 | 
115 | $response = Metadata::get();
116 | ```
117 | 
118 | Some endpoints require extra parameters being passed to the endpoint object. Please see each endpoint documentation for requirements and example usage.
119 | 


--------------------------------------------------------------------------------
/docs/data-apis.md:
--------------------------------------------------------------------------------
  1 | # Data APIs
  2 | 
  3 | ## Data Points
  4 | 
  5 | Data points are available per symbol and return individual plain text values. Retrieving individual data points is useful for Excel and Google Sheet users, and applications where a single, lightweight value is needed.
  6 | 
  7 | To use this endpoint, you’ll first make a free call to list all available data points for your desired symbol, which can be a security or data category.
  8 | 
  9 | **Example**
 10 | 
 11 | ```php
 12 | use \Digitonic\IexCloudSdk\DataApis\DataPoints;
 13 | 
 14 | $endpoint = new DataPoints($client);
 15 | $response = $endpoint->setSymbol('aapl')->get();
 16 | 
 17 | // Laravel
 18 | use \Digitonic\IexCloudSdk\Facades\DataApis\DataPoints;
 19 | 
 20 | $response = DataPoints::setSymbol('aapl')->get();
 21 | ```
 22 | 
 23 | **Response**
 24 | 
 25 | ```php
 26 | Collection {#397 ▼
 27 |   #items: array:126 [▼
 28 |     0 => {#277 ▼
 29 |       +"key": "NEXTDIVIDENDDATE"
 30 |       +"weight": 1
 31 |       +"description": ""
 32 |       +"lastUpdated": "2019-08-09T08:50:31+00:00"
 33 |     }
 34 |     1 => {#275 ▶}
 35 |     2 => {#278 ▶}
 36 |     3 => {#272 ▶}
 37 |     4 => {#267 ▶}
 38 |     5 => {#265 ▶}
 39 | ...
 40 | ```
 41 | Once you find the data point you want, use the key to fetch the individual data point.
 42 | 
 43 | **Example**
 44 | 
 45 | ```php
 46 | use \Digitonic\IexCloudSdk\DataApis\DataPoints;
 47 | 
 48 | $endpoint = new DataPoints($client);
 49 | $response = $endpoint->setSymbol('aapl')
 50 |                  ->setKey('NEXTDIVIDENDDATE')
 51 |                  ->get();
 52 | 
 53 | // Laravel
 54 | use \Digitonic\IexCloudSdk\Facades\DataApis\DataPoints;
 55 | 
 56 | $response = DataPoints::setSymbol('aapl')
 57 |                 ->setKey('NEXTDIVIDENDDATE')
 58 |                 ->get();
 59 | ```
 60 | 
 61 | **Response**
 62 | 
 63 | ```php
 64 | Collection {#277 ▼
 65 |   #items: array:1 [▼
 66 |     0 => "2019-08-20"
 67 |   ]
 68 | }
 69 | ```
 70 | 
 71 | ## Time Series Inventory
 72 | 
 73 | Time series is the most common type of data available, and consists of a collection of data points over a period of time. Time series data is indexed by a single date field, and can be retrieved by any portion of time.
 74 | 
 75 | To use this endpoint, you’ll first make a free call to get an inventory of available time series data.
 76 | 
 77 | **Example**
 78 | 
 79 | ```php
 80 | use \Digitonic\IexCloudSdk\DataApis\TimeSeries\Inventory;
 81 | 
 82 | $endpoint = new Inventory($client);
 83 | $response = $endpoint->get();
 84 | 
 85 | // Laravel
 86 | use \Digitonic\IexCloudSdk\Facades\DataApis\TimeSeries\Inventory;
 87 | 
 88 | $response = Inventory::get();
 89 | ```
 90 | 
 91 | **Response**
 92 | 
 93 | ```php
 94 | Collection {#281 ▼
 95 |   #items: array:1 [▼
 96 |     0 => {#277 ▼
 97 |       +"id": "ERAATLIF_OSPRNDCNIE"
 98 |       +"description": "edas tfaRpieonlcnri"
 99 |       +"schema": {#275 ▼
100 |         +"type": "object"
101 |         +"properties": {#272 ▼
102 |           +"formFiscalYear": {#278 ▼
103 |             +"type": "number"
104 |           }
105 |           +"formFiscalQuarter": {#267 ▼
106 |             +"type": "number"
107 |           }
108 |           +"version": {#265 ▼
109 |             +"type": "string"
110 |           }
111 |           +"periodStart": {#276 ▼
112 |             +"type": "string"
113 |           }
114 |           +"periodEnd": {#269 ▼
115 |             +"type": "string"
116 |           }
117 |           +"dateFiled": {#279 ▼
118 |             +"type": "string"
119 |           }
120 |           +"reportLink": {#280 ▼
121 |             +"type": "string"
122 |           }
123 |         }
124 |         +"required": []
125 |         +"additionalProperties": true
126 |       }
127 |       +"weight": 5080
128 |       +"created": "32240- 001-:13604:9"
129 |       +"lastUpdated": "12400- :00-6349:213"
130 |     }
131 |   ]
132 | }
133 | ```
134 | A full inventory of time series data is returned by calling /time-series without a data id. The data structure returned is an array of available data sets that includes the data set id, a description of the data set, the data weight, a data schema, date created, and last updated date. The schema defines the minimum data properties for the data set, but note that additional properties can be returned. This is possible when data varies between keys of a given data set.
135 | 
136 | Each inventory entry may include a key and subkey which describes what can be used for the key or subkey parameter.
137 | 
138 | ## Time Series Query
139 | 
140 | Once you find the data set you want, use the id to query the time series data.
141 | 
142 | Time series data is queried by a required data set id. For example, “REPORTED_FINANCIALS”. Some time series data sets are broken down further by a data set key. This may commonly be a symbol. For example, REPORTED_FINANCIALS accepts a symbol such as “AAPL” as a key. Data sets can be even further broken down by sub key. For example, REPORTED_FINANCIALS data set with the key “AAPL” can have a sub key of “10-Q” or “10-K”.
143 | 
144 | Keys and sub keys will be defined in the data set inventory.
145 | 
146 | **Example**
147 | 
148 | ```php
149 | use \Digitonic\IexCloudSdk\DataApis\TimeSeries\Query;
150 | 
151 | $endpoint = new Inventory($client);
152 | $response = $endpoint->get();
153 | 
154 | // Laravel
155 | use \Digitonic\IexCloudSdk\Facades\DataApis\TimeSeries\Query;
156 | 
157 | $response = Query::setId('REPORTED_FINANCIALS')
158 |                 ->setKey('AAPL')
159 |                 ->setSubKey('10-Q')
160 |                 ->get();
161 | ```
162 | 
163 | !> Query String Parameters still to be implemented
164 | 
165 | **Response**
166 | 
167 | ```php
168 | Collection {#301 ▼
169 |   #items: array:30 [▼
170 |     0 => {#277 ▼
171 |       +"id": "EECINTS_RALDFOAIRPN"
172 |       +"source": "SEC"
173 |       +"key": "ALPA"
174 |       +"subkey": "01Q-"
175 |       +"updated": 1609211733
176 |       +"AccountsPayable": 4921590385
177 |       +"formFiscalYear": 2087
178 |       +"version": "sgaa-up"
179 |       +"periodStart": 1273268848459
180 |       +"periodEnd": 1272111501454
181 |       +"dateFiled": 1304048033673
182 |       +"formFiscalQuarter": 3
183 |       +"reportLink": "0001w/vecA03da5ws53ss/pv9e3hgri/tw/315/0ec1/.1r.d090h:2a91tg0/261t0/oa"
184 |       +"AccountsReceivableNetCurrent": 2738746127
185 |       +"AccruedLiabilities": 3481227682
186 |       +"AccumulatedOtherComprehensiveIncomeLossNetOfTax": 53392828
187 |       +"AllowanceForDoubtfulAccountsReceivableCurrent": 58043568
188 |       +"Assets": 49200608778
189 |       +"AssetsCurrent": 36411768693
190 |       +"AvailableForSaleSecuritiesCurrent": 18846832822
191 |       +"AvailableForSaleSecuritiesNoncurrent": 7134630236
192 |       +"CashAndCashEquivalentsAtCarryingValue": 5805755013
193 |       +"CashAndCashEquivalentsPeriodIncreaseDecrease": -6433032533
194 |       +"CommitmentsAndContingencies": 0
195 |       +"CommonStockNoParValue": 0
196 |       +"CommonStockSharesAuthorized": 1818958014
197 |       +"CommonStockSharesIssued": 896700592
198 |       +"CommonStockSharesOutstanding": 916218997
199 |       +"CommonStockValue": 8073436587
200 |       +"CostOfGoodsAndServicesSold": 17467639130
201 |       +"DeferredIncomeTaxExpenseBenefit": -202044184
202 |       +"DeferredRevenueCurrent": 8651845268
203 |       +"DeferredRevenueNoncurrent": 3719260915
204 |       +"DeferredTaxAssetsNetCurrent": 1736495003
205 |       +"DepreciationAmortizationAndAccretionNet": 530942016
206 |       +"EarningsPerShareBasic": 4.66
207 |       +"EarningsPerShareDiluted": 4.58
208 |       +"EmployeeServiceShareBasedCompensationCashFlowEffectCashUsedToSettleAwards": -71310080
209 |       +"EntityCommonStockSharesOutstanding": 918060910
210 |       +"EntityPublicFloat": 95831542710
211 |       +"ExcessTaxBenefitFromShareBasedCompensationFinancingActivities": 128369811
212 |       +"GainLossOnSaleOfPropertyPlantEquipment": -18362101
213 |       +"Goodwill": 217003955
214 |       +"GrossProfit": 3132775287
215 |       +"IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments": 5906177733
216 |       +"IncomeTaxesPaidNet": 2537284672
217 |       +"IncomeTaxExpenseBenefit": 1765366397
218 |       +"IncreaseDecreaseInAccountsPayable": -662362318
219 |       +"IncreaseDecreaseInAccountsReceivable": 274659341
220 |       +"IncreaseDecreaseInDeferredRevenue": 4279857195
221 |       +"IncreaseDecreaseInInventories": -132276691
222 |       +"IncreaseDecreaseInOtherOperatingAssets": 821126708
223 |       +"IncreaseDecreaseInOtherOperatingLiabilities": -208539076
224 |       +"IncreaseDecreaseOtherCurrentAssets": 301712345
225 |       +"IntangibleAssetsNetExcludingGoodwill": 271072839
226 |       +"InventoryNet": 380357258
227 |       +"Liabilities": 23222565863
228 |       +"LiabilitiesAndStockholdersEquity": 48356475067
229 |       +"LiabilitiesCurrent": 17143774626
230 |       +"NetCashProvidedByUsedInFinancingActivities": 360762189
231 |       +"NetCashProvidedByUsedInInvestingActivities": -13755834742
232 |       +"NetCashProvidedByUsedInOperatingActivities": 7319639761
233 |       +"NetIncomeLoss": 1254413101
234 |       +"NonoperatingIncomeExpense": 286707314
235 |       +"OperatingExpenses": 1364587805
236 |       +"OperatingIncomeLoss": 5654982022
237 |       +"OtherAssetsCurrent": 6199701923
238 |       +"OtherAssetsNoncurrent": 3052719603
239 |       +"OtherLiabilitiesNoncurrent": 1974929483
240 |       +"PaymentsForProceedsFromOtherInvestingActivities": 63505109
241 |       +"PaymentsToAcquireAvailableForSaleSecurities": 35742646912
242 |       +"PaymentsToAcquireIntangibleAssets": 56884699
243 |       +"PaymentsToAcquireOtherInvestments": 62223140
244 |       +"PaymentsToAcquireProductiveAssets": 713483118
245 |       +"ProceedsFromIssuanceOfCommonStock": 299593198
246 |       +"ProceedsFromMaturitiesPrepaymentsAndCallsOfAvailableForSaleSecurities": 12840799027
247 |       +"ProceedsFromSaleOfAvailableForSaleSecurities": 9217869605
248 |       +"PropertyPlantAndEquipmentAndCapitalizedSoftwareNet": 2766515102
249 |       +"ResearchAndDevelopmentExpense": 346967174
250 |       +"RetainedEarningsAccumulatedDeficit": 18471282567
251 |       +"SalesRevenueNet": 8423777984
252 |       +"SellingGeneralAndAdministrativeExpense": 1051686313
253 |       +"ShareBasedCompensation": 554779236
254 |       +"StockholdersEquity": 26621258478
255 |       +"WeightedAverageNumberOfDilutedSharesOutstanding": 942565128
256 |       +"WeightedAverageNumberOfSharesOutstandingBasic": 922346050
257 |     }
258 |     1 => {#275 ▶}
259 |     2 => {#278 ▶}
260 |     3 => {#272 ▶}
261 |     4 => {#267 ▶}
262 |     5 => {#265 ▶}
263 |     6 => {#276 ▶}
264 |     7 => {#269 ▶}
265 |     8 => {#279 ▶}
266 |     9 => {#280 ▶}
267 |     10 => {#281 ▶}
268 |     11 => {#282 ▶}
269 |     12 => {#283 ▶}
270 |     13 => {#284 ▶}
271 |     14 => {#285 ▶}
272 |     15 => {#286 ▶}
273 |     16 => {#287 ▶}
274 |     17 => {#288 ▶}
275 |     18 => {#289 ▶}
276 |     19 => {#290 …99}
277 |     20 => {#291 …114}
278 |     21 => {#292 …151}
279 |     22 => {#293 …127}
280 |     23 => {#294 …103}
281 |     24 => {#295 …104}
282 |     25 => {#296 …125}
283 |     26 => {#297 …137}
284 |     27 => {#298 …154}
285 |     28 => {#299 …149}
286 |     29 => {#300 …102}
287 |   ]
288 | }
289 | ```
290 | 
291 | Read more at [IEX API Docs](https://iexcloud.io/docs/api/#time-series)
292 | 


--------------------------------------------------------------------------------
/docs/_media/logo-color.svg:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!-- Generator: Adobe Illustrator 23.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
  3 | <svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
  4 | 	 viewBox="0 0 585.3 119.5" style="enable-background:new 0 0 585.3 119.5;" xml:space="preserve">
  5 | <style type="text/css">
  6 | 	.st0{fill:none;stroke:#F4F5F6;stroke-width:4;stroke-linecap:round;stroke-miterlimit:10;}
  7 | 	.st1{fill-rule:evenodd;clip-rule:evenodd;}
  8 | 	.st2{fill:none;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
  9 | 	.st3{fill:none;}
 10 | 	.st4{fill:#010101;}
 11 | 	.st5{fill:none;stroke:#000000;stroke-width:0.5;stroke-miterlimit:10;}
 12 | 	.st6{fill:#70CADB;}
 13 | 	.st7{fill:#E01765;}
 14 | 	.st8{fill:#E8A723;}
 15 | 	.st9{fill:#3EB890;}
 16 | 	.st10{fill:#CC2027;}
 17 | 	.st11{fill:#361238;}
 18 | 	.st12{fill:#65863A;}
 19 | 	.st13{fill:#1A937D;}
 20 | 	.st14{fill:#F5F7F6;}
 21 | 	.st15{fill:#FFEBDB;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 22 | 	.st16{fill:#F5F7F6;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 23 | 	.st17{fill:#FFFFFF;}
 24 | 	.st18{fill:url(#SVGID_1_);}
 25 | 	.st19{fill:url(#SVGID_2_);}
 26 | 	.st20{fill:url(#SVGID_3_);}
 27 | 	.st21{fill:url(#SVGID_4_);}
 28 | 	.st22{fill:url(#SVGID_5_);}
 29 | 	.st23{fill:url(#SVGID_6_);}
 30 | 	.st24{fill:url(#SVGID_7_);}
 31 | 	.st25{fill:#EF0073;}
 32 | 	.st26{fill:none;stroke:#000000;stroke-miterlimit:10;}
 33 | 	.st27{fill:url(#SVGID_8_);}
 34 | 	.st28{fill:url(#SVGID_9_);}
 35 | 	.st29{fill:url(#SVGID_10_);}
 36 | 	.st30{fill:url(#SVGID_11_);}
 37 | 	.st31{fill:url(#SVGID_12_);}
 38 | 	.st32{fill:url(#SVGID_13_);}
 39 | 	.st33{fill:url(#SVGID_14_);}
 40 | 	.st34{fill:url(#SVGID_15_);}
 41 | 	.st35{fill:url(#SVGID_16_);}
 42 | 	.st36{fill:url(#SVGID_17_);}
 43 | 	.st37{fill:#FFFFFF;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 44 | 	.st38{fill:none;stroke:#EF0073;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 45 | 	.st39{fill:#E3F6FF;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 46 | 	.st40{fill:#FFC7C0;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 47 | 	.st41{fill:#C6E5D8;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 48 | 	.st42{fill:url(#SVGID_18_);stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 49 | 	.st43{fill:#FFF792;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 50 | 	.st44{fill:#F3E8FF;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 51 | 	.st45{fill:none;stroke:#1EF78F;stroke-width:4;stroke-miterlimit:10;}
 52 | 	.st46{fill:none;stroke:#1B8DED;stroke-width:4;stroke-miterlimit:10;}
 53 | 	.st47{fill:none;stroke:#FFE158;stroke-width:4;stroke-miterlimit:10;}
 54 | 	.st48{fill:#F9EE26;}
 55 | 	.st49{fill:#0077F9;}
 56 | 	.st50{fill:#6805D1;}
 57 | 	.st51{fill:#0AEA7A;}
 58 | 	.st52{fill:none;stroke:#CCCCCC;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 59 | 	.st53{fill:none;stroke:#26CEBF;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 60 | 	.st54{fill:none;stroke:#734CF2;stroke-width:3;stroke-miterlimit:10;}
 61 | 	.st55{fill:none;stroke:#514B4C;stroke-width:0.5;stroke-miterlimit:10;}
 62 | 	.st56{fill:#514B4C;}
 63 | 	.st57{fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 64 | 	.st58{fill:#FFFFFF;stroke:#514B4C;stroke-width:0.5;stroke-miterlimit:10;}
 65 | 	.st59{fill:none;stroke:#142130;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 66 | 	.st60{fill:none;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:2,4;}
 67 | 	.st61{fill:#C73A63;}
 68 | 	.st62{fill:#4B4B4B;}
 69 | 	.st63{fill:#443642;}
 70 | 	.st64{fill:url(#SVGID_19_);}
 71 | 	.st65{fill:url(#SVGID_20_);}
 72 | 	.st66{fill:#EAEAEA;}
 73 | 	.st67{fill:#D54C3F;}
 74 | 	.st68{fill:#B63524;}
 75 | 	.st69{fill:#DE5145;}
 76 | 	.st70{fill:#EFEFEF;}
 77 | 	.st71{fill:#C64132;}
 78 | 	.st72{fill:#E3E3E3;}
 79 | 	.st73{fill:url(#SVGID_21_);}
 80 | 	.st74{fill:url(#SVGID_22_);}
 81 | 	.st75{fill:none;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:0,4;}
 82 | 	.st76{fill:#FFFFFF;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
 83 | 	.st77{fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;}
 84 | 	.st78{fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0,3.7862;}
 85 | 	.st79{fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0,3.8576;}
 86 | 	.st80{fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0,3.8881;}
 87 | 	.st81{fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0,3.8182;}
 88 | 	.st82{fill:none;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;}
 89 | 	.st83{fill:none;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0,3.9966;}
 90 | 	.st84{fill:none;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0,4.0481;}
 91 | 	.st85{fill:none;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0,3.9564;}
 92 | 	.st86{fill:url(#SVGID_23_);}
 93 | 	.st87{fill:url(#SVGID_24_);}
 94 | 	.st88{fill:#DCDDE1;}
 95 | 	.st89{fill:none;stroke:#142130;stroke-width:0.6;stroke-miterlimit:10;}
 96 | 	.st90{fill:url(#SVGID_25_);}
 97 | 	.st91{fill:url(#SVGID_26_);}
 98 | 	.st92{fill:url(#SVGID_27_);}
 99 | 	.st93{fill:url(#SVGID_28_);}
100 | 	
101 | 		.st94{fill:none;stroke:#142130;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:3,4;}
102 | 	.st95{fill:#FFFFFF;stroke:#142130;stroke-width:0.6;stroke-miterlimit:10;}
103 | 	.st96{fill:url(#SVGID_29_);}
104 | 	.st97{fill:url(#SVGID_30_);}
105 | 	.st98{fill:url(#SVGID_31_);}
106 | 	.st99{fill:url(#SVGID_32_);}
107 | 	.st100{fill:none;stroke:#142130;stroke-width:0.5;stroke-miterlimit:10;}
108 | 	.st101{fill:none;stroke:#000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:0,6;}
109 | 	.st102{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;}
110 | 	.st103{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0.9712,1.9424;}
111 | 	.st104{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0.9089,1.8179;}
112 | 	.st105{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.0251,2.0502;}
113 | 	.st106{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.0214,2.0429;}
114 | 	.st107{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.0613,2.1227;}
115 | 	.st108{fill:#FFFFFF;stroke:#142130;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
116 | 	.st109{fill:none;stroke:#DCDDE1;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
117 | 	.st110{fill:none;stroke:#26CEBF;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
118 | 	.st111{fill:none;stroke:#142130;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;}
119 | 	.st112{fill:none;stroke:#142130;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.9949,3.9897;}
120 | 	.st113{fill:none;stroke:#142130;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:2.029,4.058;}
121 | 	.st114{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
122 | 	.st115{fill:#BBBCBE;}
123 | 	.st116{fill:#142130;}
124 | 	
125 | 		.st117{fill:none;stroke:#142130;stroke-width:0.6;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;stroke-dasharray:1,2;}
126 | 	.st118{fill:none;stroke:#DCDDE1;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
127 | 	.st119{fill:none;stroke:#26CEBF;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
128 | 	.st120{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.9263,3.8527;}
129 | 	.st121{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:2.0057,4.0114;}
130 | 	.st122{fill:#FFFFFF;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
131 | 	.st123{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:0.5;}
132 | 	.st124{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.0506,2.1011;}
133 | 	.st125{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.0414,2.0829;}
134 | 	.st126{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.05,2.0999;}
135 | 	.st127{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.0319,2.0638;}
136 | 	.st128{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.0572,2.1143;}
137 | 	.st129{fill:#00D50F;}
138 | 	.st130{fill:url(#SVGID_33_);}
139 | 	.st131{fill:url(#SVGID_34_);}
140 | 	.st132{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.0014,2.0029;}
141 | 	.st133{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1.023,2.046;}
142 | 	.st134{fill:none;stroke:#142130;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:1,2;}
143 | </style>
144 | <g id="Layer_2">
145 | </g>
146 | <g id="Layer_1">
147 | </g>
148 | <g id="Layer_3">
149 | 	<g>
150 | 		<path class="st3" d="M96.2,23.2c-15.1,0-28.6,9.4-34,23.4c10.6,7.2,17.5,19.3,17.5,33c0,5.9-1.3,11.5-3.7,16.6h20.2
151 | 			c20.1,0,36.5-16.4,36.5-36.5C132.7,39.6,116.3,23.2,96.2,23.2z"/>
152 | 		<path class="st3" d="M456.9,52.1c-9.8,0-15.9,7.3-15.9,18.4v0.7c0,11.1,6.1,18.3,15.9,18.3c9.8,0,15.9-7.4,15.9-18.3v-0.7
153 | 			C472.8,59.4,466.6,52.1,456.9,52.1z"/>
154 | 		<path class="st3" d="M562.4,52.1c-9.7,0-15.5,6.8-15.5,18.6v0.7c0,12.3,6.6,18.2,14.8,18.2c9,0,16.1-6,16.1-18.4v-0.7
155 | 			C577.9,58,571.9,52.1,562.4,52.1z"/>
156 | 		<path class="st25" d="M96.2,0C70.2,0,48,16.6,39.8,39.8l0,0C17.8,39.8,0,57.7,0,79.7c0,22,17.8,39.8,39.8,39.8h56.3
157 | 			c33,0,59.7-26.7,59.7-59.7C155.9,26.7,129.2,0,96.2,0z M96.2,96.3H76c2.3-5.1,3.7-10.7,3.7-16.6c0-13.7-6.9-25.8-17.5-33
158 | 			c5.4-14,18.9-23.4,34-23.4c20.1,0,36.5,16.4,36.5,36.5C132.7,79.9,116.3,96.3,96.2,96.3z"/>
159 | 		<rect x="191.3" y="28.6" class="st25" width="15.2" height="66.6"/>
160 | 		<polygon class="st25" points="233.4,66.9 256.2,66.9 256.2,55.9 233.4,55.9 233.4,40.4 261.9,40.4 261.9,28.6 218.5,28.6 
161 | 			218.5,95.2 263.3,95.2 263.3,83.5 233.4,83.5 		"/>
162 | 		<polygon class="st25" points="326,28.6 310.6,28.6 298,50.8 285.3,28.6 268.3,28.6 287.8,61 266.7,95.2 282.2,95.2 296.5,70.5 
163 | 			310.9,95.2 328.1,95.2 307,60.6 		"/>
164 | 		<path class="st25" d="M378.9,89.5c-14.3,0-22.9-10.2-22.9-27.2v-0.7c0-16.8,9.2-27.5,23-27.5c11.4,0,17.2,5.2,18.9,15.4h8
165 | 			c-1.4-14.4-13.1-21.8-27-21.8c-18.1,0-31.3,14.3-31.3,34v0.7c0,20.5,11.8,33.7,31.1,33.7c14.9,0,25.5-7.5,27.8-22.9h-7.5
166 | 			C397.4,84,389.8,89.5,378.9,89.5z"/>
167 | 		<rect x="415.7" y="23.2" class="st25" width="7.8" height="72"/>
168 | 		<path class="st25" d="M456.9,45.7c-13.8,0-23.9,10.2-23.9,24.9v0.7c0,14.2,10,24.8,23.8,24.8c13.9,0,24-10.2,24-24.9v-0.7
169 | 			C480.8,55.8,470.7,45.7,456.9,45.7z M472.8,71.3c0,11-6.1,18.3-15.9,18.3c-9.9,0-15.9-7.3-15.9-18.3v-0.7
170 | 			c0-11.2,6.1-18.4,15.9-18.4c9.7,0,15.9,7.3,15.9,18.5V71.3z"/>
171 | 		<path class="st25" d="M522,76c0,8.8-6.5,13.3-13.4,13.3c-7.6,0-11.3-3.8-11.3-12.4V46.5h-7.7v30.8c0,13.4,7.3,18.7,17,18.7
172 | 			c7.8,0,13.2-4,15.5-8.6v7.7h7.7V46.5H522V76z"/>
173 | 		<path class="st25" d="M577.6,23.2v31.1c-2.8-4.7-7.8-8.7-15.9-8.7c-13.4,0-22.7,10.5-22.7,25.4v0.7c0,15.2,9.2,24.2,22,24.2
174 | 			c7.1,0,13.9-4.5,16.7-9.2v8.4h7.7v-72H577.6z M577.9,71.2c0,12.5-7.1,18.4-16.1,18.4c-8.2,0-14.8-5.9-14.8-18.2v-0.7
175 | 			c0-11.8,5.8-18.6,15.5-18.6c9.5,0,15.5,5.9,15.5,18.4V71.2z"/>
176 | 	</g>
177 | </g>
178 | </svg>
179 | 


--------------------------------------------------------------------------------
/docs/stocks.md:
--------------------------------------------------------------------------------
  1 | # Stocks
  2 | 
  3 | ## Advanced Stats
  4 | 
  5 | **Example**
  6 | 
  7 | ```php
  8 | use \Digitonic\IexCloudSdk\Stocks\AdvancedStats;
  9 | 
 10 | $endpoint = new AdvancedStats($client);
 11 | $response = $endpoint->setSymbol('aapl')->get();
 12 | 
 13 | // Laravel
 14 | use \Digitonic\IexCloudSdk\Facades\Stocks\AdvancedStats;
 15 | 
 16 | $response = AdvancedStats::setSymbol('aapl')->get();
 17 | ```
 18 | 
 19 | **Response**
 20 | 
 21 | ```php
 22 | Collection {#275 ▼
 23 |   #items: array:48 [▼
 24 |     "week52change" => 0.075238
 25 |     "week52high" => 239.76
 26 |     "week52low" => 149
 27 |     "marketcap" => 1053163233867
 28 |     "employees" => 136690
 29 |     "day200MovingAvg" => 198.57
 30 |     "day50MovingAvg" => 215.01
 31 |     "float" => 4614803231.65
 32 |     "avg10Volume" => 30745371.8
 33 |     "avg30Volume" => 29058999.5
 34 |     "ttmEPS" => 12.35
 35 |     "ttmDividendRate" => 3.02
 36 |     "companyName" => "Apple, Inc."
 37 |     "sharesOutstanding" => 4631122772
 38 |     "maxChangePercent" => 237.1558
 39 |     "year5ChangePercent" => 1.3461
 40 |     "year2ChangePercent" => 0.496
 41 |     "year1ChangePercent" => 0.074545
 42 |     "ytdChangePercent" => 0.461451
 43 |     "month6ChangePercent" => 0.15767
 44 |     "month3ChangePercent" => 0.144236
 45 |     "month1ChangePercent" => 0.029289
 46 |     "day30ChangePercent" => 0.103451
 47 |     "day5ChangePercent" => 0.013725
 48 |     "nextDividendDate" => null
 49 |     "dividendYield" => 0.013236628206334
 50 |     "nextEarningsDate" => "2019-10-30"
 51 |     "exDividendDate" => "2019-08-21"
 52 |     "peRatio" => 20.21
 53 |     "beta" => 1.562248155631
 54 |     "totalCash" => 68907243651
 55 |     "currentDebt" => 20955390131
 56 |     "revenue" => 274040365476
 57 |     "grossProfit" => 106997648374
 58 |     "totalRevenue" => 270458247991
 59 |     "EBITDA" => 84232077562
 60 |     "revenuePerShare" => 59.51
 61 |     "revenuePerEmployee" => 2023261.99
 62 |     "debtToEquity" => 1.12
 63 |     "profitMargin" => 0.2263578794686
 64 |     "enterpriseValue" => 1123390829444
 65 |     "enterpriseValueToRevenue" => 4.28
 66 |     "priceToSales" => 4
 67 |     "priceToBook" => 10.12045889477
 68 |     "forwardPERatio" => 20.4
 69 |     "pegRatio" => -2.91
 70 |     "peHigh" => 20.19903852975
 71 |     "peLow" => 12.572083819829
 72 |   ]
 73 | }
 74 | ```
 75 | 
 76 | ## Balance Sheet
 77 | 
 78 | **Example**
 79 | 
 80 | ```php
 81 | use \Digitonic\IexCloudSdk\Stocks\BalanceSheet;
 82 | 
 83 | $endpoint = new BalanceSheet($client);
 84 | $response = $endpoint->setSymbol('aapl')->get();
 85 | 
 86 | // Laravel
 87 | use \Digitonic\IexCloudSdk\Facades\Stocks\BalanceSheet;
 88 | 
 89 | $response = BalanceSheet::setSymbol('aapl')->get();
 90 | ```
 91 | 
 92 | **Response**
 93 | 
 94 | ```php
 95 | Collection {#278 ▼
 96 |   #items: array:2 [▼
 97 |     "symbol" => "AAPL"
 98 |     "balancesheet" => array:1 [▼
 99 |       0 => {#275 ▼
100 |         +"reportDate": "2019-07-12"
101 |         +"currentCash": 51892629315
102 |         +"shortTermInvestments": 44511654145
103 |         +"receivables": 14323141767
104 |         +"inventory": 3383336695
105 |         +"otherCurrentAssets": 10640238508
106 |         +"currentAssets": 136653129099
107 |         +"longTermInvestments": 122697842784
108 |         +"propertyPlantEquipment": 37856558309
109 |         +"goodwill": 0
110 |         +"intangibleAssets": null
111 |         +"otherAssets": 32797750221
112 |         +"totalAssets": 331283423725
113 |         +"accountsPayable": 29910817882
114 |         +"currentLongTermDebt": 13665033506
115 |         +"otherCurrentLiabilities": 38346986429
116 |         +"totalCurrentLiabilities": 92191397238
117 |         +"longTermDebt": 86007873448
118 |         +"otherLiabilities": 6089386415
119 |         +"minorityInterest": 0
120 |         +"totalLiabilities": 227379607321
121 |         +"commonStock": 4654525258
122 |         +"retainedEarnings": 56050947878
123 |         +"treasuryStock": null
124 |         +"capitalSurplus": null
125 |         +"shareholderEquity": 100632356740
126 |         +"netTangibleAssets": 100390265169
127 |       }
128 |     ]
129 |   ]
130 | }
131 | ```
132 | 
133 | ## Batch Requests
134 | 
135 | !> Still to be documented
136 | 
137 | ## Company
138 | 
139 | **Example**
140 | 
141 | ```php
142 | use \Digitonic\IexCloudSdk\Stocks\Company;
143 | 
144 | $endpoint = new Company($client);
145 | $response = $endpoint->setSymbol('aapl')->get();
146 | 
147 | // Laravel
148 | use \Digitonic\IexCloudSdk\Facades\Stocks\Company;
149 | 
150 | $response = Company::setSymbol('aapl')->get();
151 | ```
152 | 
153 | **Response**
154 | 
155 | ```php
156 | Collection {#275 ▼
157 |   #items: array:20 [▼
158 |     "symbol" => "AAPL"
159 |     "companyName" => "Apple, Inc."
160 |     "exchange" => "ADQNSA"
161 |     "industry" => "eqempesmincmlaEToctutnouni i"
162 |     "website" => "h./cmopwtwpt.lw/epa:"
163 |     "description" => "do rpa apimkaz giieC rlCg  nhlopgaeqV,s ahha, ,fn dsT,lTA)e es uw rf  Coam  T olsaetS a sgWoA.ai ev,g, rhaletasteri n iocsl,aep si hdGa fEtetdIu,, n  tinIngnm d ▶"
164 |     "CEO" => "nhoya omTdCo oilDtk"
165 |     "securityName" => "cpA.l pneI"
166 |     "issueType" => "sc"
167 |     "sector" => "icgoeoctllrnncehEoT y"
168 |     "primarySicCode" => 3745
169 |     "employees" => 136025
170 |     "tags" => array:2 [▶]
171 |     "address" => "n akrplApPWye Oe a"
172 |     "address2" => null
173 |     "state" => "AC"
174 |     "city" => "tupeCiorn"
175 |     "zip" => "1320984-50"
176 |     "country" => "SU"
177 |     "phone" => "4821.10933.4.7"
178 |   ]
179 | }
180 | ```
181 | 
182 | ## Key Stats
183 | 
184 | **Example 1**
185 | 
186 | ```php
187 | use \Digitonic\IexCloudSdk\Stocks\KeyStats;
188 | 
189 | $endpoint = new KeyStats($client);
190 | $response = $endpoint->setSymbol('aapl')->get();
191 | 
192 | // Laravel
193 | use \Digitonic\IexCloudSdk\Facades\KeyStats\Quote;
194 | 
195 | $response = KeyStats::setSymbol('aapl')->get();
196 | ```
197 | 
198 | **Response 1**
199 | 
200 | ```php
201 | Collection {#277 ▼
202 |   #items: array:30 [
203 |       "companyName" => "Apple Inc."
204 |       "marketcap" => 760334287200
205 |       "week52high" => 156.65
206 |       "week52low" => 93.63
207 |       "week52change" => 58.801903
208 |       "sharesOutstanding" => 5213840000
209 |       "float" => 5203997571
210 |       "avg10Volume" => 2774000
211 |       "avg30Volume" => 12774000
212 |       "day200MovingAvg" => 140.60541
213 |       "day50MovingAvg" => 156.49678
214 |       "employees" => 120000
215 |       "ttmEPS" => 16.5
216 |       "ttmDividendRate" => 2.25
217 |       "dividendYield" => 0.021
218 |       "nextDividendDate" => "2019-03-01"
219 |       "exDividendDate" => "2019-02-08"
220 |       "nextEarningsDate" => "2019-01-01"
221 |       "peRatio" => 14
222 |       "beta" => 1.25
223 |       "maxChangePercent" => 153.021
224 |       "year5ChangePercent" => 0.59025469322
225 |       "year2ChangePercent" => 0.37774498741429
226 |       "year1ChangePercent" => 0.39751716851558
227 |       "ytdChangePercent" => 0.3665949203616
228 |       "month6ChangePercent" => 0.12208398133748
229 |       "month3ChangePercent" => 0.084665846658466
230 |       "month1ChangePercent" => 0.0096685961452833
231 |       "day30ChangePercent" => -0.0027626056999688
232 |       "day5ChangePercent" => -0.0057626056999688
233 |     ]
234 | 
235 | }
236 | ```
237 | 
238 | **Example 2**
239 | 
240 | ```php
241 | use \Digitonic\IexCloudSdk\Stocks\KeyStats;
242 | 
243 | $endpoint = new KeyStats($client);
244 | $response = $endpoint->setSymbol('aapl')->only('latestPrice')->get();
245 | 
246 | // Laravel
247 | use \Digitonic\IexCloudSdk\Facades\Stocks\KeyStats;
248 | 
249 | $response = KeyStats::setSymbol('aapl')->only('day50MovingAvg')->get();
250 | ```
251 | 
252 | **Response 2**
253 | 
254 | ```php
255 | Collection {#277 ▼
256 |   #items: array:1 [▼
257 |       "day50MovingAvg" => 156.49678
258 |   ]
259 | }
260 | ```
261 | 
262 | ## Logo
263 | 
264 | This is a helper function, but the Google APIs url is standardized.
265 | 
266 | **Example**
267 | 
268 | ```php
269 | use \Digitonic\IexCloudSdk\Stocks\Logo;
270 | 
271 | $endpoint = new Logo($client);
272 | $response = $endpoint->setSymbol('aapl')->get();
273 | 
274 | // Laravel
275 | use \Digitonic\IexCloudSdk\Facades\Stocks\Logo;
276 | 
277 | $response = Logo::setSymbol('aapl')->get();
278 | ```
279 | 
280 | **Response**
281 | 
282 | ```php
283 | Collection {#275 ▼
284 |   #items: array:1 [▼
285 |     "url" => "https://storage.googleapis.com/iex/api/logos/AAPL.png"
286 |   ]
287 | }
288 | ```
289 | 
290 | ## News
291 | 
292 | **Example**
293 | 
294 | ```php
295 | use \Digitonic\IexCloudSdk\Stocks\News;
296 | 
297 | $endpoint = new News($client);
298 | $response = $endpoint->setSymbol('aapl')->get();
299 | 
300 | // Laravel
301 | use \Digitonic\IexCloudSdk\Facades\Stocks\News;
302 | 
303 | $response = News::setSymbol('aapl')->get();
304 | 
305 | // Limit results (between 1 and 50) - default 10
306 | $response = News::setSymbol('aapl')->take(5)->get();
307 | ```
308 | 
309 | **Response**
310 | 
311 | ```php
312 | Collection {#281 ▼
313 |   #items: array:10 [▼
314 |     0 => {#277 ▼
315 |       +"datetime": 1585798516729
316 |       +"headline": "iu  McDcxsl ovo kSiosfefllTol ielESdap rs onptotp Aelo"
317 |       +"source": "orBs'arn"
318 |       +"url": "o-3sp9d2ee/tfa1./pl2cnc--6xti8r2eo0044wdthl5:f485m0-4s/e4ivaued602./s/cc/7icc2"
319 |       +"summary": "r yphef-rk s   u ki driodoaapiardencselaeshfw ffcpor  ehnha loaifeelhaadtf  ns5ntaie ctoegfrcithocctcasi gArte enni eddihino2nhastigcnpnt. aT  "
320 |       +"related": "APLA"
321 |       +"image": "7/06pes.4h.fisnem-2//x0w8/-pae093-c2-:i5at5o6/e4s41vte224m0lodcc2ifuc8/c4dgd"
322 |       +"lang": "ne"
323 |       +"hasPaywall": true
324 |     }
325 |     1 => {#275 ▶}
326 |     2 => {#278 ▶}
327 |     3 => {#272 ▶}
328 |     4 => {#267 ▶}
329 |     5 => {#265 ▶}
330 |     6 => {#276 ▶}
331 |     7 => {#269 ▶}
332 |     8 => {#279 ▶}
333 |     9 => {#280 ▶}
334 |   ]
335 | }
336 | ```
337 | 
338 | ## Previous Day Price
339 | 
340 | **Example**
341 | 
342 | ```php
343 | use \Digitonic\IexCloudSdk\Stocks\PreviousDayPrice;
344 | 
345 | $endpoint = new PreviousDayPrice($client);
346 | $response = $endpoint->setSymbol('aapl')->get();
347 | 
348 | // Laravel
349 | use \Digitonic\IexCloudSdk\Facades\Stocks\PreviousDayPrice;
350 | 
351 | $response = PreviousDayPrice::setSymbol('aapl')->get();
352 | 
353 | // Previous Day Price (market)
354 | $response = PreviousDayPrice::setSymbol('market')->get();
355 | ```
356 | 
357 | !> Warning: Previous day price for "market" will return all symbols. This can be approx 10-15MB of data and will quite possibly timeout a web request. This should be performed as a background task.
358 | 
359 | **Response**
360 | 
361 | ```php
362 | Collection {#275 ▼
363 |   #items: array:15 [▼
364 |     "date" => "2019-10-14"
365 |     "open" => 241.7
366 |     "close" => 239.82
367 |     "high" => 244.49
368 |     "low" => 246.29
369 |     "volume" => 24742033
370 |     "uOpen" => 237.9
371 |     "uClose" => 241.9
372 |     "uHigh" => 238.94
373 |     "uLow" => 241.18
374 |     "uVolume" => 24954674
375 |     "change" => 0
376 |     "changePercent" => 0
377 |     "changeOverTime" => 0
378 |     "symbol" => "AAPL"
379 |   ]
380 | }
381 | ```
382 | 
383 | ## Price
384 | 
385 | **Example**
386 | 
387 | ```php
388 | use \Digitonic\IexCloudSdk\Stocks\Price;
389 | 
390 | $endpoint = new Price($client);
391 | $response = $endpoint->setSymbol('aapl')->get();
392 | 
393 | // Laravel
394 | use \Digitonic\IexCloudSdk\Facades\Stocks\Price;
395 | 
396 | $response = Price::setSymbol('aapl')->get();
397 | ```
398 | 
399 | **Response**
400 | 
401 | ```php
402 | Collection {#277 ▼
403 |   #items: array:1 [▼
404 |     0 => 244.25
405 |   ]
406 | }
407 | ```
408 | 
409 | ## Price Target
410 | 
411 | Provides the latest avg, high, and low analyst price target for a symbol.
412 | 
413 | **Example**
414 | 
415 | ```php
416 | use \Digitonic\IexCloudSdk\Stocks\PriceTarget;
417 | 
418 | $endpoint = new PriceTarget($client);
419 | $response = $endpoint->setSymbol('aapl')->get();
420 | 
421 | // Laravel
422 | use \Digitonic\IexCloudSdk\Facades\Stocks\PriceTarget;
423 | 
424 | $response = PriceTarget::setSymbol('aapl')->get();
425 | ```
426 | 
427 | **Response**
428 | 
429 | ```php
430 | Collection {#275 ▼
431 |   #items: array:6 [▼
432 |     "symbol" => "AAPL"
433 |     "updatedDate" => "2019-10-21"
434 |     "priceTargetAverage" => 239
435 |     "priceTargetHigh" => 270
436 |     "priceTargetLow" => 156
437 |     "numberOfAnalysts" => 39
438 |   ]
439 | }
440 | ```
441 | 
442 | ## Quote
443 | 
444 | **Example 1**
445 | 
446 | ```php
447 | use \Digitonic\IexCloudSdk\Stocks\Quote;
448 | 
449 | $endpoint = new Quote($client);
450 | $response = $endpoint->setSymbol('aapl')->get();
451 | 
452 | // Laravel
453 | use \Digitonic\IexCloudSdk\Facades\Stocks\Quote;
454 | 
455 | $response = Quote::setSymbol('aapl')->get();
456 | ```
457 | 
458 | **Response 1**
459 | 
460 | ```php
461 | Collection {#277 ▼
462 |   #items: array:1 [▼
463 |       "symbol" =>  "AAPL",
464 |       "companyName" =>  "Apple Inc.",
465 |       "calculationPrice" =>  "tops",
466 |       "open" =>  154,
467 |       "openTime" =>  1506605400394,
468 |       "close" =>  153.28,
469 |       "closeTime" =>  1506605400394,
470 |       "high" =>  154.80,
471 |       "low" =>  153.25,
472 |       "latestPrice" =>  158.73,
473 |       "latestSource" =>  "Previous close",
474 |       "latestTime" =>  "September 19, 2017",
475 |       "latestUpdate" =>  1505779200000,
476 |       "latestVolume" =>  20567140,
477 |       "volume" =>  20567140,
478 |       "iexRealtimePrice" =>  158.71,
479 |       "iexRealtimeSize" =>  100,
480 |       "iexLastUpdated" =>  1505851198059,
481 |       "delayedPrice" =>  158.71,
482 |       "delayedPriceTime" =>  1505854782437,
483 |       "oddLotDelayedPrice" =>  158.70,
484 |       "oddLotDelayedPriceTime" =>  1505854782436,
485 |       "extendedPrice" =>  159.21,
486 |       "extendedChange" =>  -1.68,
487 |       "extendedChangePercent" =>  -0.0125,
488 |       "extendedPriceTime" =>  1527082200361,
489 |       "previousClose" =>  158.73,
490 |       "previousVolume" =>  22268140,
491 |       "change" =>  -1.67,
492 |       "changePercent" =>  -0.01158,
493 |       "iexMarketPercent" =>  0.00948,
494 |       "iexVolume" =>  82451,
495 |       "avgTotalVolume" =>  29623234,
496 |       "iexBidPrice" =>  153.01,
497 |       "iexBidSize" =>  100,
498 |       "iexAskPrice" =>  158.66,
499 |       "iexAskSize" =>  100,
500 |       "marketCap" =>  751627174400,
501 |       "week52High" =>  159.65,
502 |       "week52Low" =>  93.63,
503 |       "ytdChange" =>  0.3665,
504 |       "peRatio" =>  17.18,
505 |       "lastTradeTime" =>  1505779200000,
506 |       "isUSMarketOpen" =>  false
507 |   ]
508 | }
509 | ```
510 | 
511 | **Example 2**
512 | 
513 | ```php
514 | use \Digitonic\IexCloudSdk\Stocks\Quote;
515 | 
516 | $endpoint = new Quote($client);
517 | $response = $endpoint->setSymbol('aapl')->only('latestPrice')->get();
518 | 
519 | // Laravel
520 | use \Digitonic\IexCloudSdk\Facades\Stocks\Quote;
521 | 
522 | $response = Quote::setSymbol('aapl')->only('latestPrice')->get();
523 | ```
524 | 
525 | **Response 2**
526 | 
527 | ```php
528 | Collection {#277 ▼
529 |   #items: array:1 [▼
530 |       "latestPrice" =>  158.73
531 |   ]
532 | }
533 | ```
534 | 


--------------------------------------------------------------------------------