hackerESQ
61 lines
1.4 KiB
PHP
61 lines
1.4 KiB
PHP
<?php
|
|
|
|
namespace App\Interfaces\MarketData;
|
|
|
|
use Illuminate\Support\Collection;
|
|
use App\Interfaces\MarketData\Types\Quote;
|
|
|
|
interface MarketDataInterface
|
|
{
|
|
/**
|
|
* Does this symbol actually exist?
|
|
*
|
|
* @param String $symbol
|
|
*
|
|
* @return Bool
|
|
*/
|
|
public function exists(String $symbol): Bool;
|
|
|
|
/**
|
|
* Get quote data
|
|
*
|
|
* @param String $symbol
|
|
*
|
|
* @return Quote
|
|
*/
|
|
public function quote(String $symbol): Quote;
|
|
|
|
/**
|
|
* Get dividend data
|
|
*
|
|
* @param String $symbol
|
|
* @param \DateTimeInterface $startDate
|
|
* @param \DateTimeInterface $endDate
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function dividends(String $symbol, \DateTimeInterface $startDate, \DateTimeInterface $endDate): Collection;
|
|
|
|
/**
|
|
* Get split data
|
|
*
|
|
* @param String $symbol
|
|
* @param \DateTimeInterface $startDate
|
|
* @param \DateTimeInterface $endDate
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function splits(String $symbol, \DateTimeInterface $startDate, \DateTimeInterface $endDate): Collection;
|
|
|
|
/**
|
|
* Get historical close data
|
|
*
|
|
* @param String $symbol
|
|
* @param \DateTimeInterface $startDate
|
|
* @param \DateTimeInterface $endDate
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function history(String $symbol, \DateTimeInterface $startDate, \DateTimeInterface $endDate): Collection;
|
|
}
|