Merge pull request #3 from MarketDataApp/add-more-endpoints

Add more endpoints

Author: KerryJones

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.3.0-alpha
+
+- Completed Stocks endpoints: earnings, news.
+- Add stubs for the rest of the endpoints.
+
 ## v0.2.0-alpha
 
 - Completed Indices endpoints.

README.md

@@ -20,7 +20,7 @@ composer require MarketDataApp/sdk-php
 ## Usage
 
 ```php
-$client = new MarketDataApp\Client();
+$client = new MarketDataApp\Client('your_api_token');
 
 // Indices
 $quote = $client->indices->quote('DJI');
@@ -32,9 +32,13 @@ $candles = $client->indices->candles(
 );
 
 // Stocks
+$candles = $client->stocks->candles('AAPL');
+$bulk_candles = $client->stocks->bulkCandles(['AAPL, MSFT']);
 $quote = $client->stocks->quote('AAPL');
 $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'));
 ```
 
 ## Testing

src/Client.php

@@ -3,7 +3,11 @@
 namespace MarketDataApp;
 
 use MarketDataApp\Endpoints\Indices;
+use MarketDataApp\Endpoints\Markets;
+use MarketDataApp\Endpoints\MutualFunds;
+use MarketDataApp\Endpoints\Options;
 use MarketDataApp\Endpoints\Stocks;
+use MarketDataApp\Endpoints\Utilities;
 
 class Client extends ClientBase
 {
@@ -19,11 +23,39 @@ class Client extends ClientBase
      */
     public Stocks $stocks;
 
+    /**
+     * The Market Data API provides a comprehensive suite of options endpoints, designed to cater to various needs
+     * around options data. These endpoints are designed to be flexible and robust, supporting both real-time
+     * and historical data queries. They accommodate a wide range of optional parameters for detailed data
+     * retrieval, making the Market Data API a versatile tool for options traders and financial analysts.
+     */
+    public Options $options;
+
+    /**
+     * The Markets endpoints provide reference and status data about the markets covered by Market Data.
+     */
+    public Markets $markets;
+
+    /**
+     * The mutual funds endpoints offer access to historical pricing data for mutual funds.
+     */
+    public MutualFunds $mutual_funds;
+
+    /**
+     * These endpoints are designed to assist with API-related service issues, including checking the online status and
+     * uptime.
+     */
+    public Utilities $utilities;
+
     public function __construct($token)
     {
         parent::__construct($token);
 
         $this->indices = new Indices($this);
         $this->stocks = new Stocks($this);
+        $this->options = new Options($this);
+        $this->markets = new Markets($this);
+        $this->mutual_funds = new MutualFunds($this);
+        $this->utilities = new Utilities($this);
     }
 }

src/Endpoints/Markets.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace MarketDataApp\Endpoints;
+
+use MarketDataApp\Client;
+use MarketDataApp\Endpoints\Responses\Markets\Status;
+
+class Markets
+{
+
+    private Client $client;
+    public const BASE_URL = "v1/markets/";
+
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+
+    public function status(): Status
+    {
+        // Stub
+        return new Status();
+    }
+}

src/Endpoints/MutualFunds.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace MarketDataApp\Endpoints;
+
+use MarketDataApp\Client;
+use MarketDataApp\Endpoints\Responses\MutualFunds\Candles;
+
+class MutualFunds
+{
+
+    private Client $client;
+    public const BASE_URL = "v1/funds/";
+
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+
+    public function candles(): Candles
+    {
+        // Stub
+        return new Candles();
+    }
+}

src/Endpoints/Options.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace MarketDataApp\Endpoints;
+
+use MarketDataApp\Client;
+use MarketDataApp\Endpoints\Responses\Options\Expirations;
+use MarketDataApp\Endpoints\Responses\Options\Lookup;
+use MarketDataApp\Endpoints\Responses\Options\OptionChain;
+use MarketDataApp\Endpoints\Responses\Options\Quotes;
+use MarketDataApp\Endpoints\Responses\Options\Strikes;
+
+class Options
+{
+
+    private Client $client;
+    public const BASE_URL = "v1/options/";
+
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+
+    public function expirations(): Expirations
+    {
+        // Stub
+        return new Expirations();
+    }
+
+    public function lookup(): Lookup
+    {
+        // Stub
+        return new Lookup();
+    }
+
+    public function strikes(): Strikes
+    {
+        // Stub
+        return new Strikes();
+    }
+
+    public function option_chain(): OptionChain
+    {
+        // Stub
+        return new OptionChain();
+    }
+
+    public function quotes(): Quotes
+    {
+        // Stub
+        return new Quotes();
+    }
+}

src/Endpoints/Responses/Markets/Status.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace MarketDataApp\Endpoints\Responses\Markets;
+
+class Status
+{
+}

src/Endpoints/Responses/MutualFunds/Candles.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace MarketDataApp\Endpoints\Responses\MutualFunds;
+
+class Candles
+{
+}

src/Endpoints/Responses/Options/Expirations.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace MarketDataApp\Endpoints\Responses\Options;
+
+class Expirations
+{
+}

src/Endpoints/Responses/Options/Lookup.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace MarketDataApp\Endpoints\Responses\Options;
+
+class Lookup
+{
+}