├── docs └── Model │ ├── Date.md │ ├── AskExchangeId.md │ ├── BidExchangeId.md │ ├── StocksV2NBBOAllOfX.md │ ├── ListNewsPublishedUtcParameter.md │ ├── Map.md │ ├── RequestIdBase.md │ ├── StatusBase.md │ ├── TickerBase.md │ ├── V2TicksStocksNbboTickerDateGet200ResponseAllOfResultsInnerAllOfX.md │ ├── Locales.md │ ├── GetEvents200ResponseResultsEventsInnerOneOfTickerChange.md │ ├── Markets.md │ ├── PaginationHooksBase.md │ ├── V2LastBase.md │ ├── IndicesTickerResults.md │ ├── MapKey.md │ ├── LocalesResultsInner.md │ ├── MarketsResultsInner.md │ ├── TradeDetailsMapItem.md │ ├── MarketStatusCurrencies.md │ ├── StatusCountBase.md │ ├── StocksV2NBBOs.md │ ├── CryptoLastTrade.md │ ├── StocksV2Trades.md │ ├── GetMarketStatus200ResponseCurrencies.md │ ├── ListConditions200ResponseResultsInnerSipMapping.md │ ├── ForexPairLastQuote.md │ ├── IndicesGroupedResults.md │ ├── GetEvents200ResponseResults.md │ ├── ForexSnapshotTicker.md │ ├── StocksGroupedResults.md │ ├── StocksSnapshotTicker.md │ ├── CryptoGroupedResults.md │ ├── CryptoSnapshotTicker.md │ ├── ForexGroupedResults.md │ ├── ForexPreviousClose.md │ ├── ForexSnapshotTickers.md │ ├── StocksSnapshotTickers.md │ ├── V1LastBase.md │ ├── CryptoSnapshotTickers.md │ ├── StandardBase.md │ ├── MarketStatusExchanges.md │ ├── TickerResults.md │ ├── CryptoEMA200ResponseResultsValuesInner.md │ ├── CryptoSnapshotTickerFullBook.md │ ├── ForexSnapshotLastQuote.md │ ├── ForexTickerResults.md │ ├── ListExchanges400Response.md │ ├── StocksTickerResultsOTC.md │ ├── GetMarketStatus200ResponseExchanges.md │ ├── ListFinancials200ResponseResultsInnerFinancialsBalanceSheet.md │ ├── GetOptionsContract200Response.md │ ├── LastQuote200Response.md │ ├── SnapshotSummary200Response.md │ ├── ListFilings200Response.md │ ├── GetEvents200Response.md │ ├── ListFilings200ResponseResultsInnerEntitiesInnerCompanyData.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoDirectionGet200Response.md │ ├── ListFilingFiles200Response.md │ ├── LastTradeOptions200Response.md │ ├── CryptoEMA200ResponseResults.md │ ├── CryptoMACD200ResponseResults.md │ ├── CryptoRSI200ResponseResults.md │ ├── CryptoSMA200ResponseResults.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200Response.md │ ├── Quotes200Response.md │ ├── Trades200Response.md │ ├── QuotesFx200Response.md │ ├── ConditionTypeMap.md │ ├── ListFilings200ResponseResultsInnerEntitiesInner.md │ ├── IndexAggsBase.md │ ├── ListNews200ResponseResultsInnerPublisher.md │ ├── CryptoEMA200ResponseResultsUnderlying.md │ ├── QuotesOptions200Response.md │ ├── TradesCrypto200Response.md │ ├── TradesOptions200Response.md │ ├── ListDividends200Response.md │ ├── StocksSnapshotLastQuote.md │ ├── V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerLastQuote.md │ ├── V2SnapshotLocaleUsMarketsStocksDirectionGet200Response.md │ ├── ForexConversion.md │ ├── GetEvents200ResponseResultsEventsInner.md │ ├── Snapshots200Response.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersGet200Response.md │ ├── V2SnapshotLocaleGlobalMarketsForexTickersGet200Response.md │ ├── GetEvents200ResponseResultsEventsInnerOneOf.md │ ├── LastTradeCrypto200Response.md │ ├── OptionsChain200Response.md │ ├── ListTickerTypes200ResponseResultsInner.md │ ├── OptionContract200Response.md │ ├── V2TicksBase.md │ ├── GetTicker200Response.md │ ├── IndicesSnapshot200Response.md │ ├── ListExchanges200Response.md │ ├── ListOptionsContracts200Response.md │ ├── ListConditions200ResponseResultsInnerUpdateRulesConsolidated.md │ ├── ListConditions200ResponseResultsInnerUpdateRulesMarketCenter.md │ ├── ListTickerTypes200Response.md │ ├── CryptoMACD200ResponseResultsValuesInner.md │ ├── LastQuoteCurrencies200Response.md │ ├── CryptoEMA200Response.md │ ├── CryptoRSI200Response.md │ ├── CryptoSMA200Response.md │ ├── ListStockSplits200Response.md │ ├── SnapshotOHLCV.md │ ├── V2AggsBase.md │ ├── CryptoMACD200Response.md │ ├── ListTickerTaxonomyClassifications200Response.md │ ├── ForexConversionLast.md │ ├── ListConditions200ResponseResultsInnerUpdateRules.md │ ├── GetTicker200ResponseResultsAddress.md │ ├── QuotesFx200ResponseResultsInner.md │ ├── V2SnapshotLocaleUsMarketsStocksTickersGet200Response.md │ ├── RatingSection.md │ ├── RealTimeCurrencyConversion200ResponseLast.md │ ├── Snapshots200ResponseResultsInnerGreeks.md │ ├── V2SnapshotLocaleGlobalMarketsForexTickersTickerGet200Response.md │ ├── V2SnapshotLocaleUsMarketsStocksTickersStocksTickerGet200Response.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersTickerGet200Response.md │ ├── ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner.md │ ├── V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerLastQuote.md │ ├── V1HistoricForexFromToDateGet200ResponseAllOfTicksInner.md │ ├── ForexHistoricTrades.md │ ├── SnapshotOHLCVVW.md │ ├── CryptoHistoricTrades.md │ ├── ListFinancials200Response.md │ ├── CryptoExchangeInner.md │ ├── ForexSnapshotPrevDay.md │ ├── ListNews200Response.md │ ├── ListStockSplits200ResponseResultsInner.md │ ├── V2AggsTickerIndicesTickerPrevGet200ResponseAllOfResultsInner.md │ ├── MarketHolidayInner.md │ ├── V1HistoricCryptoFromToDateGet200Response.md │ ├── ListConditions200Response.md │ ├── ListConditions400Response.md │ ├── GetMarketHolidays200ResponseInner.md │ ├── V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerDay.md │ ├── IndicesTickerResultsResultsInner.md │ ├── ListTickerTaxonomyClassifications200ResponseResultsInner.md │ ├── ListFilingFiles200ResponseResultsInner.md │ ├── MarketStatus.md │ ├── V1HistoricForexFromToDateGet200Response.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerDay.md │ ├── GetTicker200ResponseResultsBranding.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerPrevDay.md │ ├── SnapshotOHLCVVWOtc.md │ ├── V2TicksStocksNbboTickerDateGet200Response.md │ ├── SnapshotSummary200ResponseResultsInnerBranding.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfDataAsksInner.md │ ├── V2TicksStocksTradesTickerDateGet200Response.md │ ├── CryptoSnapshotMinute.md │ ├── SnapshotMinOHLCV.md │ ├── ListTickers200Response.md │ ├── V2AggsTickerIndicesTickerPrevGet200Response.md │ ├── CryptoLastTradeLast.md │ ├── LastTradeCrypto200ResponseLast.md │ ├── RealTimeCurrencyConversion200Response.md │ ├── NewsInner.md │ ├── V2AggsGroupedLocaleUsMarketStocksDateGet200Response.md │ ├── StocksSnapshotMinute.md │ ├── Snapshots200ResponseResultsInnerUnderlyingAsset.md │ ├── V2AggsGroupedLocaleGlobalMarketCryptoDateGet200Response.md │ ├── V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerDay.md │ ├── IndicesSnapshot200ResponseResultsInnerSession.md │ ├── V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerPrevDay.md │ ├── CryptoOpenClose.md │ ├── Snapshots200ResponseResultsInnerDetails.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerMin.md │ ├── IndicesOpenClose.md │ ├── V2AggsTickerCryptoTickerPrevGet200Response.md │ ├── V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerMin.md │ ├── StocksV2Base.md │ ├── V1OpenCloseCryptoFromToDateGet200Response.md │ ├── TradesCrypto200ResponseResultsInner.md │ ├── V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md │ ├── OptionsChain200ResponseResultsInnerDetails.md │ ├── V1OpenCloseIndicesTickerDateGet200Response.md │ ├── StocksSnapshotMinuteOTC.md │ ├── SnapshotSummary200ResponseResultsInnerOptions.md │ ├── V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200Response.md │ ├── CryptoEMA200ResponseResultsUnderlyingAggregatesInner.md │ ├── GetMarketStatus200Response.md │ ├── V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner.md │ ├── IndicesSnapshot200ResponseResultsInner.md │ ├── CryptoTick.md │ ├── OptionsChain200ResponseResultsInnerLastTrade.md │ ├── ExchangeInner.md │ ├── ListExchanges200ResponseResultsInner.md │ ├── V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md │ ├── V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerMin.md │ ├── ListFilings200ResponseResultsInner.md │ ├── OptionsChain200ResponseResultsInnerDay.md │ ├── V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200Response.md │ ├── ListNews200ResponseResultsInner.md │ ├── V2AggsGroupedLocaleUsMarketStocksDateGet200ResponseAllOfResultsInner.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfData.md │ ├── V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner.md │ ├── StocksOpenClose.md │ ├── OptionsChain200ResponseResultsInnerLastQuote.md │ ├── V1OpenCloseOptionsTickerDateGet200Response.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerLastTrade.md │ ├── TradesOptions200ResponseResultsInner.md │ ├── V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerLastTrade.md │ ├── Financial.md │ ├── SnapshotSummary200ResponseResultsInner.md │ ├── QuotesOptions200ResponseResultsInner.md │ ├── GetMarketStatus200ResponseIndicesGroups.md │ ├── ListDividends200ResponseResultsInner.md │ ├── ListConditions200ResponseResultsInner.md │ ├── Snapshots200ResponseResultsInnerLastQuote.md │ ├── Snapshots200ResponseResultsInnerLastTrade.md │ ├── ListFinancials200ResponseResultsInnerFinancials.md │ ├── SnapshotSummary200ResponseResultsInnerSession.md │ ├── ListTickers200ResponseResultsInner.md │ ├── V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner.md │ ├── V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner.md │ └── ListFinancials200ResponseResultsInner.md ├── .gitignore ├── phpunit.xml.dist ├── LICENSE ├── composer.json ├── .github └── workflows │ └── php.yml └── test ├── Model ├── DateTest.php ├── AskExchangeIdTest.php ├── BidExchangeIdTest.php ├── StocksV2NBBOAllOfXTest.php └── ListNewsPublishedUtcParameterTest.php └── Api ├── FxquotesApiTest.php └── ReferencenewsApiTest.php /docs/Model/Date.md: -------------------------------------------------------------------------------- 1 | # # Date 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/AskExchangeId.md: -------------------------------------------------------------------------------- 1 | # # AskExchangeId 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/BidExchangeId.md: -------------------------------------------------------------------------------- 1 | # # BidExchangeId 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/StocksV2NBBOAllOfX.md: -------------------------------------------------------------------------------- 1 | # # StocksV2NBBOAllOfX 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/ListNewsPublishedUtcParameter.md: -------------------------------------------------------------------------------- 1 | # # ListNewsPublishedUtcParameter 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/Map.md: -------------------------------------------------------------------------------- 1 | # # Map 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **key** | [**\OpenAPI\Client\Model\MapKey**](MapKey.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/RequestIdBase.md: -------------------------------------------------------------------------------- 1 | # # RequestIdBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | A request id assigned by the server. | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/StatusBase.md: -------------------------------------------------------------------------------- 1 | # # StatusBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **string** | The status of this request's response. | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/TickerBase.md: -------------------------------------------------------------------------------- 1 | # # TickerBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | **string** | The exchange symbol that this item is traded under. | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/V2TicksStocksNbboTickerDateGet200ResponseAllOfResultsInnerAllOfX.md: -------------------------------------------------------------------------------- 1 | # # V2TicksStocksNbboTickerDateGet200ResponseAllOfResultsInnerAllOfX 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/Locales.md: -------------------------------------------------------------------------------- 1 | # # Locales 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\LocalesResultsInner[]**](LocalesResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/GetEvents200ResponseResultsEventsInnerOneOfTickerChange.md: -------------------------------------------------------------------------------- 1 | # # GetEvents200ResponseResultsEventsInnerOneOfTickerChange 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/Markets.md: -------------------------------------------------------------------------------- 1 | # # Markets 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\MarketsResultsInner[]**](MarketsResultsInner.md) | A list of supported markets. | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/PaginationHooksBase.md: -------------------------------------------------------------------------------- 1 | # # PaginationHooksBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/V2LastBase.md: -------------------------------------------------------------------------------- 1 | # # V2LastBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | A request id assigned by the server. | 8 | **status** | **string** | The status of this request's response. | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/IndicesTickerResults.md: -------------------------------------------------------------------------------- 1 | # # IndicesTickerResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\IndicesTickerResultsResultsInner[]**](IndicesTickerResultsResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/MapKey.md: -------------------------------------------------------------------------------- 1 | # # MapKey 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | The descriptive name of this results key | [optional] 8 | **type** | **string** | The data type of this results key | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/LocalesResultsInner.md: -------------------------------------------------------------------------------- 1 | # # LocalesResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **locale** | **string** | An abbreviated country name. | [optional] 8 | **name** | **string** | The name of the country. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/MarketsResultsInner.md: -------------------------------------------------------------------------------- 1 | # # MarketsResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **desc** | **string** | A description of the market. | [optional] 8 | **market** | **string** | The name of the market. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/TradeDetailsMapItem.md: -------------------------------------------------------------------------------- 1 | # # TradeDetailsMapItem 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | Name of the trade detail item | [optional] 8 | **type** | **string** | Actual type of the trade detail item | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/MarketStatusCurrencies.md: -------------------------------------------------------------------------------- 1 | # # MarketStatusCurrencies 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **crypto** | **string** | The status of the crypto market. | [optional] 8 | **fx** | **string** | The status of the forex market. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/StatusCountBase.md: -------------------------------------------------------------------------------- 1 | # # StatusCountBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | [optional] 8 | **status** | **string** | The status of this request's response. | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/StocksV2NBBOs.md: -------------------------------------------------------------------------------- 1 | # # StocksV2NBBOs 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2TicksStocksNbboTickerDateGet200ResponseAllOfResultsInner[]**](V2TicksStocksNbboTickerDateGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CryptoLastTrade.md: -------------------------------------------------------------------------------- 1 | # # CryptoLastTrade 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **last** | [**\OpenAPI\Client\Model\CryptoLastTradeLast**](CryptoLastTradeLast.md) | | [optional] 8 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/StocksV2Trades.md: -------------------------------------------------------------------------------- 1 | # # StocksV2Trades 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2TicksStocksTradesTickerDateGet200ResponseAllOfResultsInner[]**](V2TicksStocksTradesTickerDateGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/GetMarketStatus200ResponseCurrencies.md: -------------------------------------------------------------------------------- 1 | # # GetMarketStatus200ResponseCurrencies 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **crypto** | **string** | The status of the crypto market. | [optional] 8 | **fx** | **string** | The status of the forex market. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/ListConditions200ResponseResultsInnerSipMapping.md: -------------------------------------------------------------------------------- 1 | # # ListConditions200ResponseResultsInnerSipMapping 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **cta** | **string** | | [optional] 8 | **opra** | **string** | | [optional] 9 | **utp** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ref: https://github.com/github/gitignore/blob/master/Composer.gitignore 2 | 3 | composer.phar 4 | /vendor/ 5 | 6 | # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control 7 | # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file 8 | # composer.lock 9 | 10 | # php-cs-fixer cache 11 | .php_cs.cache 12 | .php-cs-fixer.cache 13 | 14 | # PHPUnit cache 15 | .phpunit.result.cache 16 | -------------------------------------------------------------------------------- /docs/Model/ForexPairLastQuote.md: -------------------------------------------------------------------------------- 1 | # # ForexPairLastQuote 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **last** | [**\OpenAPI\Client\Model\ForexConversionLast**](ForexConversionLast.md) | | [optional] 8 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/IndicesGroupedResults.md: -------------------------------------------------------------------------------- 1 | # # IndicesGroupedResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2AggsTickerIndicesTickerPrevGet200ResponseAllOfResultsInner[]**](V2AggsTickerIndicesTickerPrevGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/GetEvents200ResponseResults.md: -------------------------------------------------------------------------------- 1 | # # GetEvents200ResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **events** | [**\OpenAPI\Client\Model\GetEvents200ResponseResultsEventsInner[]**](GetEvents200ResponseResultsEventsInner.md) | | [optional] 8 | **name** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/ForexSnapshotTicker.md: -------------------------------------------------------------------------------- 1 | # # ForexSnapshotTicker 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner**](V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/StocksGroupedResults.md: -------------------------------------------------------------------------------- 1 | # # StocksGroupedResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2AggsGroupedLocaleUsMarketStocksDateGet200ResponseAllOfResultsInner[]**](V2AggsGroupedLocaleUsMarketStocksDateGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/StocksSnapshotTicker.md: -------------------------------------------------------------------------------- 1 | # # StocksSnapshotTicker 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | [**\OpenAPI\Client\Model\V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner**](V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CryptoGroupedResults.md: -------------------------------------------------------------------------------- 1 | # # CryptoGroupedResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner[]**](V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CryptoSnapshotTicker.md: -------------------------------------------------------------------------------- 1 | # # CryptoSnapshotTicker 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/ForexGroupedResults.md: -------------------------------------------------------------------------------- 1 | # # ForexGroupedResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner[]**](V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/ForexPreviousClose.md: -------------------------------------------------------------------------------- 1 | # # ForexPreviousClose 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner[]**](V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/ForexSnapshotTickers.md: -------------------------------------------------------------------------------- 1 | # # ForexSnapshotTickers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **tickers** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner[]**](V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/StocksSnapshotTickers.md: -------------------------------------------------------------------------------- 1 | # # StocksSnapshotTickers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **tickers** | [**\OpenAPI\Client\Model\V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner[]**](V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/V1LastBase.md: -------------------------------------------------------------------------------- 1 | # # V1LastBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | A request id assigned by the server. | 8 | **status** | **string** | The status of this request's response. | 9 | **symbol** | **string** | The exchange symbol that this item is traded under. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/CryptoSnapshotTickers.md: -------------------------------------------------------------------------------- 1 | # # CryptoSnapshotTickers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **tickers** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner[]**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/StandardBase.md: -------------------------------------------------------------------------------- 1 | # # StandardBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | A request id assigned by the server. | 8 | **count** | **int** | The total number of results for this request. | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/MarketStatusExchanges.md: -------------------------------------------------------------------------------- 1 | # # MarketStatusExchanges 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **nasdaq** | **string** | The status of the Nasdaq market. | [optional] 8 | **nyse** | **string** | The status of the NYSE market. | [optional] 9 | **otc** | **string** | The status of the OTC market. | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/TickerResults.md: -------------------------------------------------------------------------------- 1 | # # TickerResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner[]**](V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CryptoEMA200ResponseResultsValuesInner.md: -------------------------------------------------------------------------------- 1 | # # CryptoEMA200ResponseResultsValuesInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **timestamp** | **int** | The Unix Msec timestamp from the last aggregate used in this calculation. | [optional] 8 | **value** | **float** | The indicator value for this period. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/CryptoSnapshotTickerFullBook.md: -------------------------------------------------------------------------------- 1 | # # CryptoSnapshotTickerFullBook 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfData**](V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfData.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/ForexSnapshotLastQuote.md: -------------------------------------------------------------------------------- 1 | # # ForexSnapshotLastQuote 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **a** | **float** | The ask price. | 8 | **b** | **float** | The bid price. | 9 | **t** | **int** | The millisecond accuracy timestamp of the quote. | 10 | **x** | **int** | The exchange ID on which this quote happened. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ForexTickerResults.md: -------------------------------------------------------------------------------- 1 | # # ForexTickerResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner[]**](V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/ListExchanges400Response.md: -------------------------------------------------------------------------------- 1 | # # ListExchanges400Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | [optional] 8 | **request_id** | **string** | A request ID assigned by the server. | 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/StocksTickerResultsOTC.md: -------------------------------------------------------------------------------- 1 | # # StocksTickerResultsOTC 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\OpenAPI\Client\Model\V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner[]**](V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/GetMarketStatus200ResponseExchanges.md: -------------------------------------------------------------------------------- 1 | # # GetMarketStatus200ResponseExchanges 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **nasdaq** | **string** | The status of the Nasdaq market. | [optional] 8 | **nyse** | **string** | The status of the NYSE market. | [optional] 9 | **otc** | **string** | The status of the OTC market. | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ListFinancials200ResponseResultsInnerFinancialsBalanceSheet.md: -------------------------------------------------------------------------------- 1 | # # ListFinancials200ResponseResultsInnerFinancialsBalanceSheet 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **** | [**\OpenAPI\Client\Model\ListFinancials200ResponseResultsInnerFinancialsBalanceSheet**](ListFinancials200ResponseResultsInnerFinancialsBalanceSheet.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/GetOptionsContract200Response.md: -------------------------------------------------------------------------------- 1 | # # GetOptionsContract200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | | [optional] 8 | **results** | [**\OpenAPI\Client\Model\ListOptionsContracts200ResponseResultsInner**](ListOptionsContracts200ResponseResultsInner.md) | | [optional] 9 | **status** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/LastQuote200Response.md: -------------------------------------------------------------------------------- 1 | # # LastQuote200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | A request id assigned by the server. | 8 | **results** | [**\OpenAPI\Client\Model\LastQuote200ResponseResults**](LastQuote200ResponseResults.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/SnapshotSummary200Response.md: -------------------------------------------------------------------------------- 1 | # # SnapshotSummary200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | | 8 | **results** | [**\OpenAPI\Client\Model\SnapshotSummary200ResponseResultsInner[]**](SnapshotSummary200ResponseResultsInner.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ListFilings200Response.md: -------------------------------------------------------------------------------- 1 | # # ListFilings200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | | 8 | **next_url** | **string** | | [optional] 9 | **request_id** | **string** | | 10 | **results** | [**\OpenAPI\Client\Model\ListFilings200ResponseResultsInner[]**](ListFilings200ResponseResultsInner.md) | | 11 | **status** | **string** | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetEvents200Response.md: -------------------------------------------------------------------------------- 1 | # # GetEvents200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | A request id assigned by the server. | [optional] 8 | **results** | [**\OpenAPI\Client\Model\GetEvents200ResponseResults**](GetEvents200ResponseResults.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ListFilings200ResponseResultsInnerEntitiesInnerCompanyData.md: -------------------------------------------------------------------------------- 1 | # # ListFilings200ResponseResultsInnerEntitiesInnerCompanyData 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **cik** | **string** | Central Index Key (CIK) Number | 8 | **name** | **string** | | 9 | **sic** | **string** | Standard Industrial Classification (SIC) | 10 | **ticker** | **string** | Ticker | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoDirectionGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoDirectionGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **tickers** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner[]**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/ListFilingFiles200Response.md: -------------------------------------------------------------------------------- 1 | # # ListFilingFiles200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | | 8 | **next_url** | **string** | | [optional] 9 | **request_id** | **string** | | 10 | **results** | [**\OpenAPI\Client\Model\ListFilingFiles200ResponseResultsInner[]**](ListFilingFiles200ResponseResultsInner.md) | | 11 | **status** | **string** | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/LastTradeOptions200Response.md: -------------------------------------------------------------------------------- 1 | # # LastTradeOptions200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **request_id** | **string** | A request id assigned by the server. | 8 | **results** | [**\OpenAPI\Client\Model\LastTradeOptions200ResponseResults**](LastTradeOptions200ResponseResults.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/CryptoEMA200ResponseResults.md: -------------------------------------------------------------------------------- 1 | # # CryptoEMA200ResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **underlying** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResultsUnderlying**](CryptoEMA200ResponseResultsUnderlying.md) | | [optional] 8 | **values** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResultsValuesInner[]**](CryptoEMA200ResponseResultsValuesInner.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/CryptoMACD200ResponseResults.md: -------------------------------------------------------------------------------- 1 | # # CryptoMACD200ResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **underlying** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResultsUnderlying**](CryptoEMA200ResponseResultsUnderlying.md) | | [optional] 8 | **values** | [**\OpenAPI\Client\Model\CryptoMACD200ResponseResultsValuesInner[]**](CryptoMACD200ResponseResultsValuesInner.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/CryptoRSI200ResponseResults.md: -------------------------------------------------------------------------------- 1 | # # CryptoRSI200ResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **underlying** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResultsUnderlying**](CryptoEMA200ResponseResultsUnderlying.md) | | [optional] 8 | **values** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResultsValuesInner[]**](CryptoEMA200ResponseResultsValuesInner.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/CryptoSMA200ResponseResults.md: -------------------------------------------------------------------------------- 1 | # # CryptoSMA200ResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **underlying** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResultsUnderlying**](CryptoEMA200ResponseResultsUnderlying.md) | | [optional] 8 | **values** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResultsValuesInner[]**](CryptoEMA200ResponseResultsValuesInner.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfData**](V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfData.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/Quotes200Response.md: -------------------------------------------------------------------------------- 1 | # # Quotes200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **results** | [**\OpenAPI\Client\Model\Quotes200ResponseResultsInner[]**](Quotes200ResponseResultsInner.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/Trades200Response.md: -------------------------------------------------------------------------------- 1 | # # Trades200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **results** | [**\OpenAPI\Client\Model\Trades200ResponseResultsInner[]**](Trades200ResponseResultsInner.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/QuotesFx200Response.md: -------------------------------------------------------------------------------- 1 | # # QuotesFx200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **results** | [**\OpenAPI\Client\Model\QuotesFx200ResponseResultsInner[]**](QuotesFx200ResponseResultsInner.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ConditionTypeMap.md: -------------------------------------------------------------------------------- 1 | # # ConditionTypeMap 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **condition** | **string** | Polygon.io's mapping for condition codes. For more information, see our <a href=\"https://polygon.io/glossary/us/stocks/trade-conditions\" alt=\"Trade Conditions Glossary\" target=\"_blank\">Trade Conditions Glossary</a>. | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/ListFilings200ResponseResultsInnerEntitiesInner.md: -------------------------------------------------------------------------------- 1 | # # ListFilings200ResponseResultsInnerEntitiesInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **company_data** | [**\OpenAPI\Client\Model\ListFilings200ResponseResultsInnerEntitiesInnerCompanyData**](ListFilings200ResponseResultsInnerEntitiesInnerCompanyData.md) | | [optional] 8 | **relation** | **string** | Relationship of this entity to the filing. | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/IndexAggsBase.md: -------------------------------------------------------------------------------- 1 | # # IndexAggsBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **query_count** | **int** | The number of aggregates (minute or day) used to generate the response. | 8 | **request_id** | **string** | A request id assigned by the server. | 9 | **results_count** | **int** | The total number of results for this request. | 10 | **status** | **string** | The status of this request's response. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ListNews200ResponseResultsInnerPublisher.md: -------------------------------------------------------------------------------- 1 | # # ListNews200ResponseResultsInnerPublisher 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **favicon_url** | **string** | The publisher's homepage favicon URL. | [optional] 8 | **homepage_url** | **string** | The publisher's homepage URL. | 9 | **logo_url** | **string** | The publisher's logo URL. | 10 | **name** | **string** | The publisher's name. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/CryptoEMA200ResponseResultsUnderlying.md: -------------------------------------------------------------------------------- 1 | # # CryptoEMA200ResponseResultsUnderlying 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **aggregates** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResultsUnderlyingAggregatesInner[]**](CryptoEMA200ResponseResultsUnderlyingAggregatesInner.md) | | [optional] 8 | **url** | **string** | The URL which can be used to request the underlying aggregates used in this request. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/QuotesOptions200Response.md: -------------------------------------------------------------------------------- 1 | # # QuotesOptions200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **results** | [**\OpenAPI\Client\Model\QuotesOptions200ResponseResultsInner[]**](QuotesOptions200ResponseResultsInner.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/TradesCrypto200Response.md: -------------------------------------------------------------------------------- 1 | # # TradesCrypto200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **results** | [**\OpenAPI\Client\Model\TradesCrypto200ResponseResultsInner[]**](TradesCrypto200ResponseResultsInner.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/TradesOptions200Response.md: -------------------------------------------------------------------------------- 1 | # # TradesOptions200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **results** | [**\OpenAPI\Client\Model\TradesOptions200ResponseResultsInner[]**](TradesOptions200ResponseResultsInner.md) | | [optional] 9 | **status** | **string** | The status of this request's response. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ListDividends200Response.md: -------------------------------------------------------------------------------- 1 | # # ListDividends200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | | 9 | **results** | [**\OpenAPI\Client\Model\ListDividends200ResponseResultsInner[]**](ListDividends200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/StocksSnapshotLastQuote.md: -------------------------------------------------------------------------------- 1 | # # StocksSnapshotLastQuote 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **p** | **float** | The ask price. | 8 | **s** | **int** | The ask size in lots. | 9 | **p** | **float** | The bid price. | 10 | **s** | **int** | The bid size in lots. | 11 | **t** | **int** | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerLastQuote.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerLastQuote 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **a** | **float** | The ask price. | 8 | **b** | **float** | The bid price. | 9 | **t** | **int** | The millisecond accuracy timestamp of the quote. | 10 | **x** | **int** | The exchange ID on which this quote happened. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleUsMarketsStocksDirectionGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleUsMarketsStocksDirectionGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **string** | The status of this request's response. | 8 | **tickers** | [**\OpenAPI\Client\Model\V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner[]**](V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/ForexConversion.md: -------------------------------------------------------------------------------- 1 | # # ForexConversion 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **converted** | **float** | The result of the conversion. | 8 | **from** | **string** | The \"from\" currency symbol. | 9 | **initial_amount** | **float** | The amount to convert. | 10 | **last** | [**\OpenAPI\Client\Model\ForexConversionLast**](ForexConversionLast.md) | | [optional] 11 | **to** | **string** | The \"to\" currency symbol. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetEvents200ResponseResultsEventsInner.md: -------------------------------------------------------------------------------- 1 | # # GetEvents200ResponseResultsEventsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **date** | **\DateTime** | The date the event took place | 8 | **event_type** | **string** | The type of historical event for the asset | 9 | **ticker_change** | [**\OpenAPI\Client\Model\GetEvents200ResponseResultsEventsInnerOneOfTickerChange**](GetEvents200ResponseResultsEventsInnerOneOfTickerChange.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/Snapshots200Response.md: -------------------------------------------------------------------------------- 1 | # # Snapshots200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | | 9 | **results** | [**\OpenAPI\Client\Model\Snapshots200ResponseResultsInner[]**](Snapshots200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **string** | The status of this request's response. | 8 | **tickers** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner[]**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsForexTickersGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsForexTickersGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **string** | The status of this request's response. | 8 | **tickers** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner[]**](V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/GetEvents200ResponseResultsEventsInnerOneOf.md: -------------------------------------------------------------------------------- 1 | # # GetEvents200ResponseResultsEventsInnerOneOf 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **date** | **\DateTime** | The date the event took place | 8 | **event_type** | **string** | The type of historical event for the asset | 9 | **ticker_change** | [**\OpenAPI\Client\Model\GetEvents200ResponseResultsEventsInnerOneOfTickerChange**](GetEvents200ResponseResultsEventsInnerOneOfTickerChange.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/LastTradeCrypto200Response.md: -------------------------------------------------------------------------------- 1 | # # LastTradeCrypto200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **last** | [**\OpenAPI\Client\Model\LastTradeCrypto200ResponseLast**](LastTradeCrypto200ResponseLast.md) | | [optional] 8 | **request_id** | **string** | A request id assigned by the server. | 9 | **status** | **string** | The status of this request's response. | 10 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/OptionsChain200Response.md: -------------------------------------------------------------------------------- 1 | # # OptionsChain200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | | 9 | **results** | [**\OpenAPI\Client\Model\OptionsChain200ResponseResultsInner[]**](OptionsChain200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ListTickerTypes200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListTickerTypes200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **asset_class** | **string** | An identifier for a group of similar financial instruments. | 8 | **code** | **string** | A code used by Polygon.io to refer to this ticker type. | 9 | **description** | **string** | A short description of this ticker type. | 10 | **locale** | **string** | An identifier for a geographical location. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/OptionContract200Response.md: -------------------------------------------------------------------------------- 1 | # # OptionContract200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | | 9 | **results** | [**\OpenAPI\Client\Model\OptionsChain200ResponseResultsInner**](OptionsChain200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/V2TicksBase.md: -------------------------------------------------------------------------------- 1 | # # V2TicksBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **db_latency** | **int** | Latency in milliseconds for the query results from the database. | [optional] 8 | **results_count** | **int** | The total number of results for this request. | [optional] 9 | **success** | **bool** | Whether or not this query was executed successfully. | [optional] 10 | **ticker** | **string** | The exchange symbol that this item is traded under. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/GetTicker200Response.md: -------------------------------------------------------------------------------- 1 | # # GetTicker200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | [optional] 8 | **request_id** | **string** | A request id assigned by the server. | [optional] 9 | **results** | [**\OpenAPI\Client\Model\GetTicker200ResponseResults**](GetTicker200ResponseResults.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/IndicesSnapshot200Response.md: -------------------------------------------------------------------------------- 1 | # # IndicesSnapshot200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | | 9 | **results** | [**\OpenAPI\Client\Model\IndicesSnapshot200ResponseResultsInner[]**](IndicesSnapshot200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ListExchanges200Response.md: -------------------------------------------------------------------------------- 1 | # # ListExchanges200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | [optional] 8 | **request_id** | **string** | A request ID assigned by the server. | 9 | **results** | [**\OpenAPI\Client\Model\ListExchanges200ResponseResultsInner[]**](ListExchanges200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ListOptionsContracts200Response.md: -------------------------------------------------------------------------------- 1 | # # ListOptionsContracts200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | | [optional] 9 | **results** | [**\OpenAPI\Client\Model\ListOptionsContracts200ResponseResultsInner[]**](ListOptionsContracts200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ListConditions200ResponseResultsInnerUpdateRulesConsolidated.md: -------------------------------------------------------------------------------- 1 | # # ListConditions200ResponseResultsInnerUpdateRulesConsolidated 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **updates_high_low** | **bool** | Whether or not trades with this condition update the high/low. | 8 | **updates_open_close** | **bool** | Whether or not trades with this condition update the open/close. | 9 | **updates_volume** | **bool** | Whether or not trades with this condition update the volume. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ListConditions200ResponseResultsInnerUpdateRulesMarketCenter.md: -------------------------------------------------------------------------------- 1 | # # ListConditions200ResponseResultsInnerUpdateRulesMarketCenter 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **updates_high_low** | **bool** | Whether or not trades with this condition update the high/low. | 8 | **updates_open_close** | **bool** | Whether or not trades with this condition update the open/close. | 9 | **updates_volume** | **bool** | Whether or not trades with this condition update the volume. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ListTickerTypes200Response.md: -------------------------------------------------------------------------------- 1 | # # ListTickerTypes200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | [optional] 8 | **request_id** | **string** | A request ID assigned by the server. | 9 | **results** | [**\OpenAPI\Client\Model\ListTickerTypes200ResponseResultsInner[]**](ListTickerTypes200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/CryptoMACD200ResponseResultsValuesInner.md: -------------------------------------------------------------------------------- 1 | # # CryptoMACD200ResponseResultsValuesInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **histogram** | **float** | The indicator value for this period. | [optional] 8 | **signal** | **float** | The indicator value for this period. | [optional] 9 | **timestamp** | **int** | The Unix Msec timestamp from the last aggregate used in this calculation. | [optional] 10 | **value** | **float** | The indicator value for this period. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/LastQuoteCurrencies200Response.md: -------------------------------------------------------------------------------- 1 | # # LastQuoteCurrencies200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **last** | [**\OpenAPI\Client\Model\RealTimeCurrencyConversion200ResponseLast**](RealTimeCurrencyConversion200ResponseLast.md) | | [optional] 8 | **request_id** | **string** | A request id assigned by the server. | 9 | **status** | **string** | The status of this request's response. | 10 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/CryptoEMA200Response.md: -------------------------------------------------------------------------------- 1 | # # CryptoEMA200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | A request id assigned by the server. | [optional] 9 | **results** | [**\OpenAPI\Client\Model\CryptoEMA200ResponseResults**](CryptoEMA200ResponseResults.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/CryptoRSI200Response.md: -------------------------------------------------------------------------------- 1 | # # CryptoRSI200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | A request id assigned by the server. | [optional] 9 | **results** | [**\OpenAPI\Client\Model\CryptoRSI200ResponseResults**](CryptoRSI200ResponseResults.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/CryptoSMA200Response.md: -------------------------------------------------------------------------------- 1 | # # CryptoSMA200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | A request id assigned by the server. | [optional] 9 | **results** | [**\OpenAPI\Client\Model\CryptoSMA200ResponseResults**](CryptoSMA200ResponseResults.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ListStockSplits200Response.md: -------------------------------------------------------------------------------- 1 | # # ListStockSplits200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | | [optional] 9 | **results** | [**\OpenAPI\Client\Model\ListStockSplits200ResponseResultsInner[]**](ListStockSplits200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/SnapshotOHLCV.md: -------------------------------------------------------------------------------- 1 | # # SnapshotOHLCV 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **v** | **float** | The trading volume of the symbol in the given time period. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/V2AggsBase.md: -------------------------------------------------------------------------------- 1 | # # V2AggsBase 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **adjusted** | **bool** | Whether or not this response was adjusted for splits. | 8 | **query_count** | **int** | The number of aggregates (minute or day) used to generate the response. | 9 | **request_id** | **string** | A request id assigned by the server. | 10 | **results_count** | **int** | The total number of results for this request. | 11 | **status** | **string** | The status of this request's response. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/CryptoMACD200Response.md: -------------------------------------------------------------------------------- 1 | # # CryptoMACD200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | A request id assigned by the server. | [optional] 9 | **results** | [**\OpenAPI\Client\Model\CryptoMACD200ResponseResults**](CryptoMACD200ResponseResults.md) | | [optional] 10 | **status** | **string** | The status of this request's response. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ListTickerTaxonomyClassifications200Response.md: -------------------------------------------------------------------------------- 1 | # # ListTickerTaxonomyClassifications200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 8 | **request_id** | **string** | | 9 | **results** | [**\OpenAPI\Client\Model\ListTickerTaxonomyClassifications200ResponseResultsInner[]**](ListTickerTaxonomyClassifications200ResponseResultsInner.md) | | [optional] 10 | **status** | **string** | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ForexConversionLast.md: -------------------------------------------------------------------------------- 1 | # # ForexConversionLast 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ask** | **float** | The ask price. | 8 | **bid** | **float** | The bid price. | 9 | **exchange** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/forex/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | 10 | **timestamp** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ListConditions200ResponseResultsInnerUpdateRules.md: -------------------------------------------------------------------------------- 1 | # # ListConditions200ResponseResultsInnerUpdateRules 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **consolidated** | [**\OpenAPI\Client\Model\ListConditions200ResponseResultsInnerUpdateRulesConsolidated**](ListConditions200ResponseResultsInnerUpdateRulesConsolidated.md) | | 8 | **market_center** | [**\OpenAPI\Client\Model\ListConditions200ResponseResultsInnerUpdateRulesMarketCenter**](ListConditions200ResponseResultsInnerUpdateRulesMarketCenter.md) | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/GetTicker200ResponseResultsAddress.md: -------------------------------------------------------------------------------- 1 | # # GetTicker200ResponseResultsAddress 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address1** | **string** | The first line of the company's headquarters address. | [optional] 8 | **city** | **string** | The city of the company's headquarters address. | [optional] 9 | **postal_code** | **string** | The postal code of the company's headquarters address. | [optional] 10 | **state** | **string** | The state of the company's headquarters address. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/QuotesFx200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # QuotesFx200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ask_exchange** | **int** | The ask exchange ID | [optional] 8 | **ask_price** | **float** | The ask price. | [optional] 9 | **bid_exchange** | **int** | The bid exchange ID | [optional] 10 | **bid_price** | **float** | The bid price. | [optional] 11 | **participant_timestamp** | **int** | The nanosecond Exchange Unix Timestamp. This is the timestamp of when the quote was generated at the exchange. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleUsMarketsStocksTickersGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleUsMarketsStocksTickersGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | [optional] 8 | **status** | **string** | The status of this request's response. | 9 | **tickers** | [**\OpenAPI\Client\Model\V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner[]**](V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/RatingSection.md: -------------------------------------------------------------------------------- 1 | # # RatingSection 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **current** | **float** | Analyst Rating at current month | 8 | **month1** | **float** | Analyst Ratings at 1 month in the future | 9 | **month2** | **float** | Analyst Ratings at 2 month in the future | 10 | **month3** | **float** | Analyst Ratings at 3 month in the future | 11 | **month4** | **float** | Analyst Ratings at 4 month in the future | [optional] 12 | **month5** | **float** | Analyst Ratings at 5 month in the future | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/RealTimeCurrencyConversion200ResponseLast.md: -------------------------------------------------------------------------------- 1 | # # RealTimeCurrencyConversion200ResponseLast 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ask** | **float** | The ask price. | 8 | **bid** | **float** | The bid price. | 9 | **exchange** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/forex/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | 10 | **timestamp** | **int** | The Unix millisecond timestamp. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/Snapshots200ResponseResultsInnerGreeks.md: -------------------------------------------------------------------------------- 1 | # # Snapshots200ResponseResultsInnerGreeks 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **delta** | **float** | The change in the option's price per $0.01 increment in the price of the underlying asset. | 8 | **gamma** | **float** | The change in delta per $0.01 change in the price of the underlying asset. | 9 | **theta** | **float** | The change in the option's price per day. | 10 | **vega** | **float** | The change in the option's price per 1% increment in volatility. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsForexTickersTickerGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsForexTickersTickerGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **string** | The status of this request's response. | 8 | **request_id** | **string** | A request id assigned by the server. | 9 | **ticker** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner**](V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleUsMarketsStocksTickersStocksTickerGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleUsMarketsStocksTickersStocksTickerGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **string** | The status of this request's response. | 8 | **request_id** | **string** | A request id assigned by the server. | 9 | **ticker** | [**\OpenAPI\Client\Model\V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner**](V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInner.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersTickerGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersTickerGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **string** | The status of this request's response. | 8 | **request_id** | **string** | A request id assigned by the server. | 9 | **ticker** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner.md: -------------------------------------------------------------------------------- 1 | # # ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **float** | The number of shares per contract of the additional underlying, or the cash-in-lieu amount of the currency. | [optional] 8 | **type** | **string** | The type of the additional underlying asset, either equity or currency. | [optional] 9 | **underlying** | **string** | The name of the additional underlying asset. | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerLastQuote.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerLastQuote 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **p** | **float** | The ask price. | 8 | **s** | **int** | The ask size in lots. | 9 | **p** | **float** | The bid price. | 10 | **s** | **int** | The bid size in lots. | 11 | **t** | **int** | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/V1HistoricForexFromToDateGet200ResponseAllOfTicksInner.md: -------------------------------------------------------------------------------- 1 | # # V1HistoricForexFromToDateGet200ResponseAllOfTicksInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **a** | **float** | The ask price. | 8 | **b** | **float** | The bid price. | 9 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 10 | **x** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/forex/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ForexHistoricTrades.md: -------------------------------------------------------------------------------- 1 | # # ForexHistoricTrades 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **day** | **\DateTime** | The date that was evaluated from the request. | 8 | **map** | **object** | A map for shortened result keys. | 9 | **ms_latency** | **int** | The milliseconds of latency for the query results. | 10 | **pair** | **string** | The currency pair that was evaluated from the request. | 11 | **ticks** | [**\OpenAPI\Client\Model\V1HistoricForexFromToDateGet200ResponseAllOfTicksInner[]**](V1HistoricForexFromToDateGet200ResponseAllOfTicksInner.md) | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/SnapshotOHLCVVW.md: -------------------------------------------------------------------------------- 1 | # # SnapshotOHLCVVW 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **v** | **float** | The trading volume of the symbol in the given time period. | 12 | **vw** | **float** | The volume weighted average price. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/CryptoHistoricTrades.md: -------------------------------------------------------------------------------- 1 | # # CryptoHistoricTrades 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **day** | **\DateTime** | The date that was evaluated from the request. | 8 | **map** | **object** | A map for shortened result keys. | 9 | **ms_latency** | **int** | The milliseconds of latency for the query results. | 10 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 11 | **ticks** | [**\OpenAPI\Client\Model\V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner[]**](V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner.md) | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ListFinancials200Response.md: -------------------------------------------------------------------------------- 1 | # # ListFinancials200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | 8 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 9 | **request_id** | **string** | A request id assigned by the server. | 10 | **results** | [**\OpenAPI\Client\Model\ListFinancials200ResponseResultsInner[]**](ListFinancials200ResponseResultsInner.md) | | 11 | **status** | **string** | The status of this request's response. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/CryptoExchangeInner.md: -------------------------------------------------------------------------------- 1 | # # CryptoExchangeInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | 8 | **market** | **string** | Market data type this exchange contains ( crypto only currently ) | 9 | **name** | **string** | Name of the exchange | 10 | **type** | **string** | Type of exchange feed | 11 | **url** | **string** | URL of this exchange | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ForexSnapshotPrevDay.md: -------------------------------------------------------------------------------- 1 | # # ForexSnapshotPrevDay 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **v** | **float** | The trading volume of the symbol in the given time period. | 12 | **vw** | **float** | The volume weighted average price. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/ListNews200Response.md: -------------------------------------------------------------------------------- 1 | # # ListNews200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | [optional] 8 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 9 | **request_id** | **string** | A request id assigned by the server. | [optional] 10 | **results** | [**\OpenAPI\Client\Model\ListNews200ResponseResultsInner[]**](ListNews200ResponseResultsInner.md) | | [optional] 11 | **status** | **string** | The status of this request's response. | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ListStockSplits200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListStockSplits200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **execution_date** | **string** | The execution date of the stock split. On this date the stock split was applied. | [optional] 8 | **split_from** | **float** | The second number in the split ratio. For example: In a 2-for-1 split, split_from would be 1. | 9 | **split_to** | **float** | The first number in the split ratio. For example: In a 2-for-1 split, split_to would be 2. | 10 | **ticker** | **string** | The ticker symbol of the stock split. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/V2AggsTickerIndicesTickerPrevGet200ResponseAllOfResultsInner.md: -------------------------------------------------------------------------------- 1 | # # V2AggsTickerIndicesTickerPrevGet200ResponseAllOfResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close value for the symbol in the given time period. | 8 | **h** | **float** | The highest value for the symbol in the given time period. | 9 | **l** | **float** | The lowest value for the symbol in the given time period. | 10 | **o** | **float** | The open value for the symbol in the given time period. | 11 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/MarketHolidayInner.md: -------------------------------------------------------------------------------- 1 | # # MarketHolidayInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **close** | **\DateTime** | The market close time on the holiday (if it's not closed). | [optional] 8 | **date** | **\DateTime** | The date of the holiday. | [optional] 9 | **exchange** | **string** | Which market the record is for. | [optional] 10 | **name** | **string** | The name of the holiday. | [optional] 11 | **open** | **\DateTime** | The market open time on the holiday (if it's not closed). | [optional] 12 | **status** | **string** | The status of the market on the holiday. | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V1HistoricCryptoFromToDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V1HistoricCryptoFromToDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **day** | **\DateTime** | The date that was evaluated from the request. | 8 | **map** | **object** | A map for shortened result keys. | 9 | **ms_latency** | **int** | The milliseconds of latency for the query results. | 10 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 11 | **ticks** | [**\OpenAPI\Client\Model\V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner[]**](V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner.md) | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ListConditions200Response.md: -------------------------------------------------------------------------------- 1 | # # ListConditions200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | 8 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 9 | **request_id** | **string** | A request ID assigned by the server. | 10 | **results** | [**\OpenAPI\Client\Model\ListConditions200ResponseResultsInner[]**](ListConditions200ResponseResultsInner.md) | An array of conditions that match your query. | 11 | **status** | **string** | The status of this request's response. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ListConditions400Response.md: -------------------------------------------------------------------------------- 1 | # # ListConditions400Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | 8 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 9 | **request_id** | **string** | A request ID assigned by the server. | 10 | **results** | [**\OpenAPI\Client\Model\ListConditions200ResponseResultsInner[]**](ListConditions200ResponseResultsInner.md) | An array of conditions that match your query. | 11 | **status** | **string** | The status of this request's response. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetMarketHolidays200ResponseInner.md: -------------------------------------------------------------------------------- 1 | # # GetMarketHolidays200ResponseInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **close** | **string** | The market close time on the holiday (if it's not closed). | [optional] 8 | **date** | **string** | The date of the holiday. | [optional] 9 | **exchange** | **string** | Which market the record is for. | [optional] 10 | **name** | **string** | The name of the holiday. | [optional] 11 | **open** | **string** | The market open time on the holiday (if it's not closed). | [optional] 12 | **status** | **string** | The status of the market on the holiday. | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerDay.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerDay 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **v** | **float** | The trading volume of the symbol in the given time period. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/IndicesTickerResultsResultsInner.md: -------------------------------------------------------------------------------- 1 | # # IndicesTickerResultsResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close value for the symbol in the given time period. | 8 | **h** | **float** | The highest value for the symbol in the given time period. | 9 | **l** | **float** | The lowest value for the symbol in the given time period. | 10 | **n** | **int** | The number of transactions in the aggregate window. | [optional] 11 | **o** | **float** | The open value for the symbol in the given time period. | 12 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /phpunit.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | ./lib/Api 6 | ./lib/Model 7 | 8 | 9 | 10 | 11 | ./test/Api 12 | ./test/Model 13 | 14 | 15 | 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/Model/ListTickerTaxonomyClassifications200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListTickerTaxonomyClassifications200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **category** | **string** | The classification category. | [optional] 8 | **reason** | **string** | The reason why the classification was given. | [optional] 9 | **relevance** | **float** | The relevance score for the tag. This is a measure of confidence in the tag classification. | [optional] 10 | **tag** | **string** | The classification tag. Each category has a set of associated tags. | [optional] 11 | **ticker** | **string** | The ticker symbol for the asset. | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ListFilingFiles200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListFilingFiles200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **string** | A description for the contents of the file. | 8 | **filename** | **string** | The name for the file. | [optional] 9 | **id** | **string** | An identifier unique to the filing for this data entry. | 10 | **sequence** | **int** | File Sequence Number | 11 | **size_bytes** | **int** | The size of the file in bytes. | 12 | **source_url** | **string** | The source URL is a link back to the upstream source for this file. | 13 | **type** | **string** | The type of document contained in the file. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/MarketStatus.md: -------------------------------------------------------------------------------- 1 | # # MarketStatus 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **after_hours** | **bool** | Whether or not the market is in post-market hours. | [optional] 8 | **currencies** | [**\OpenAPI\Client\Model\MarketStatusCurrencies**](MarketStatusCurrencies.md) | | [optional] 9 | **early_hours** | **bool** | Whether or not the market is in pre-market hours. | [optional] 10 | **exchanges** | [**\OpenAPI\Client\Model\MarketStatusExchanges**](MarketStatusExchanges.md) | | [optional] 11 | **market** | **string** | The status of the market as a whole. | [optional] 12 | **server_time** | **\DateTime** | The current time of the server. | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V1HistoricForexFromToDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V1HistoricForexFromToDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | **string** | The status of this request's response. | 8 | **day** | **\DateTime** | The date that was evaluated from the request. | 9 | **map** | **object** | A map for shortened result keys. | 10 | **ms_latency** | **int** | The milliseconds of latency for the query results. | 11 | **pair** | **string** | The currency pair that was evaluated from the request. | 12 | **ticks** | [**\OpenAPI\Client\Model\V1HistoricForexFromToDateGet200ResponseAllOfTicksInner[]**](V1HistoricForexFromToDateGet200ResponseAllOfTicksInner.md) | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerDay.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerDay 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **v** | **float** | The trading volume of the symbol in the given time period. | 12 | **vw** | **float** | The volume weighted average price. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/GetTicker200ResponseResultsBranding.md: -------------------------------------------------------------------------------- 1 | # # GetTicker200ResponseResultsBranding 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **icon_url** | **string** | A link to this ticker's company's icon. Icon's are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. | [optional] 8 | **logo_url** | **string** | A link to this ticker's company's logo. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerPrevDay.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerPrevDay 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **v** | **float** | The trading volume of the symbol in the given time period. | 12 | **vw** | **float** | The volume weighted average price. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/SnapshotOHLCVVWOtc.md: -------------------------------------------------------------------------------- 1 | # # SnapshotOHLCVVWOtc 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 12 | **v** | **float** | The trading volume of the symbol in the given time period. | 13 | **vw** | **float** | The volume weighted average price. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/V2TicksStocksNbboTickerDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2TicksStocksNbboTickerDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **db_latency** | **int** | Latency in milliseconds for the query results from the database. | [optional] 8 | **results_count** | **int** | The total number of results for this request. | [optional] 9 | **success** | **bool** | Whether or not this query was executed successfully. | [optional] 10 | **ticker** | **string** | The exchange symbol that this item is traded under. | [optional] 11 | **results** | [**\OpenAPI\Client\Model\V2TicksStocksNbboTickerDateGet200ResponseAllOfResultsInner[]**](V2TicksStocksNbboTickerDateGet200ResponseAllOfResultsInner.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/SnapshotSummary200ResponseResultsInnerBranding.md: -------------------------------------------------------------------------------- 1 | # # SnapshotSummary200ResponseResultsInnerBranding 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **icon_url** | **string** | A link to this ticker's company's icon. Icon's are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. | [optional] 8 | **logo_url** | **string** | A link to this ticker's company's logo. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfDataAsksInner.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfDataAsksInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **p** | **float** | The price of this book level. | 8 | **x** | **object** | A map of the exchange ID to number of shares at this price level. <br /> <br /> **Example:** <br /> `{ \"p\": 16302.94, \"x\": { \"1\": 0.02859424, \"6\": 0.023455 } }` <br /> <br /> In this example, exchange ID 1 has 0.02859424 shares available at $16,302.94, and exchange ID 6 has 0.023455 shares at the same price level. | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/V2TicksStocksTradesTickerDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2TicksStocksTradesTickerDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **db_latency** | **int** | Latency in milliseconds for the query results from the database. | [optional] 8 | **results_count** | **int** | The total number of results for this request. | [optional] 9 | **success** | **bool** | Whether or not this query was executed successfully. | [optional] 10 | **ticker** | **string** | The exchange symbol that this item is traded under. | [optional] 11 | **results** | [**\OpenAPI\Client\Model\V2TicksStocksTradesTickerDateGet200ResponseAllOfResultsInner[]**](V2TicksStocksTradesTickerDateGet200ResponseAllOfResultsInner.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/CryptoSnapshotMinute.md: -------------------------------------------------------------------------------- 1 | # # CryptoSnapshotMinute 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **n** | **int** | The number of transactions in the aggregate window. | 11 | **o** | **float** | The open price for the symbol in the given time period. | 12 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 13 | **v** | **float** | The trading volume of the symbol in the given time period. | 14 | **vw** | **float** | The volume weighted average price. | 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/SnapshotMinOHLCV.md: -------------------------------------------------------------------------------- 1 | # # SnapshotMinOHLCV 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | [optional] 8 | **h** | **float** | The highest price for the symbol in the given time period. | [optional] 9 | **l** | **float** | The lowest price for the symbol in the given time period. | [optional] 10 | **n** | **int** | The number of transactions in the aggregate window. | [optional] 11 | **o** | **float** | The open price for the symbol in the given time period. | [optional] 12 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | [optional] 13 | **v** | **float** | The trading volume of the symbol in the given time period. | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/ListTickers200Response.md: -------------------------------------------------------------------------------- 1 | # # ListTickers200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **count** | **int** | The total number of results for this request. | [optional] 8 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 9 | **request_id** | **string** | A request id assigned by the server. | [optional] 10 | **results** | [**\OpenAPI\Client\Model\ListTickers200ResponseResultsInner[]**](ListTickers200ResponseResultsInner.md) | An array of tickers that match your query. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. | [optional] 11 | **status** | **string** | The status of this request's response. | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/V2AggsTickerIndicesTickerPrevGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2AggsTickerIndicesTickerPrevGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | **string** | The exchange symbol that this item is traded under. | 8 | **query_count** | **int** | The number of aggregates (minute or day) used to generate the response. | 9 | **request_id** | **string** | A request id assigned by the server. | 10 | **results_count** | **int** | The total number of results for this request. | 11 | **status** | **string** | The status of this request's response. | 12 | **results** | [**\OpenAPI\Client\Model\V2AggsTickerIndicesTickerPrevGet200ResponseAllOfResultsInner[]**](V2AggsTickerIndicesTickerPrevGet200ResponseAllOfResultsInner.md) | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/CryptoLastTradeLast.md: -------------------------------------------------------------------------------- 1 | # # CryptoLastTradeLast 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conditions** | **int[]** | A list of condition codes. | 8 | **exchange** | **int** | The exchange that this crypto trade happened on. See <a href=\"https://polygon.io/docs/crypto/get_v3_reference_exchanges\">Exchanges</a> for a mapping of exchanges to IDs. | 9 | **price** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 10 | **size** | **float** | The size of a trade (also known as volume). | 11 | **timestamp** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/LastTradeCrypto200ResponseLast.md: -------------------------------------------------------------------------------- 1 | # # LastTradeCrypto200ResponseLast 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conditions** | **int[]** | A list of condition codes. | [optional] 8 | **exchange** | **int** | The exchange that this crypto trade happened on. See <a href=\"https://polygon.io/docs/crypto/get_v3_reference_exchanges\">Exchanges</a> for a mapping of exchanges to IDs. | 9 | **price** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 10 | **size** | **float** | The size of a trade (also known as volume). | 11 | **timestamp** | **int** | The Unix millisecond timestamp. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/RealTimeCurrencyConversion200Response.md: -------------------------------------------------------------------------------- 1 | # # RealTimeCurrencyConversion200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **converted** | **float** | The result of the conversion. | 8 | **from** | **string** | The \"from\" currency symbol. | 9 | **initial_amount** | **float** | The amount to convert. | 10 | **last** | [**\OpenAPI\Client\Model\RealTimeCurrencyConversion200ResponseLast**](RealTimeCurrencyConversion200ResponseLast.md) | | [optional] 11 | **request_id** | **string** | A request id assigned by the server. | 12 | **status** | **string** | The status of this request's response. | 13 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 14 | **to** | **string** | The \"to\" currency symbol. | 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/NewsInner.md: -------------------------------------------------------------------------------- 1 | # # NewsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **image** | **string** | A URL of the image for the news article, if found. | [optional] 8 | **keywords** | **string[]** | A list of common keywords related to the news article. | [optional] 9 | **source** | **string** | The publication source of the article. | [optional] 10 | **summary** | **string** | A summary of the news article. | [optional] 11 | **symbols** | **string[]** | A list of ticker symbols relating to the article. | [optional] 12 | **timestamp** | **\DateTime** | The timestamp of the news article. | [optional] 13 | **title** | **string** | The title of the news article. | [optional] 14 | **url** | **string** | A direct link to the news article from its source publication. | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/V2AggsGroupedLocaleUsMarketStocksDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2AggsGroupedLocaleUsMarketStocksDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **adjusted** | **bool** | Whether or not this response was adjusted for splits. | 8 | **query_count** | **int** | The number of aggregates (minute or day) used to generate the response. | 9 | **request_id** | **string** | A request id assigned by the server. | 10 | **results_count** | **int** | The total number of results for this request. | 11 | **status** | **string** | The status of this request's response. | 12 | **results** | [**\OpenAPI\Client\Model\V2AggsGroupedLocaleUsMarketStocksDateGet200ResponseAllOfResultsInner[]**](V2AggsGroupedLocaleUsMarketStocksDateGet200ResponseAllOfResultsInner.md) | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/StocksSnapshotMinute.md: -------------------------------------------------------------------------------- 1 | # # StocksSnapshotMinute 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **av** | **int** | The accumulated volume. | 8 | **c** | **float** | The close price for the symbol in the given time period. | 9 | **h** | **float** | The highest price for the symbol in the given time period. | 10 | **l** | **float** | The lowest price for the symbol in the given time period. | 11 | **n** | **int** | The number of transactions in the aggregate window. | 12 | **o** | **float** | The open price for the symbol in the given time period. | 13 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 14 | **v** | **float** | The trading volume of the symbol in the given time period. | 15 | **vw** | **float** | The volume weighted average price. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/Snapshots200ResponseResultsInnerUnderlyingAsset.md: -------------------------------------------------------------------------------- 1 | # # Snapshots200ResponseResultsInnerUnderlyingAsset 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **change_to_break_even** | **float** | The change in price for the contract to break even. | 8 | **last_updated** | **int** | The nanosecond timestamp of when this information was updated. | 9 | **price** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | [optional] 10 | **ticker** | **string** | The ticker symbol for the contract's underlying asset. | 11 | **timeframe** | **string** | The time relevance of the data. | 12 | **value** | **float** | The value of the underlying index. | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V2AggsGroupedLocaleGlobalMarketCryptoDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2AggsGroupedLocaleGlobalMarketCryptoDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **adjusted** | **bool** | Whether or not this response was adjusted for splits. | 8 | **query_count** | **int** | The number of aggregates (minute or day) used to generate the response. | 9 | **request_id** | **string** | A request id assigned by the server. | 10 | **results_count** | **int** | The total number of results for this request. | 11 | **status** | **string** | The status of this request's response. | 12 | **results** | [**\OpenAPI\Client\Model\V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner[]**](V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner.md) | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerDay.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerDay 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 12 | **v** | **float** | The trading volume of the symbol in the given time period. | 13 | **vw** | **float** | The volume weighted average price. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/IndicesSnapshot200ResponseResultsInnerSession.md: -------------------------------------------------------------------------------- 1 | # # IndicesSnapshot200ResponseResultsInnerSession 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **change** | **float** | The value of the change for the index from the previous trading day. | [optional] 8 | **change_percent** | **float** | The percent of the change for the index from the previous trading day. | [optional] 9 | **close** | **float** | The closing value for the index of the day. | [optional] 10 | **high** | **float** | The highest value for the index of the day. | [optional] 11 | **low** | **float** | The lowest value for the index of the day. | [optional] 12 | **open** | **float** | The open value for the index of the day. | [optional] 13 | **previous_close** | **float** | The closing value for the index of previous trading day. | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerPrevDay.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerPrevDay 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **o** | **float** | The open price for the symbol in the given time period. | 11 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 12 | **v** | **float** | The trading volume of the symbol in the given time period. | 13 | **vw** | **float** | The volume weighted average price. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/CryptoOpenClose.md: -------------------------------------------------------------------------------- 1 | # # CryptoOpenClose 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **close** | **float** | The close price for the symbol in the given time period. | 8 | **closing_trades** | [**\OpenAPI\Client\Model\V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner[]**](V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner.md) | | 9 | **day** | **\DateTime** | The date requested. | 10 | **is_utc** | **bool** | Whether or not the timestamps are in UTC timezone. | 11 | **open** | **float** | The open price for the symbol in the given time period. | 12 | **open_trades** | [**\OpenAPI\Client\Model\V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner[]**](V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner.md) | | 13 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/Snapshots200ResponseResultsInnerDetails.md: -------------------------------------------------------------------------------- 1 | # # Snapshots200ResponseResultsInnerDetails 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **contract_type** | **string** | The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". | 8 | **exercise_style** | **string** | The exercise style of this contract. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\">this link</a> for more details on exercise styles. | 9 | **expiration_date** | **\DateTime** | The contract's expiration date in YYYY-MM-DD format. | 10 | **shares_per_contract** | **float** | The number of shares per contract for this contract. | 11 | **strike_price** | **float** | The strike price of the option contract. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerMin.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerMin 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **n** | **int** | The number of transactions in the aggregate window. | 11 | **o** | **float** | The open price for the symbol in the given time period. | 12 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 13 | **v** | **float** | The trading volume of the symbol in the given time period. | 14 | **vw** | **float** | The volume weighted average price. | 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/IndicesOpenClose.md: -------------------------------------------------------------------------------- 1 | # # IndicesOpenClose 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **after_hours** | **float** | The close value of the ticker symbol in after hours trading. | [optional] 8 | **close** | **float** | The close value for the symbol in the given time period. | 9 | **from** | **\DateTime** | The requested date. | 10 | **high** | **float** | The highest value for the symbol in the given time period. | 11 | **low** | **float** | The lowest value for the symbol in the given time period. | 12 | **open** | **float** | The open value for the symbol in the given time period. | 13 | **pre_market** | **int** | The open value of the ticker symbol in pre-market trading. | [optional] 14 | **status** | **string** | The status of this request's response. | 15 | **symbol** | **string** | The exchange symbol that this item is traded under. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/V2AggsTickerCryptoTickerPrevGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2AggsTickerCryptoTickerPrevGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | **string** | The exchange symbol that this item is traded under. | 8 | **adjusted** | **bool** | Whether or not this response was adjusted for splits. | 9 | **query_count** | **int** | The number of aggregates (minute or day) used to generate the response. | 10 | **request_id** | **string** | A request id assigned by the server. | 11 | **results_count** | **int** | The total number of results for this request. | 12 | **status** | **string** | The status of this request's response. | 13 | **results** | [**\OpenAPI\Client\Model\V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner[]**](V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner.md) | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerMin.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerMin 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | [optional] 8 | **h** | **float** | The highest price for the symbol in the given time period. | [optional] 9 | **l** | **float** | The lowest price for the symbol in the given time period. | [optional] 10 | **n** | **int** | The number of transactions in the aggregate window. | [optional] 11 | **o** | **float** | The open price for the symbol in the given time period. | [optional] 12 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | [optional] 13 | **v** | **float** | The trading volume of the symbol in the given time period. | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/StocksV2Base.md: -------------------------------------------------------------------------------- 1 | # # StocksV2Base 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **t** | **string** | The exchange symbol that this item is traded under. | 8 | **f** | **int** | The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. | 9 | **q** | **int** | The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). | 10 | **t** | **int** | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. | 11 | **y** | **int** | The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/V1OpenCloseCryptoFromToDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V1OpenCloseCryptoFromToDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **close** | **float** | The close price for the symbol in the given time period. | 8 | **closing_trades** | [**\OpenAPI\Client\Model\V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner[]**](V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner.md) | | 9 | **day** | **\DateTime** | The date requested. | 10 | **is_utc** | **bool** | Whether or not the timestamps are in UTC timezone. | 11 | **open** | **float** | The open price for the symbol in the given time period. | 12 | **open_trades** | [**\OpenAPI\Client\Model\V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner[]**](V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner.md) | | 13 | **symbol** | **string** | The symbol pair that was evaluated from the request. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/TradesCrypto200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # TradesCrypto200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conditions** | **int[]** | A list of condition codes. | [optional] 8 | **exchange** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/crypto/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | 9 | **id** | **string** | The Trade ID which uniquely identifies a trade on the exchange that the trade happened on. | 10 | **participant_timestamp** | **int** | The nanosecond Exchange Unix Timestamp. This is the timestamp of when the trade was generated at the exchange. | [optional] 11 | **price** | **float** | The price of the trade in the base currency of the crypto pair. | 12 | **size** | **float** | The size of a trade (also known as volume). | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md: -------------------------------------------------------------------------------- 1 | # # V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **n** | **int** | The number of transactions in the aggregate window. | [optional] 11 | **o** | **float** | The open price for the symbol in the given time period. | 12 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 13 | **v** | **float** | The trading volume of the symbol in the given time period. | 14 | **vw** | **float** | The volume weighted average price. | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/OptionsChain200ResponseResultsInnerDetails.md: -------------------------------------------------------------------------------- 1 | # # OptionsChain200ResponseResultsInnerDetails 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **contract_type** | **string** | The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". | 8 | **exercise_style** | **string** | The exercise style of this contract. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\">this link</a> for more details on exercise styles. | 9 | **expiration_date** | **\DateTime** | The contract's expiration date in YYYY-MM-DD format. | 10 | **shares_per_contract** | **float** | The number of shares per contract for this contract. | 11 | **strike_price** | **float** | The strike price of the option contract. | 12 | **ticker** | **string** | The ticker symbol for the asset. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V1OpenCloseIndicesTickerDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V1OpenCloseIndicesTickerDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **after_hours** | **float** | The close value of the ticker symbol in after hours trading. | [optional] 8 | **close** | **float** | The close value for the symbol in the given time period. | 9 | **from** | **\DateTime** | The requested date. | 10 | **high** | **float** | The highest value for the symbol in the given time period. | 11 | **low** | **float** | The lowest value for the symbol in the given time period. | 12 | **open** | **float** | The open value for the symbol in the given time period. | 13 | **pre_market** | **int** | The open value of the ticker symbol in pre-market trading. | [optional] 14 | **status** | **string** | The status of this request's response. | 15 | **symbol** | **string** | The exchange symbol that this item is traded under. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/StocksSnapshotMinuteOTC.md: -------------------------------------------------------------------------------- 1 | # # StocksSnapshotMinuteOTC 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **av** | **int** | The accumulated volume. | 8 | **c** | **float** | The close price for the symbol in the given time period. | 9 | **h** | **float** | The highest price for the symbol in the given time period. | 10 | **l** | **float** | The lowest price for the symbol in the given time period. | 11 | **n** | **int** | The number of transactions in the aggregate window. | 12 | **o** | **float** | The open price for the symbol in the given time period. | 13 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 14 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 15 | **v** | **float** | The trading volume of the symbol in the given time period. | 16 | **vw** | **float** | The volume weighted average price. | 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/SnapshotSummary200ResponseResultsInnerOptions.md: -------------------------------------------------------------------------------- 1 | # # SnapshotSummary200ResponseResultsInnerOptions 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **contract_type** | **string** | The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". | 8 | **exercise_style** | **string** | The exercise style of this contract. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Option_style\">this link</a> for more details on exercise styles. | 9 | **expiration_date** | **\DateTime** | The contract's expiration date in YYYY-MM-DD format. | 10 | **shares_per_contract** | **float** | The number of shares per contract for this contract. | 11 | **strike_price** | **float** | The strike price of the option contract. | 12 | **underlying_ticker** | **string** | The ticker for the option contract. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | **string** | The exchange symbol that this item is traded under. | 8 | **adjusted** | **bool** | Whether or not this response was adjusted for splits. | 9 | **query_count** | **int** | The number of aggregates (minute or day) used to generate the response. | 10 | **request_id** | **string** | A request id assigned by the server. | 11 | **results_count** | **int** | The total number of results for this request. | 12 | **status** | **string** | The status of this request's response. | 13 | **results** | [**\OpenAPI\Client\Model\V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner[]**](V2AggsTickerCryptoTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md) | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2023 polygon.io 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /docs/Model/CryptoEMA200ResponseResultsUnderlyingAggregatesInner.md: -------------------------------------------------------------------------------- 1 | # # CryptoEMA200ResponseResultsUnderlyingAggregatesInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **n** | **int** | The number of transactions in the aggregate window. | 11 | **o** | **float** | The open price for the symbol in the given time period. | 12 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 13 | **t** | **float** | The Unix Msec timestamp for the start of the aggregate window. | 14 | **v** | **float** | The trading volume of the symbol in the given time period. | 15 | **vw** | **float** | The volume weighted average price. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/GetMarketStatus200Response.md: -------------------------------------------------------------------------------- 1 | # # GetMarketStatus200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **after_hours** | **bool** | Whether or not the market is in post-market hours. | [optional] 8 | **currencies** | [**\OpenAPI\Client\Model\GetMarketStatus200ResponseCurrencies**](GetMarketStatus200ResponseCurrencies.md) | | [optional] 9 | **early_hours** | **bool** | Whether or not the market is in pre-market hours. | [optional] 10 | **exchanges** | [**\OpenAPI\Client\Model\GetMarketStatus200ResponseExchanges**](GetMarketStatus200ResponseExchanges.md) | | [optional] 11 | **indices_groups** | [**\OpenAPI\Client\Model\GetMarketStatus200ResponseIndicesGroups**](GetMarketStatus200ResponseIndicesGroups.md) | | [optional] 12 | **market** | **string** | The status of the market as a whole. | [optional] 13 | **server_time** | **string** | The current time of the server, returned as a date-time in RFC3339 format. | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner.md: -------------------------------------------------------------------------------- 1 | # # V2AggsGroupedLocaleGlobalMarketCryptoDateGet200ResponseAllOfResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **t** | **string** | The exchange symbol that this item is traded under. | 8 | **c** | **float** | The close price for the symbol in the given time period. | 9 | **h** | **float** | The highest price for the symbol in the given time period. | 10 | **l** | **float** | The lowest price for the symbol in the given time period. | 11 | **n** | **int** | The number of transactions in the aggregate window. | [optional] 12 | **o** | **float** | The open price for the symbol in the given time period. | 13 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 14 | **v** | **float** | The trading volume of the symbol in the given time period. | 15 | **vw** | **float** | The volume weighted average price. | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/IndicesSnapshot200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # IndicesSnapshot200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **error** | **string** | The error while looking for this ticker. | [optional] 8 | **last_updated** | **int** | The nanosecond timestamp of when this information was updated. | 9 | **market_status** | **string** | The market status for the market that trades this ticker. | [optional] 10 | **message** | **string** | The error message while looking for this ticker. | [optional] 11 | **name** | **string** | Name of Index. | [optional] 12 | **session** | [**\OpenAPI\Client\Model\IndicesSnapshot200ResponseResultsInnerSession**](IndicesSnapshot200ResponseResultsInnerSession.md) | | [optional] 13 | **ticker** | **string** | Ticker of asset queried. | 14 | **timeframe** | **string** | The time relevance of the data. | 15 | **type** | **string** | The indices market. | [optional] 16 | **value** | **float** | Value of Index. | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/CryptoTick.md: -------------------------------------------------------------------------------- 1 | # # CryptoTick 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **int[]** | A list of condition codes. | 8 | **i** | **string** | The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. | 9 | **p** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 10 | **s** | **float** | The size of a trade (also known as volume). | 11 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 12 | **x** | **int** | The exchange that this crypto trade happened on. See <a href=\"https://polygon.io/docs/crypto/get_v3_reference_exchanges\">Exchanges</a> for a mapping of exchanges to IDs. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/OptionsChain200ResponseResultsInnerLastTrade.md: -------------------------------------------------------------------------------- 1 | # # OptionsChain200ResponseResultsInnerLastTrade 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conditions** | **int[]** | A list of condition codes. | [optional] 8 | **exchange** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/options/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | 9 | **price** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 10 | **sip_timestamp** | **int** | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. | 11 | **size** | **int** | The size of a trade (also known as volume). | 12 | **timeframe** | **string** | The time relevance of the data. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "polygon-io/api", 3 | "description": "polygon.io php-client", 4 | "keywords": [ 5 | "openapitools", 6 | "openapi-generator", 7 | "openapi", 8 | "php", 9 | "sdk", 10 | "rest", 11 | "api" 12 | ], 13 | "homepage": "https://openapi-generator.tech", 14 | "type": "library", 15 | "license": "MIT", 16 | "authors": [ 17 | { 18 | "name": "Polygon.io, Inc.", 19 | "homepage": "https://polygon.io/" 20 | } 21 | ], 22 | "require": { 23 | "php": "^7.4 || ^8.0", 24 | "ext-curl": "*", 25 | "ext-json": "*", 26 | "ext-mbstring": "*", 27 | "guzzlehttp/guzzle": "^7.3", 28 | "guzzlehttp/psr7": "^1.7 || ^2.0" 29 | }, 30 | "require-dev": { 31 | "phpunit/phpunit": "^8.0 || ^9.0", 32 | "friendsofphp/php-cs-fixer": "^3.5" 33 | }, 34 | "autoload": { 35 | "psr-4": { "OpenAPI\\Client\\" : "lib/" } 36 | }, 37 | "autoload-dev": { 38 | "psr-4": { "OpenAPI\\Client\\Test\\" : "test/" } 39 | }, 40 | "scripts": { 41 | "test": "./vendor/bin/phpunit" 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /docs/Model/ExchangeInner.md: -------------------------------------------------------------------------------- 1 | # # ExchangeInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | **string** | A unique identifier for the exchange internal to Polygon.io. This is not an industry code or ISO standard. | [optional] 8 | **id** | **float** | The ID of the exchange. | [optional] 9 | **market** | **string** | The market data type that this exchange contains. | [optional] 10 | **mic** | **string** | The Market Identification Code or MIC as defined in ISO 10383 (<a rel=\"nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Market_Identifier_Code\">https://en.wikipedia.org/wiki/Market_Identifier_Code</a>). | [optional] 11 | **name** | **string** | The name of the exchange. | [optional] 12 | **tape** | **string** | The tape id of the exchange. | [optional] 13 | **type** | **string** | The type of exchange. - TRF = Trade Reporting Facility - exchange = Reporting exchange on the tape | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/ListExchanges200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListExchanges200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **acronym** | **string** | A commonly used abbreviation for this exchange. | [optional] 8 | **asset_class** | **string** | An identifier for a group of similar financial instruments. | 9 | **id** | **int** | A unique identifier used by Polygon.io for this exchange. | 10 | **locale** | **string** | An identifier for a geographical location. | 11 | **mic** | **string** | The Market Identifer Code of this exchange (see ISO 10383). | [optional] 12 | **name** | **string** | Name of this exchange. | 13 | **operating_mic** | **string** | The MIC of the entity that operates this exchange. | [optional] 14 | **participant_id** | **string** | The ID used by SIP's to represent this exchange. | [optional] 15 | **type** | **string** | Represents the type of exchange. | 16 | **url** | **string** | A link to this exchange's website, if one exists. | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md: -------------------------------------------------------------------------------- 1 | # # V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **float** | The close price for the symbol in the given time period. | 8 | **h** | **float** | The highest price for the symbol in the given time period. | 9 | **l** | **float** | The lowest price for the symbol in the given time period. | 10 | **n** | **int** | The number of transactions in the aggregate window. | [optional] 11 | **o** | **float** | The open price for the symbol in the given time period. | 12 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 13 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 14 | **v** | **float** | The trading volume of the symbol in the given time period. | 15 | **vw** | **float** | The volume weighted average price. | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerMin.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerMin 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **av** | **int** | The accumulated volume. | 8 | **c** | **float** | The close price for the symbol in the given time period. | 9 | **h** | **float** | The highest price for the symbol in the given time period. | 10 | **l** | **float** | The lowest price for the symbol in the given time period. | 11 | **n** | **int** | The number of transactions in the aggregate window. | 12 | **o** | **float** | The open price for the symbol in the given time period. | 13 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 14 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 15 | **v** | **float** | The trading volume of the symbol in the given time period. | 16 | **vw** | **float** | The volume weighted average price. | 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/ListFilings200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListFilings200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **acceptance_datetime** | **string** | The datetime when the filing was accepted by EDGAR in EST (format: YYYYMMDDHHMMSS) | 8 | **accession_number** | **string** | Filing Accession Number | 9 | **entities** | [**\OpenAPI\Client\Model\ListFilings200ResponseResultsInnerEntitiesInner[]**](ListFilings200ResponseResultsInnerEntitiesInner.md) | Entities related to the filing (e.g. the document filers). | 10 | **files_count** | **int** | The number of files associated with the filing. | 11 | **filing_date** | **string** | The date when the filing was filed in YYYYMMDD format. | 12 | **id** | **string** | Unique identifier for the filing. | 13 | **period_of_report_date** | **string** | The period of report for the filing in YYYYMMDD format. | 14 | **source_url** | **string** | The source URL is a link back to the upstream source for this filing document. | 15 | **type** | **string** | Filing Type | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/OptionsChain200ResponseResultsInnerDay.md: -------------------------------------------------------------------------------- 1 | # # OptionsChain200ResponseResultsInnerDay 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **change** | **float** | The value of the price change for the contract from the previous trading day. | 8 | **change_percent** | **float** | The percent of the price change for the contract from the previous trading day. | 9 | **close** | **float** | The closing price for the contract of the day. | 10 | **high** | **float** | The highest price for the contract of the day. | 11 | **last_updated** | **int** | The nanosecond timestamp of when this information was updated. | 12 | **low** | **float** | The lowest price for the contract of the day. | 13 | **open** | **float** | The open price for the contract of the day. | 14 | **previous_close** | **float** | The closing price for the contract of previous trading day. | 15 | **volume** | **float** | The trading volume for the contract of the day. | 16 | **vwap** | **float** | The trading volume weighted average price for the contract of the day. | 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ticker** | **string** | The exchange symbol that this item is traded under. | 8 | **adjusted** | **bool** | Whether or not this response was adjusted for splits. | 9 | **query_count** | **int** | The number of aggregates (minute or day) used to generate the response. | 10 | **request_id** | **string** | A request id assigned by the server. | 11 | **results_count** | **int** | The total number of results for this request. | 12 | **status** | **string** | The status of this request's response. | 13 | **results** | [**\OpenAPI\Client\Model\V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner[]**](V2AggsTickerStocksTickerRangeMultiplierTimespanFromToGet200ResponseAllOfResultsInner.md) | | [optional] 14 | **next_url** | **string** | If present, this value can be used to fetch the next page of data. | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/ListNews200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListNews200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amp_url** | **string** | The mobile friendly Accelerated Mobile Page (AMP) URL. | [optional] 8 | **article_url** | **string** | A link to the news article. | 9 | **author** | **string** | The article's author. | 10 | **description** | **string** | A description of the article. | [optional] 11 | **id** | **string** | Unique identifier for the article. | 12 | **image_url** | **string** | The article's image URL. | [optional] 13 | **keywords** | **string[]** | The keywords associated with the article (which will vary depending on the publishing source). | [optional] 14 | **published_utc** | **\DateTime** | The date the article was published on. | 15 | **publisher** | [**\OpenAPI\Client\Model\ListNews200ResponseResultsInnerPublisher**](ListNews200ResponseResultsInnerPublisher.md) | | 16 | **tickers** | **string[]** | The ticker symbols associated with the article. | 17 | **title** | **string** | The title of the news article. | 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/V2AggsGroupedLocaleUsMarketStocksDateGet200ResponseAllOfResultsInner.md: -------------------------------------------------------------------------------- 1 | # # V2AggsGroupedLocaleUsMarketStocksDateGet200ResponseAllOfResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **t** | **string** | The exchange symbol that this item is traded under. | 8 | **c** | **float** | The close price for the symbol in the given time period. | 9 | **h** | **float** | The highest price for the symbol in the given time period. | 10 | **l** | **float** | The lowest price for the symbol in the given time period. | 11 | **n** | **int** | The number of transactions in the aggregate window. | [optional] 12 | **o** | **float** | The open price for the symbol in the given time period. | 13 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 14 | **t** | **int** | The Unix Msec timestamp for the end of the aggregate window. | 15 | **v** | **float** | The trading volume of the symbol in the given time period. | 16 | **vw** | **float** | The volume weighted average price. | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfData.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfData 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ask_count** | **float** | The combined total number of asks in the book. | 8 | **asks** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfDataAsksInner[]**](V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfDataAsksInner.md) | | 9 | **bid_count** | **float** | The combined total number of bids in the book. | 10 | **bids** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfDataAsksInner[]**](V2SnapshotLocaleGlobalMarketsCryptoTickersTickerBookGet200ResponseAllOfDataAsksInner.md) | | 11 | **spread** | **float** | The difference between the best bid and the best ask price across exchanges. | 12 | **ticker** | **string** | The exchange symbol that this item is traded under. | 13 | **updated** | **int** | The last updated timestamp. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner.md: -------------------------------------------------------------------------------- 1 | # # V1HistoricCryptoFromToDateGet200ResponseAllOfTicksInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **int[]** | A list of condition codes. | 8 | **i** | **string** | The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. | 9 | **p** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 10 | **s** | **float** | The size of a trade (also known as volume). | 11 | **t** | **int** | The Unix Msec timestamp for the start of the aggregate window. | 12 | **x** | **int** | The exchange that this crypto trade happened on. See <a href=\"https://polygon.io/docs/crypto/get_v3_reference_exchanges\">Exchanges</a> for a mapping of exchanges to IDs. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/StocksOpenClose.md: -------------------------------------------------------------------------------- 1 | # # StocksOpenClose 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **after_hours** | **float** | The close price of the ticker symbol in after hours trading. | [optional] 8 | **close** | **float** | The close price for the symbol in the given time period. | 9 | **from** | **\DateTime** | The requested date. | 10 | **high** | **float** | The highest price for the symbol in the given time period. | 11 | **low** | **float** | The lowest price for the symbol in the given time period. | 12 | **open** | **float** | The open price for the symbol in the given time period. | 13 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 14 | **pre_market** | **int** | The open price of the ticker symbol in pre-market trading. | [optional] 15 | **status** | **string** | The status of this request's response. | 16 | **symbol** | **string** | The exchange symbol that this item is traded under. | 17 | **volume** | **float** | The trading volume of the symbol in the given time period. | 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/OptionsChain200ResponseResultsInnerLastQuote.md: -------------------------------------------------------------------------------- 1 | # # OptionsChain200ResponseResultsInnerLastQuote 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ask** | **float** | The ask price. | 8 | **ask_exchange** | **float** | The ask side exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | [optional] 9 | **ask_size** | **float** | The ask size. | 10 | **bid** | **float** | The bid price. | 11 | **bid_exchange** | **float** | The bid side exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | [optional] 12 | **bid_size** | **float** | The bid size. | 13 | **last_updated** | **int** | The nanosecond timestamp of when this information was updated. | 14 | **midpoint** | **float** | The average of the bid and ask price. | 15 | **timeframe** | **string** | The time relevance of the data. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/V1OpenCloseOptionsTickerDateGet200Response.md: -------------------------------------------------------------------------------- 1 | # # V1OpenCloseOptionsTickerDateGet200Response 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **after_hours** | **float** | The close price of the ticker symbol in after hours trading. | [optional] 8 | **close** | **float** | The close price for the symbol in the given time period. | 9 | **from** | **\DateTime** | The requested date. | 10 | **high** | **float** | The highest price for the symbol in the given time period. | 11 | **low** | **float** | The lowest price for the symbol in the given time period. | 12 | **open** | **float** | The open price for the symbol in the given time period. | 13 | **otc** | **bool** | Whether or not this aggregate is for an OTC ticker. This field will be left off if false. | [optional] 14 | **pre_market** | **int** | The open price of the ticker symbol in pre-market trading. | [optional] 15 | **status** | **string** | The status of this request's response. | 16 | **symbol** | **string** | The exchange symbol that this item is traded under. | 17 | **volume** | **float** | The trading volume of the symbol in the given time period. | 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerLastTrade.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerLastTrade 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **int[]** | The trade conditions. | 8 | **i** | **string** | The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. | 9 | **p** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 10 | **s** | **float** | The size (volume) of the trade. | 11 | **t** | **int** | The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange. | 12 | **x** | **int** | The exchange that this crypto trade happened on. See <a href=\"https://polygon.io/docs/crypto/get_v3_reference_exchanges\">Exchanges</a> for a mapping of exchanges to IDs. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/TradesOptions200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # TradesOptions200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conditions** | **int[]** | A list of condition codes. | [optional] 8 | **correction** | **int** | The trade correction indicator. | [optional] 9 | **exchange** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/options/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | 10 | **participant_timestamp** | **int** | The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange. | [optional] 11 | **price** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 12 | **sip_timestamp** | **int** | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. | 13 | **size** | **float** | The size of a trade (also known as volume). | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerLastTrade.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleUsMarketsStocksTickersGet200ResponseAllOfTickersInnerLastTrade 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **c** | **int[]** | The trade conditions. | 8 | **i** | **string** | The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. | 9 | **p** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 10 | **s** | **int** | The size (volume) of the trade. | 11 | **t** | **int** | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. | 12 | **x** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/Financial.md: -------------------------------------------------------------------------------- 1 | # # Financial 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **cash_change** | **int** | | [optional] 8 | **cash_flow** | **int** | | [optional] 9 | **cost_of_revenue** | **int** | | [optional] 10 | **current_assets** | **int** | | [optional] 11 | **current_cash** | **int** | | [optional] 12 | **current_debt** | **int** | | [optional] 13 | **gross_profit** | **int** | | [optional] 14 | **net_income** | **int** | | [optional] 15 | **operating_expense** | **int** | | [optional] 16 | **operating_gains_losses** | **float** | | [optional] 17 | **operating_income** | **int** | | [optional] 18 | **operating_revenue** | **int** | | [optional] 19 | **report_date** | **\DateTime** | Report Date | 20 | **report_date_str** | **string** | Report date as non date format | 21 | **research_and_development** | **int** | | [optional] 22 | **shareholder_equity** | **int** | | [optional] 23 | **symbol** | **string** | Stock Symbol | 24 | **total_assets** | **int** | | [optional] 25 | **total_cash** | **int** | | [optional] 26 | **total_debt** | **int** | | [optional] 27 | **total_liabilities** | **int** | | [optional] 28 | **total_revenue** | **int** | | [optional] 29 | 30 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 31 | -------------------------------------------------------------------------------- /docs/Model/SnapshotSummary200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # SnapshotSummary200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **branding** | [**\OpenAPI\Client\Model\SnapshotSummary200ResponseResultsInnerBranding**](SnapshotSummary200ResponseResultsInnerBranding.md) | | 8 | **error** | **string** | The error while looking for this ticker. | [optional] 9 | **last_updated** | **int** | The nanosecond timestamp of when this information was updated. | 10 | **market_status** | **string** | The market status for the market that trades this ticker. | 11 | **message** | **string** | The error message while looking for this ticker. | [optional] 12 | **name** | **string** | Name of ticker, forex, or crypto asset. | 13 | **options** | [**\OpenAPI\Client\Model\SnapshotSummary200ResponseResultsInnerOptions**](SnapshotSummary200ResponseResultsInnerOptions.md) | | 14 | **price** | **float** | The most up to date ticker price. | 15 | **session** | [**\OpenAPI\Client\Model\SnapshotSummary200ResponseResultsInnerSession**](SnapshotSummary200ResponseResultsInnerSession.md) | | 16 | **ticker** | **string** | Ticker of asset queried. | 17 | **type** | **string** | The market for this ticker of stock, crypto, fx, option. | 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /.github/workflows/php.yml: -------------------------------------------------------------------------------- 1 | name: PHP Composer 2 | 3 | on: 4 | push: 5 | branches: [ develop, master ] 6 | pull_request: 7 | branches: [ develop, master] 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | php-versions: ['7.4', '8.0'] 15 | steps: 16 | - uses: actions/checkout@v2 17 | 18 | - name: Setup PHP ${{ matrix.php-versions }} with tools 19 | uses: shivammathur/setup-php@v2 20 | with: 21 | php-version: ${{ matrix.php-versions }} 22 | tools: phan, phpunit 23 | 24 | - name: Validate composer.json and composer.lock 25 | run: composer validate 26 | 27 | - name: Cache Composer packages 28 | id: composer-cache 29 | uses: actions/cache@v2 30 | with: 31 | path: vendor 32 | key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }} 33 | restore-keys: | 34 | ${{ runner.os }}-php- 35 | - name: Install dependencies 36 | if: steps.composer-cache.outputs.cache-hit != 'true' 37 | run: composer install --prefer-dist --no-progress --no-suggest 38 | # 39 | # - name: Run linter 40 | # run: composer lint 41 | 42 | # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit" 43 | # Docs: https://getcomposer.org/doc/articles/scripts.md 44 | 45 | - name: Run test suite 46 | run: composer test 47 | -------------------------------------------------------------------------------- /docs/Model/QuotesOptions200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # QuotesOptions200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ask_exchange** | **int** | The ask exchange ID | [optional] 8 | **ask_price** | **float** | The ask price. | [optional] 9 | **ask_size** | **float** | The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. | [optional] 10 | **bid_exchange** | **int** | The bid exchange ID | [optional] 11 | **bid_price** | **float** | The bid price. | [optional] 12 | **bid_size** | **float** | The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. | [optional] 13 | **sequence_number** | **int** | The sequence number represents the sequence in which quote events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). | 14 | **sip_timestamp** | **int** | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. | 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/GetMarketStatus200ResponseIndicesGroups.md: -------------------------------------------------------------------------------- 1 | # # GetMarketStatus200ResponseIndicesGroups 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **cccy** | **string** | The status of Cboe Streaming Market Indices Cryptocurrency (\"CCCY\") indices trading hours. | [optional] 8 | **dow_jones** | **string** | The status of Dow Jones indices trading hours | [optional] 9 | **ftse_russell** | **string** | The status of Financial Times Stock Exchange Group (\"FTSE\") Russell indices trading hours. | [optional] 10 | **msci** | **string** | The status of Morgan Stanley Capital International (\"MSCI\") indices trading hours. | [optional] 11 | **mstar** | **string** | The status of Morningstar (\"MSTAR\") indices trading hours. | [optional] 12 | **mstarc** | **mixed** | The status of Morningstar Customer (\"MSTARC\") indices trading hours. | [optional] 13 | **nasdaq** | **string** | The status of National Association of Securities Dealers Automated Quotations (\"Nasdaq\") indices trading hours. | [optional] 14 | **s_and_p** | **string** | The status of Standard & Poors's (\"S&P\") indices trading hours. | [optional] 15 | **societe_generale** | **string** | The status of Societe Generale indices trading hours. | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/ListDividends200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListDividends200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **cash_amount** | **float** | The cash amount of the dividend per share owned. | 8 | **currency** | **string** | The currency in which the dividend is paid. | [optional] 9 | **declaration_date** | **string** | The date that the dividend was announced. | [optional] 10 | **dividend_type** | **string** | The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. Long-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively. | 11 | **ex_dividend_date** | **string** | The date that the stock first trades without the dividend, determined by the exchange. | 12 | **frequency** | **int** | The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), and 12 (monthly). | 13 | **pay_date** | **string** | The date that the dividend is paid out. | [optional] 14 | **record_date** | **string** | The date that the stock must be held to receive the dividend, set by the company. | [optional] 15 | **ticker** | **string** | The ticker symbol of the dividend. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/ListConditions200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListConditions200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **abbreviation** | **string** | A commonly-used abbreviation for this condition. | [optional] 8 | **asset_class** | **string** | An identifier for a group of similar financial instruments. | 9 | **data_types** | **string[]** | Data types that this condition applies to. | 10 | **description** | **string** | A short description of the semantics of this condition. | [optional] 11 | **exchange** | **int** | If present, mapping this condition from a Polygon.io code to a SIP symbol depends on this attribute. In other words, data with this condition attached comes exclusively from the given exchange. | [optional] 12 | **id** | **int** | An identifier used by Polygon.io for this condition. Unique per data type. | 13 | **legacy** | **bool** | If true, this condition is from an old version of the SIPs' specs and no longer is used. Other conditions may or may not reuse the same symbol as this one. | [optional] 14 | **name** | **string** | The name of this condition. | 15 | **sip_mapping** | [**\OpenAPI\Client\Model\ListConditions200ResponseResultsInnerSipMapping**](ListConditions200ResponseResultsInnerSipMapping.md) | | 16 | **type** | **string** | An identifier for a collection of related conditions. | 17 | **update_rules** | [**\OpenAPI\Client\Model\ListConditions200ResponseResultsInnerUpdateRules**](ListConditions200ResponseResultsInnerUpdateRules.md) | | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/Snapshots200ResponseResultsInnerLastQuote.md: -------------------------------------------------------------------------------- 1 | # # Snapshots200ResponseResultsInnerLastQuote 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ask** | **float** | The ask price. | 8 | **ask_exchange** | **int** | The ask side exchange ID. See <a href=\"https://polygon.io/docs/options/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | [optional] 9 | **ask_size** | **float** | The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. | [optional] 10 | **bid** | **float** | The bid price. | 11 | **bid_exchange** | **int** | The bid side exchange ID. See <a href=\"https://polygon.io/docs/options/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | [optional] 12 | **bid_size** | **float** | The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. | [optional] 13 | **last_updated** | **int** | The nanosecond timestamp of when this information was updated. | 14 | **midpoint** | **float** | The average of the bid and ask price. | [optional] 15 | **timeframe** | **string** | The time relevance of the data. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/Snapshots200ResponseResultsInnerLastTrade.md: -------------------------------------------------------------------------------- 1 | # # Snapshots200ResponseResultsInnerLastTrade 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **conditions** | **int[]** | A list of condition codes. | [optional] 8 | **exchange** | **int** | The exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs. | [optional] 9 | **id** | **string** | The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. | [optional] 10 | **last_updated** | **int** | The nanosecond timestamp of when this information was updated. | 11 | **participant_timestamp** | **int** | The nanosecond Exchange Unix Timestamp. This is the timestamp of when the trade was generated at the exchange. | 12 | **price** | **float** | The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. | 13 | **sip_timestamp** | **int** | The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. | [optional] 14 | **size** | **int** | The size of a trade (also known as volume). | 15 | **timeframe** | **string** | The time relevance of the data. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/ListFinancials200ResponseResultsInnerFinancials.md: -------------------------------------------------------------------------------- 1 | # # ListFinancials200ResponseResultsInnerFinancials 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **balance_sheet** | [**\OpenAPI\Client\Model\ListFinancials200ResponseResultsInnerFinancialsBalanceSheet**](ListFinancials200ResponseResultsInnerFinancialsBalanceSheet.md) | | [optional] 8 | **cash_flow_statement** | **object** | Cash flow statement. The keys in this object can be any of the fields listed in the Cash Flow Statement section of the <a target=\"_blank\" href=\"https://polygon.io/blog/financials-api-glossary-of-fields\">financials API glossary of terms</a>. See the attributes of the objects within `balance_sheet` for more details. | [optional] 9 | **comprehensive_income** | **object** | Comprehensive income. The keys in this object can be any of the fields listed in the Comprehensive Income section of the <a target=\"_blank\" href=\"https://polygon.io/blog/financials-api-glossary-of-fields\">financials API glossary of terms</a>. See the attributes of the objects within `balance_sheet` for more details. | [optional] 10 | **income_statement** | **object** | Income statement. The keys in this object can be any of the fields listed in the Income Statement section of the <a target=\"_blank\" href=\"https://polygon.io/blog/financials-api-glossary-of-fields\">financials API glossary of terms</a>. See the attributes of the objects within `balance_sheet` for more details. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /test/Model/DateTest.php: -------------------------------------------------------------------------------- 1 | markTestIncomplete('Not implemented'); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /docs/Model/SnapshotSummary200ResponseResultsInnerSession.md: -------------------------------------------------------------------------------- 1 | # # SnapshotSummary200ResponseResultsInnerSession 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **change** | **float** | The value of the price change for the asset from the previous trading day. | 8 | **change_percent** | **float** | The percent of the price change for the asset from the previous trading day. | 9 | **close** | **float** | The closing price of the asset for the day. | 10 | **early_trading_change** | **float** | Today's early trading change amount, difference between price and previous close if in early trading hours, otherwise difference between last price during early trading and previous close. | [optional] 11 | **early_trading_change_percent** | **float** | Today's early trading change as a percentage. | [optional] 12 | **high** | **float** | The highest price of the asset for the day. | 13 | **late_trading_change** | **float** | Today's late trading change amount, difference between price and today's close if in late trading hours, otherwise difference between last price during late trading and today's close. | [optional] 14 | **late_trading_change_percent** | **float** | Today's late trading change as a percentage. | [optional] 15 | **low** | **float** | The lowest price of the asset for the day. | 16 | **open** | **float** | The open price of the asset for the day. | 17 | **previous_close** | **float** | The closing price of the asset for the previous trading day. | 18 | **price** | **float** | The price of the most recent trade or bid price for this asset. | [optional] 19 | **volume** | **float** | The trading volume for the asset for the day. | [optional] 20 | 21 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Model/ListTickers200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListTickers200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Whether or not the asset is actively traded. False means the asset has been delisted. | [optional] 8 | **cik** | **string** | The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key). | [optional] 9 | **composite_figi** | **string** | The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) | [optional] 10 | **currency_name** | **string** | The name of the currency that this asset is traded with. | [optional] 11 | **delisted_utc** | **\DateTime** | The last date that the asset was traded. | [optional] 12 | **last_updated_utc** | **\DateTime** | The information is accurate up to this time. | [optional] 13 | **locale** | **string** | The locale of the asset. | 14 | **market** | **string** | The market type of the asset. | 15 | **name** | **string** | The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair. | 16 | **primary_exchange** | **string** | The ISO code of the primary listing exchange for this asset. | [optional] 17 | **share_class_figi** | **string** | The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) | [optional] 18 | **ticker** | **string** | The exchange symbol that this item is traded under. | 19 | **type** | **string** | The type of the asset. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). | [optional] 20 | 21 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **day** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerDay**](V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerDay.md) | | 8 | **fmv** | **float** | Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/contact\">contact us</a>. | [optional] 9 | **last_quote** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerLastQuote**](V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerLastQuote.md) | | 10 | **min** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerMin**](V2SnapshotLocaleGlobalMarketsForexTickersGet200ResponseAllOfTickersInnerMin.md) | | 11 | **prev_day** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerPrevDay**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerPrevDay.md) | | 12 | **ticker** | **string** | The exchange symbol that this item is traded under. | 13 | **todays_change** | **float** | The value of the change from the previous day. | 14 | **todays_change_perc** | **float** | The percentage change since the previous day. | 15 | **updated** | **int** | The last updated timestamp. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner.md: -------------------------------------------------------------------------------- 1 | # # V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **day** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerDay**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerDay.md) | | 8 | **fmv** | **float** | Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/contact\">contact us</a>. | [optional] 9 | **last_trade** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerLastTrade**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerLastTrade.md) | | 10 | **min** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerMin**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerMin.md) | | 11 | **prev_day** | [**\OpenAPI\Client\Model\V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerPrevDay**](V2SnapshotLocaleGlobalMarketsCryptoTickersGet200ResponseAllOfTickersInnerPrevDay.md) | | 12 | **ticker** | **string** | The exchange symbol that this item is traded under. | 13 | **todays_change** | **float** | The value of the change from the previous day. | 14 | **todays_change_perc** | **float** | The percentage change since the previous day. | 15 | **updated** | **int** | The last updated timestamp. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /test/Model/AskExchangeIdTest.php: -------------------------------------------------------------------------------- 1 | markTestIncomplete('Not implemented'); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /test/Model/BidExchangeIdTest.php: -------------------------------------------------------------------------------- 1 | markTestIncomplete('Not implemented'); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /docs/Model/ListFinancials200ResponseResultsInner.md: -------------------------------------------------------------------------------- 1 | # # ListFinancials200ResponseResultsInner 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **acceptance_datetime** | **mixed** | The datetime (EST timezone) the filing was accepted by EDGAR in YYYYMMDDHHMMSS format. | [optional] 8 | **cik** | **string** | The CIK number for the company. | 9 | **company_name** | **string** | The company name. | 10 | **end_date** | **string** | The end date of the period that these financials cover in YYYYMMDD format. | [optional] 11 | **filing_date** | **mixed** | The date that the SEC filing which these financials were derived from was made available. Note that this is not necessarily the date when this information became public, as some companies may publish a press release before filing with the SEC. | [optional] 12 | **financials** | [**\OpenAPI\Client\Model\ListFinancials200ResponseResultsInnerFinancials**](ListFinancials200ResponseResultsInnerFinancials.md) | | 13 | **fiscal_period** | **string** | Fiscal period of the report according to the company (Q1, Q2, Q3, Q4, or FY). | 14 | **fiscal_year** | **string** | Fiscal year of the report according to the company. | [optional] 15 | **source_filing_file_url** | **mixed** | The URL of the specific XBRL instance document within the SEC filing that these financials were derived from. | [optional] 16 | **source_filing_url** | **string** | The URL of the SEC filing that these financials were derived from. | [optional] 17 | **start_date** | **string** | The start date of the period that these financials cover in YYYYMMDD format. | [optional] 18 | **tickers** | **string[]** | The list of ticker symbols for the company. | [optional] 19 | **timeframe** | **string** | The timeframe of the report (quarterly, annual or ttm). | 20 | 21 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /test/Model/StocksV2NBBOAllOfXTest.php: -------------------------------------------------------------------------------- 1 | markTestIncomplete('Not implemented'); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /test/Api/FxquotesApiTest.php: -------------------------------------------------------------------------------- 1 | markTestIncomplete('Not implemented'); 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /test/Model/ListNewsPublishedUtcParameterTest.php: -------------------------------------------------------------------------------- 1 | markTestIncomplete('Not implemented'); 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /test/Api/ReferencenewsApiTest.php: -------------------------------------------------------------------------------- 1 | markTestIncomplete('Not implemented'); 84 | } 85 | } 86 | --------------------------------------------------------------------------------