Merge pull request #5 from MarketDataApp/fill-in-stub-endpoints

Fill in stub endpoints

Author: KerryJones

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## v0.4.0-alpha
+
+- Completed remaining endpoints: 
+  - Options
+    - expirations
+    - lookup
+    - strikes
+    - option_chain
+    - quotes
+  - Utilities
+    - api_status
+    - headers
+  - Mutual Funds
+    - candles
+  - Markets
+    - status
+
 ## v0.3.0-alpha
 
 - Completed Stocks endpoints: earnings, news.

README.md

@@ -39,12 +39,42 @@ $quotes = $client->stocks->quotes(['AAPL', 'NFLX']);
 $bulk_quotes = $client->stocks->bulk_quotes(['AAPL', 'NFLX']);
 $earnings = $client->stocks->earnings(symbol: 'AAPL', from: Carbon::parse('2023-01-01'));
 $news = $client->stocks->news(symbol: 'AAPL', from: Carbon::parse('2023-01-01'));
+
+// Markets
+$status = $client->markets->status(date: Carbon::parse('2023-01-01'));
+
+// Mutual Funds
+$candles = $client->mutual_funds->candles(
+    symbol: 'VFINX',
+    from: Carbon::parse('2022-09-01'),
+    to: Carbon::parse('2022-09-05'),
+    resolution: 'D'
+);
+
+// Options
+$expirations = $client->options->expirations('AAPL');
+$lookup = $client->options->lookup('AAPL 7/28/23 $200 Call');
+$strikes = $client->options->strikes(
+    symbol: 'AAPL',
+    expiration: Carbon::parse('2023-01-20'),
+    date: Carbon::parse('2023-01-03'),
+);
+$option_chain = $client->options->option_chain(
+    symbol: 'AAPL',
+    expiration: Carbon::parse('2025-01-17'),
+    side: Side::CALL,
+);
+$quotes = $client->options->quotes('AAPL250117C00150000');
+
+// Utilities
+$status = $client->utilities->api_status();
+$headers = $client->utilities->headers();
 ```
 
 ## Testing
 
 ```bash
-./vendor/bin/phpunit tests
+./vendor/bin/phpunit
 ```
 
 ## Changelog

src/ClientBase.php

@@ -66,7 +66,7 @@ public function execute($method, array $arguments = []): object
 
         $response = json_decode($json_response);
 
-        if($response->s === 'error') {
+        if(isset($response->s) && $response->s === 'error') {
             throw new ApiException(message: $response->errmsg, response: $response);
         }
 

src/Endpoints/Markets.php

@@ -2,8 +2,11 @@
 
 namespace MarketDataApp\Endpoints;
 
+use Carbon\Carbon;
+use GuzzleHttp\Exception\GuzzleException;
 use MarketDataApp\Client;
-use MarketDataApp\Endpoints\Responses\Markets\Status;
+use MarketDataApp\Endpoints\Responses\Markets\Statuses;
+use MarketDataApp\Exceptions\ApiException;
 
 class Markets
 {
@@ -16,9 +19,31 @@ public function __construct($client)
         $this->client = $client;
     }
 
-    public function status(): Status
-    {
+    /**
+     * Get the past, present, or future status for a stock market. The endpoint will respond with "open" for trading
+     * days or "closed" for weekends or market holidays.
+     *
+     * @param string $country The country. Use the two digit ISO 3166 country code. If no country is specified, US will
+     * be assumed. Only countries that Market Data supports for stock price data are available (currently only the
+     * United States).
+     *
+     * @param Carbon|null $date Consult whether the market was open or closed on the specified date.
+     * @param Carbon|null $from The earliest date (inclusive). If you use countback, from is not required.
+     * @param Carbon|null $to The last date (inclusive).
+     * @param int|null $countback Countback will fetch a number of dates before to If you use from, countback is not
+     * required.
+     * @return Statuses
+     * @throws GuzzleException|ApiException
+     */
+    public function status(
+        string $country = "US",
+        Carbon $date = null,
+        Carbon $from = null,
+        Carbon $to = null,
+        int $countback = null
+    ): Statuses {
         // Stub
-        return new Status();
+        return new Statuses($this->client->execute(self::BASE_URL . "status/",
+            compact('country', 'date', 'from', 'to', 'countback')));
     }
 }

src/Endpoints/MutualFunds.php

@@ -2,8 +2,11 @@
 
 namespace MarketDataApp\Endpoints;
 
+use Carbon\Carbon;
+use GuzzleHttp\Exception\GuzzleException;
 use MarketDataApp\Client;
 use MarketDataApp\Endpoints\Responses\MutualFunds\Candles;
+use MarketDataApp\Exceptions\ApiException;
 
 class MutualFunds
 {
@@ -16,9 +19,34 @@ public function __construct($client)
         $this->client = $client;
     }
 
-    public function candles(): Candles
-    {
-        // Stub
-        return new Candles();
+    /**
+     * Get historical price candles for a mutual fund.
+     *
+     * @param string $symbol The mutual fund's ticker symbol.
+     * @param Carbon $from The leftmost candle on a chart (inclusive). If you use countback, to is not required.
+     * @param Carbon|null $to The rightmost candle on a chart (inclusive).
+     * @param string $resolution The duration of each candle.
+     * Minutely Resolutions: (minutely, 1, 3, 5, 15, 30, 45, ...) Hourly Resolutions: (hourly, H, 1H, 2H, ...)
+     * Daily Resolutions: (daily, D, 1D, 2D, ...)
+     * Weekly Resolutions: (weekly, W, 1W, 2W, ...)
+     * Monthly Resolutions: (monthly, M, 1M, 2M, ...)
+     * Yearly Resolutions:(yearly, Y, 1Y, 2Y, ...)
+     *
+     * @param int|null $countback Will fetch a number of candles before (to the left of) to. If you use from, countback
+     * is not required.
+     *
+     * @return Candles
+     * @throws GuzzleException|ApiException
+     */
+    public function candles(
+        string $symbol,
+        Carbon $from,
+        Carbon $to = null,
+        string $resolution = 'D',
+        int $countback = null,
+    ): Candles {
+        return new Candles($this->client->execute(self::BASE_URL . "candles/{$resolution}/{$symbol}/",
+            compact('from', 'to', 'countback')
+        ));
     }
 }