initialize

Finnhub-Stock-API · Jun 28, 2020 · f9d900f · f9d900f
commit f9d900f
Show file tree

Hide file tree

Showing 193 changed files with 51,213 additions and 0 deletions.
diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore
@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -0,0 +1 @@
+4.3.1
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,23 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setUsingCache(true)
+    ->setRules([
+        '@PSR2' => true,
+        'ordered_imports' => true,
+        'phpdoc_order' => true,
+        'array_syntax' => [ 'syntax' => 'short' ],
+        'strict_comparison' => true,
+        'strict_param' => true,
+        'no_trailing_whitespace' => false,
+        'no_trailing_whitespace_in_comment' => false,
+        'braces' => false,
+        'single_blank_line_at_eof' => false,
+        'blank_line_after_namespace' => false,
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+        ->exclude('test')
+        ->exclude('tests')
+        ->in(__DIR__)
+    );
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,10 @@
+language: php
+sudo: false
+php:
+    - 5.4
+    - 5.5
+    - 5.6
+    - 7.0
+    - hhvm
+before_install: "composer install"
+script: "vendor/bin/phpunit"
diff --git a/README.md b/README.md
@@ -0,0 +1,222 @@
+# Finnhub
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.PhpClientCodegen
+
+## Requirements
+
+PHP 5.5 and later
+
+## Installation & Usage
+
+### Composer
+
+To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
+
+```json
+{
+  "repositories": [
+    {
+      "type": "vcs",
+      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+    }
+  ],
+  "require": {
+    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
+  }
+}
+```
+
+Then run `composer install`
+
+### Manual Installation
+
+Download the files and include `autoload.php`:
+
+```php
+    require_once('/path/to/Finnhub/vendor/autoload.php');
+```
+
+## Tests
+
+To run the unit tests:
+
+```bash
+composer install
+./vendor/bin/phpunit
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+
+// Configure API key authorization: api_key
+$config = Finnhub\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = Finnhub\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
+
+
+$apiInstance = new Finnhub\Api\DefaultApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$symbol = 'symbol_example'; // string | symbol
+$resolution = 'resolution_example'; // string | Supported resolution includes <code>1, 5, 15, 30, 60, D, W, M </code>.Some timeframes might not be available depending on the exchange.
+
+try {
+    $result = $apiInstance->aggregateIndicator($symbol, $resolution);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->aggregateIndicator: ', $e->getMessage(), PHP_EOL;
+}
+
+?>
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://finnhub.io/api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DefaultApi* | [**aggregateIndicator**](docs/Api/DefaultApi.md#aggregateindicator) | **GET** /scan/technical-indicator | Aggregate Indicators
+*DefaultApi* | [**companyBasicFinancials**](docs/Api/DefaultApi.md#companybasicfinancials) | **GET** /stock/metric | Basic Financials
+*DefaultApi* | [**companyEarnings**](docs/Api/DefaultApi.md#companyearnings) | **GET** /stock/earnings | Earnings Surprises
+*DefaultApi* | [**companyEpsEstimates**](docs/Api/DefaultApi.md#companyepsestimates) | **GET** /stock/eps-estimate | Earnings Estimates
+*DefaultApi* | [**companyExecutive**](docs/Api/DefaultApi.md#companyexecutive) | **GET** /stock/executive | Company Executive
+*DefaultApi* | [**companyNews**](docs/Api/DefaultApi.md#companynews) | **GET** /company-news | Company News
+*DefaultApi* | [**companyPeers**](docs/Api/DefaultApi.md#companypeers) | **GET** /stock/peers | Peers
+*DefaultApi* | [**companyProfile**](docs/Api/DefaultApi.md#companyprofile) | **GET** /stock/profile | Company Profile
+*DefaultApi* | [**companyProfile2**](docs/Api/DefaultApi.md#companyprofile2) | **GET** /stock/profile2 | Company Profile 2
+*DefaultApi* | [**companyRevenueEstimates**](docs/Api/DefaultApi.md#companyrevenueestimates) | **GET** /stock/revenue-estimate | Revenue Estimates
+*DefaultApi* | [**country**](docs/Api/DefaultApi.md#country) | **GET** /country | Country Metadata
+*DefaultApi* | [**covid19**](docs/Api/DefaultApi.md#covid19) | **GET** /covid19/us | COVID-19
+*DefaultApi* | [**cryptoCandles**](docs/Api/DefaultApi.md#cryptocandles) | **GET** /crypto/candle | Crypto Candles
+*DefaultApi* | [**cryptoExchanges**](docs/Api/DefaultApi.md#cryptoexchanges) | **GET** /crypto/exchange | Crypto Exchanges
+*DefaultApi* | [**cryptoSymbols**](docs/Api/DefaultApi.md#cryptosymbols) | **GET** /crypto/symbol | Crypto Symbol
+*DefaultApi* | [**earningsCalendar**](docs/Api/DefaultApi.md#earningscalendar) | **GET** /calendar/earnings | Earnings Calendar
+*DefaultApi* | [**economicCode**](docs/Api/DefaultApi.md#economiccode) | **GET** /economic/code | Economic Code
+*DefaultApi* | [**economicData**](docs/Api/DefaultApi.md#economicdata) | **GET** /economic | Economic Data
+*DefaultApi* | [**filings**](docs/Api/DefaultApi.md#filings) | **GET** /stock/filings | Filings
+*DefaultApi* | [**financials**](docs/Api/DefaultApi.md#financials) | **GET** /stock/financials | Financial Statements
+*DefaultApi* | [**financialsReported**](docs/Api/DefaultApi.md#financialsreported) | **GET** /stock/financials-reported | Financials As Reported
+*DefaultApi* | [**forexCandles**](docs/Api/DefaultApi.md#forexcandles) | **GET** /forex/candle | Forex Candles
+*DefaultApi* | [**forexExchanges**](docs/Api/DefaultApi.md#forexexchanges) | **GET** /forex/exchange | Forex Exchanges
+*DefaultApi* | [**forexRates**](docs/Api/DefaultApi.md#forexrates) | **GET** /forex/rates | Forex rates
+*DefaultApi* | [**forexSymbols**](docs/Api/DefaultApi.md#forexsymbols) | **GET** /forex/symbol | Forex Symbol
+*DefaultApi* | [**fundOwnership**](docs/Api/DefaultApi.md#fundownership) | **GET** /stock/fund-ownership | Fund Ownership
+*DefaultApi* | [**generalNews**](docs/Api/DefaultApi.md#generalnews) | **GET** /news | General News
+*DefaultApi* | [**investorsOwnership**](docs/Api/DefaultApi.md#investorsownership) | **GET** /stock/investor-ownership | Investors Ownership
+*DefaultApi* | [**ipoCalendar**](docs/Api/DefaultApi.md#ipocalendar) | **GET** /calendar/ipo | IPO Calendar
+*DefaultApi* | [**majorDevelopments**](docs/Api/DefaultApi.md#majordevelopments) | **GET** /major-development | Major Developments
+*DefaultApi* | [**newsSentiment**](docs/Api/DefaultApi.md#newssentiment) | **GET** /news-sentiment | News Sentiment
+*DefaultApi* | [**patternRecognition**](docs/Api/DefaultApi.md#patternrecognition) | **GET** /scan/pattern | Pattern Recognition
+*DefaultApi* | [**priceTarget**](docs/Api/DefaultApi.md#pricetarget) | **GET** /stock/price-target | Price Target
+*DefaultApi* | [**quote**](docs/Api/DefaultApi.md#quote) | **GET** /quote | Quote
+*DefaultApi* | [**recommendationTrends**](docs/Api/DefaultApi.md#recommendationtrends) | **GET** /stock/recommendation | Recommendation Trends
+*DefaultApi* | [**stockBidask**](docs/Api/DefaultApi.md#stockbidask) | **GET** /stock/bidask | Last Bid-Ask
+*DefaultApi* | [**stockCandles**](docs/Api/DefaultApi.md#stockcandles) | **GET** /stock/candle | Stock Candles
+*DefaultApi* | [**stockDividends**](docs/Api/DefaultApi.md#stockdividends) | **GET** /stock/dividend | Dividends
+*DefaultApi* | [**stockSplits**](docs/Api/DefaultApi.md#stocksplits) | **GET** /stock/split | Splits
+*DefaultApi* | [**stockSymbols**](docs/Api/DefaultApi.md#stocksymbols) | **GET** /stock/symbol | Stock Symbol
+*DefaultApi* | [**stockTick**](docs/Api/DefaultApi.md#stocktick) | **GET** /stock/tick | Tick Data
+*DefaultApi* | [**supportResistance**](docs/Api/DefaultApi.md#supportresistance) | **GET** /scan/support-resistance | Support/Resistance
+*DefaultApi* | [**technicalIndicator**](docs/Api/DefaultApi.md#technicalindicator) | **POST** /indicator | Technical Indicators
+*DefaultApi* | [**transcripts**](docs/Api/DefaultApi.md#transcripts) | **GET** /stock/transcripts | Earnings Call Transcripts
+*DefaultApi* | [**transcriptsList**](docs/Api/DefaultApi.md#transcriptslist) | **GET** /stock/transcripts/list | Earnings Call Transcripts List
+*DefaultApi* | [**upgradeDowngrade**](docs/Api/DefaultApi.md#upgradedowngrade) | **GET** /stock/upgrade-downgrade | Stock Upgrade/Downgrade
+
+
+## Documentation For Models
+
+ - [AggregateIndicators](docs/Model/AggregateIndicators.md)
+ - [BasicFinancials](docs/Model/BasicFinancials.md)
+ - [Company](docs/Model/Company.md)
+ - [CompanyExecutive](docs/Model/CompanyExecutive.md)
+ - [CompanyNewsStatistics](docs/Model/CompanyNewsStatistics.md)
+ - [CompanyProfile](docs/Model/CompanyProfile.md)
+ - [CompanyProfile2](docs/Model/CompanyProfile2.md)
+ - [CountryMetadata](docs/Model/CountryMetadata.md)
+ - [CovidInfo](docs/Model/CovidInfo.md)
+ - [CryptoCandles](docs/Model/CryptoCandles.md)
+ - [CryptoSymbol](docs/Model/CryptoSymbol.md)
+ - [Development](docs/Model/Development.md)
+ - [Dividends](docs/Model/Dividends.md)
+ - [EarningEstimate](docs/Model/EarningEstimate.md)
+ - [EarningRelease](docs/Model/EarningRelease.md)
+ - [EarningResult](docs/Model/EarningResult.md)
+ - [EarningsCalendar](docs/Model/EarningsCalendar.md)
+ - [EarningsCallTranscripts](docs/Model/EarningsCallTranscripts.md)
+ - [EarningsCallTranscriptsList](docs/Model/EarningsCallTranscriptsList.md)
+ - [EarningsEstimates](docs/Model/EarningsEstimates.md)
+ - [EconomicCalendar](docs/Model/EconomicCalendar.md)
+ - [EconomicCode](docs/Model/EconomicCode.md)
+ - [EconomicData](docs/Model/EconomicData.md)
+ - [EconomicEvent](docs/Model/EconomicEvent.md)
+ - [Estimate](docs/Model/Estimate.md)
+ - [Filing](docs/Model/Filing.md)
+ - [FinancialStatements](docs/Model/FinancialStatements.md)
+ - [FinancialsAsReported](docs/Model/FinancialsAsReported.md)
+ - [ForexCandles](docs/Model/ForexCandles.md)
+ - [ForexSymbol](docs/Model/ForexSymbol.md)
+ - [Forexrates](docs/Model/Forexrates.md)
+ - [FundOwnership](docs/Model/FundOwnership.md)
+ - [IPOCalendar](docs/Model/IPOCalendar.md)
+ - [IPOEvent](docs/Model/IPOEvent.md)
+ - [Indicator](docs/Model/Indicator.md)
+ - [Investor](docs/Model/Investor.md)
+ - [InvestorsOwnership](docs/Model/InvestorsOwnership.md)
+ - [LastBidAsk](docs/Model/LastBidAsk.md)
+ - [MajorDevelopments](docs/Model/MajorDevelopments.md)
+ - [News](docs/Model/News.md)
+ - [NewsSentiment](docs/Model/NewsSentiment.md)
+ - [PatternRecognition](docs/Model/PatternRecognition.md)
+ - [PriceTarget](docs/Model/PriceTarget.md)
+ - [Quote](docs/Model/Quote.md)
+ - [RecommendationTrend](docs/Model/RecommendationTrend.md)
+ - [Report](docs/Model/Report.md)
+ - [RevenueEstimates](docs/Model/RevenueEstimates.md)
+ - [Sentiment](docs/Model/Sentiment.md)
+ - [Split](docs/Model/Split.md)
+ - [Stock](docs/Model/Stock.md)
+ - [StockCandles](docs/Model/StockCandles.md)
+ - [StockTranscripts](docs/Model/StockTranscripts.md)
+ - [SupportResistance](docs/Model/SupportResistance.md)
+ - [TechnicalAnalysis](docs/Model/TechnicalAnalysis.md)
+ - [TickData](docs/Model/TickData.md)
+ - [TranscriptContent](docs/Model/TranscriptContent.md)
+ - [TranscriptParticipant](docs/Model/TranscriptParticipant.md)
+ - [Trend](docs/Model/Trend.md)
+ - [UpgradeDowngrade](docs/Model/UpgradeDowngrade.md)
+
+
+## Documentation For Authorization
+
+
+
+## api_key
+
+
+- **Type**: API key
+- **API key parameter name**: token
+- **Location**: URL query string
+
+
+
+## Author
+
+
+
diff --git a/composer.json b/composer.json
@@ -0,0 +1,40 @@
+{
+    "name": "GIT_USER_ID/GIT_REPO_ID",
+    "version": "1.0.0",
+    "description": "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)",
+    "keywords": [
+        "openapitools",
+        "openapi-generator",
+        "openapi",
+        "php",
+        "sdk",
+        "rest",
+        "api"
+    ],
+    "homepage": "https://openapi-generator.tech",
+    "license": "unlicense",
+    "authors": [
+        {
+            "name": "OpenAPI-Generator contributors",
+            "homepage": "https://openapi-generator.tech"
+        }
+    ],
+    "require": {
+        "php": ">=7.1",
+        "ext-curl": "*",
+        "ext-json": "*",
+        "ext-mbstring": "*",
+        "guzzlehttp/guzzle": "^6.2"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.4",
+        "squizlabs/php_codesniffer": "~2.6",
+        "friendsofphp/php-cs-fixer": "~2.12"
+    },
+    "autoload": {
+        "psr-4": { "Finnhub\\" : "lib/" }
+    },
+    "autoload-dev": {
+        "psr-4": { "Finnhub\\" : "test/" }
+    }
+}