Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tri committed Jul 26, 2021
1 parent be7538c commit 40404ea
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 57 deletions.
123 changes: 66 additions & 57 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ PHP 5.5 and later
## Installation & Usage

### Composer

In composer.json:
```json
{
"require": {
"finnhub/client": "1.0.0"
"finnhub/client": "1.1.3"
}
}
```
Expand All @@ -35,39 +35,39 @@ $client = new Finnhub\Api\DefaultApi(
);

// Stock candles
print_r($client->stockCandles('AAPL', 'D', 1590988249, 1591852249));
print_r($client->stockCandles("AAPL", "D", 1590988249, 1591852249));

// Aggregate Indicators
print_r($client->aggregateIndicator('AAPL', 'D'));
print_r($client->aggregateIndicator("AAPL", "D"));

// Basic financials
print_r($client->companyBasicFinancials('AAPL', 'margin'));
print_r($client->companyBasicFinancials("AAPL", "margin"));

// Earnings surprises
print_r($client->companyEarnings('TSLA', 5));
print_r($client->companyEarnings("TSLA", 5));

// EPS estimates
print_r($client->companyEpsEstimates('AMZN', 'quarterly'));
print_r($client->companyEpsEstimates("AMZN", "quarterly"));

// Company Executives
print_r($client->companyExecutive('AAPL'));
print_r($client->companyExecutive("AAPL"));

// Company News
print_r($client->companyNews('AAPL', "2020-06-01", "2020-06-10"));
print_r($client->companyNews("AAPL", "2020-06-01", "2020-06-10"));

// Company Peers
print_r($client->companyPeers('AAPL'));
print_r($client->companyPeers("AAPL"));

// Company Profile
print_r($client->companyProfile('AAPL'));
print_r($client->companyProfile(null, 'US0378331005'));
print_r($client->companyProfile(null, null, '037833100'));
print_r($client->companyProfile("AAPL"));
print_r($client->companyProfile(null, "US0378331005"));
print_r($client->companyProfile(null, null, "037833100"));

// Company Profile 2
print_r($client->companyProfile2('AAPL'));
print_r($client->companyProfile2("AAPL"));

// Revenue Estimates
print_r($client->companyRevenueEstimates('TSLA', 'quarterly'));
print_r($client->companyRevenueEstimates("TSLA", "quarterly"));

// List country
print_r($client->country());
Expand All @@ -76,70 +76,70 @@ print_r($client->country());
print_r($client->cryptoExchanges());

// Crypto symbols
print_r($client->cryptoSymbols('BINANCE'));
print_r($client->cryptoSymbols("BINANCE"));

// Economic data
print_r($client->economicData('MA-USA-656880'));
print_r($client->economicData("MA-USA-656880"));

// Filings
print_r($client->filings('AAPL', "2020-01-01", "2020-06-11"));
print_r($client->filings("AAPL", "2020-01-01", "2020-06-11"));

// Financials
print_r($client->financials('AAPL', 'bs', 'annual'));
print_r($client->financials("AAPL", "bs", "annual"));

// Financials as reported
print_r($client->financialsReported('AAPL', 'annual'));
print_r($client->financialsReported("AAPL", "annual"));

// Forex exchanges
print_r($client->forexExchanges());

// Forex all pairs
print_r($client->forexRates('USD'));
print_r($client->forexRates("USD"));

// Forex symbols
print_r($client->forexSymbols('OANDA'));
print_r($client->forexSymbols("OANDA"));

// Fund Ownership
print_r($client->fundOwnership('AMZN', 5));
print_r($client->fundOwnership("AMZN", 5));

// General news
print_r($client->marketNews('forex', 0));
print_r($client->marketNews("forex", 0));

// Ownership
print_r($client->ownership('AAPL', 5));
print_r($client->ownership("AAPL", 5));

// IPO calendar
print_r($client->ipoCalendar("2020-05-01", "2020-06-01"));

// Major developments
print_r($client->pressReleases('AAPL', "2020-01-01", "2020-12-31"));
print_r($client->pressReleases("AAPL", "2020-01-01", "2020-12-31"));

// News sentiment
print_r($client->newsSentiment('AAPL'));
print_r($client->newsSentiment("AAPL"));

// Pattern recognition
print_r($client->patternRecognition('AAPL', 'D'));
print_r($client->patternRecognition("AAPL", "D"));

// Price target
print_r($client->priceTarget('AAPL'));
print_r($client->priceTarget("AAPL"));

// Quote
print_r($client->quote('AAPL'));
print_r($client->quote("AAPL"));

// Recommendation trends
print_r($client->recommendationTrends('AAPL'));
print_r($client->recommendationTrends("AAPL"));

// Stock dividends
print_r($client->stockDividends('KO', '2019-01-01', '2020-01-01'));
print_r($client->stockDividends("KO", "2019-01-01", "2020-01-01"));

// Stock symbols
print_r($client->stockSymbols('US'));
print_r($client->stockSymbols("US"));

// Transcripts
print_r($client->transcripts('AAPL_162777'));
print_r($client->transcripts("AAPL_162777"));

// Transcripts list
print_r($client->transcriptsList('AAPL'));
print_r($client->transcriptsList("AAPL"));

// Earnings Calendar
print_r($client->earningsCalendar("2020-06-10", "2020-06-30", null, false));
Expand All @@ -148,75 +148,84 @@ print_r($client->earningsCalendar("2020-06-10", "2020-06-30", null, false));
print_r($client->covid19());

// Upgrade downgrade
print_r($client->upgradeDowngrade('AAPL', '2020-01-01', '2020-06-30'));
print_r($client->upgradeDowngrade("AAPL", "2020-01-01", "2020-06-30"));

// Economic code
print_r($client->economicCode());

// Support resistance
print_r($client->supportResistance('AAPL', 'D'));
print_r($client->supportResistance("AAPL", "D"));

// Technical Indicator
$indicatorFields = new stdClass();
$indicatorFields->timeperiod = 3;
print_r($client->technicalIndicator("AAPL", 'D', 1583098857, 1584308457, 'rsi', $indicatorFields));
print_r($client->technicalIndicator("AAPL", "D", 1583098857, 1584308457, "rsi", $indicatorFields));

// Stock splits
print_r($client->stockSplits('AAPL', '2000-01-01', '2020-01-01'));
print_r($client->stockSplits("AAPL", "2000-01-01", "2020-01-01"));

// Forex candles
print_r($client->forexCandles('OANDA:EUR_USD', 'D', 1590988249, 1591852249));
print_r($client->forexCandles("OANDA:EUR_USD", "D", 1590988249, 1591852249));

// Crypto Candles
print_r($client->cryptoCandles('BINANCE:BTCUSDT', 'D', 1590988249, 1591852249));
print_r($client->cryptoCandles("BINANCE:BTCUSDT", "D", 1590988249, 1591852249));

// Tick Data
print_r($client->stockTick('AAPL', '2020-03-25', 500, 0));
print_r($client->stockTick("AAPL", "2020-03-25", 500, 0));

// Indices Constituents
print_r($client.indicesConstituents("^GSPC"))
print_r($client->indicesConstituents("^GSPC"));

// Indices Historical Constituents
print_r($client->indicesHistoricalConstituents("^GSPC"))
print_r($client->indicesHistoricalConstituents("^GSPC"));

// ETFs Profile
print_r($client->etfsProfile('SPY'))
print_r($client->etfsProfile("SPY"));

// ETFs Holdings
print_r($client->etfsHoldings('SPY'))
print_r($client->etfsHoldings("SPY"));

// ETFs Industry Exposure
print_r($client->etfsSectorExposure('SPY'))
print_r($client->etfsSectorExposure("SPY"));

// ETFs Country Exposure
print_r($client->etfsCountryExposure('SPY'))
print_r($client->etfsCountryExposure("SPY"));

// Mutual Fund Profile
print_r($client->mutualFundProfile('VTSAX'))
print_r($client->mutualFundProfile("VTSAX"));

// Mutual Fund Holdings
print_r($client->mutualFundHoldings('VTSAX'))
print_r($client->mutualFundHoldings("VTSAX"));

// Mutual Fund Sector Exposure
print_r($client->mutualFundSectorExposure('VTSAX'))
print_r($client->mutualFundSectorExposure("VTSAX"));

// Mutual Fund Country Exposure
print_r($client->mutualFundCountryExposure('VTSAX'))
print_r($client->mutualFundCountryExposure("VTSAX"));

// Revenue Breakdown
print_r($client->revenueBreakdown('AAPL'))
print_r($client->revenueBreakdown("AAPL"));

// Social sentiment
print_r($client->socialSentiment('GME'))
print_r($client->socialSentiment("GME"));

// Investment themes
print_r($client->investmentThemes('financialExchangesData'))
print_r($client->investmentThemes("financialExchangesData"));

// Supply Chain
print_r($client->supplyChainRelationships('AAPL'))
print_r($client->supplyChainRelationships("AAPL"));

// Insider Transactions
print_r($client->insiderTransactions('AAPL', '2021-01-01', '2021-03-01'));
print_r($client->insiderTransactions("AAPL", "2021-01-01", "2021-03-01"));

// International Filings
print_r($client->internationalFilings("AC.TO"));

// Filings sentiment
print_r($client->filingsSentiment("0000320193-20-000052"));

// Similarity Index
print_r($client->similarityIndex("AAPL"));

?>
```
Expand Down
6 changes: 6 additions & 0 deletions release.sh
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
if [ $# -eq 0 ]
then
echo "No arguments supplied"
exit
fi

git add -A
git commit -m "update v$1"
git tag v$1
Expand Down

0 comments on commit 40404ea

Please sign in to comment.