Package: investor8-sdk
investor8-sdkInvestoreight API Documentation:https://api.investoreight.com/api-docs/index.htmlThis Python package is automatically generated by theSwagger Codegenproject:API version: 1.0.1Package version: 1.1.108Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
For more information, please visithttps://www.investoreight.comRequirements.Python 2.7 and 3.4+Installation & Usagepip installIf the python package is hosted on Github, you can install directly from Githubpipinstallgit+https://github.com/investoreight/investor8-sdk.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/investoreight/investor8-sdk.git)Then import the package:importinvestor8_sdkSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importinvestor8_sdkGetting StartedPlease follow theinstallation procedureand then run the following:from__future__importprint_functionimporttimeimportinvestor8_sdkfrominvestor8_sdk.restimportApiExceptionfrompprintimportpprint# Configure API key authorization: apiKeyconfiguration=investor8_sdk.Configuration()configuration.api_key['apiKey']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['apiKey'] = 'Bearer'# Configure API key authorization: bearerCoreAuthconfiguration=investor8_sdk.Configuration()configuration.api_key['Authorization']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['Authorization'] = 'Bearer'# create an instance of the API classapi_instance=investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))from_date='2013-10-20T19:20:30+01:00'# datetime |  (optional)to_date='2013-10-20T19:20:30+01:00'# datetime |  (optional)ticker='ticker_example'# str |  (optional)try:api_response=api_instance.get_earnings_by_date(from_date=from_date,to_date=to_date,ticker=ticker)pprint(api_response)exceptApiExceptionase:print("Exception when calling EarningsApi->get_earnings_by_date:%s\n"%e)# Configure API key authorization: apiKeyconfiguration=investor8_sdk.Configuration()configuration.api_key['apiKey']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['apiKey'] = 'Bearer'# Configure API key authorization: bearerCoreAuthconfiguration=investor8_sdk.Configuration()configuration.api_key['Authorization']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['Authorization'] = 'Bearer'# create an instance of the API classapi_instance=investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))ticker='ticker_example'# str |size=8# int |  (optional) (default to 8)try:api_response=api_instance.get_historical_earnings(ticker,size=size)pprint(api_response)exceptApiExceptionase:print("Exception when calling EarningsApi->get_historical_earnings:%s\n"%e)# Configure API key authorization: apiKeyconfiguration=investor8_sdk.Configuration()configuration.api_key['apiKey']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['apiKey'] = 'Bearer'# Configure API key authorization: bearerCoreAuthconfiguration=investor8_sdk.Configuration()configuration.api_key['Authorization']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['Authorization'] = 'Bearer'# create an instance of the API classapi_instance=investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))size=300# int |  (optional) (default to 300)refresh_cache=false# bool |  (optional) (default to false)try:api_response=api_instance.get_recent_earnings(size=size,refresh_cache=refresh_cache)pprint(api_response)exceptApiExceptionase:print("Exception when calling EarningsApi->get_recent_earnings:%s\n"%e)# Configure API key authorization: apiKeyconfiguration=investor8_sdk.Configuration()configuration.api_key['apiKey']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['apiKey'] = 'Bearer'# Configure API key authorization: bearerCoreAuthconfiguration=investor8_sdk.Configuration()configuration.api_key['Authorization']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['Authorization'] = 'Bearer'# create an instance of the API classapi_instance=investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))try:api_response=api_instance.get_today_earnings()pprint(api_response)exceptApiExceptionase:print("Exception when calling EarningsApi->get_today_earnings:%s\n"%e)# Configure API key authorization: apiKeyconfiguration=investor8_sdk.Configuration()configuration.api_key['apiKey']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['apiKey'] = 'Bearer'# Configure API key authorization: bearerCoreAuthconfiguration=investor8_sdk.Configuration()configuration.api_key['Authorization']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['Authorization'] = 'Bearer'# create an instance of the API classapi_instance=investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))ticker='ticker_example'# str |refresh_cache=false# bool |  (optional) (default to false)try:api_response=api_instance.get_upcoming_earning(ticker,refresh_cache=refresh_cache)pprint(api_response)exceptApiExceptionase:print("Exception when calling EarningsApi->get_upcoming_earning:%s\n"%e)# Configure API key authorization: apiKeyconfiguration=investor8_sdk.Configuration()configuration.api_key['apiKey']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['apiKey'] = 'Bearer'# Configure API key authorization: bearerCoreAuthconfiguration=investor8_sdk.Configuration()configuration.api_key['Authorization']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['Authorization'] = 'Bearer'# create an instance of the API classapi_instance=investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))size=300# int |  (optional) (default to 300)refresh_cache=false# bool |  (optional) (default to false)try:api_response=api_instance.get_upcoming_earnings(size=size,refresh_cache=refresh_cache)pprint(api_response)exceptApiExceptionase:print("Exception when calling EarningsApi->get_upcoming_earnings:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttps://api.investoreight.comClassMethodHTTP requestDescriptionEarningsApiget_earnings_by_dateGET/Earnings/by_dateEarningsApiget_historical_earningsGET/Earnings/historical/{ticker}EarningsApiget_recent_earningsGET/Earnings/recentEarningsApiget_today_earningsGET/Earnings/todayEarningsApiget_upcoming_earningGET/Earnings/upcoming/{ticker}EarningsApiget_upcoming_earningsGET/Earnings/upcoming/allFinancialsApiget_all_latest_financialsGET/Financials/all/latestFinancialsApiget_dict_available_standardized_financialsGET/Financials/available/{ticker}/dictFinancialsApiget_financials_by_idGET/Financials/byid/{id}FinancialsApiget_financials_singleGET/Financials/singleFinancialsApiget_historical_financialsGET/Financials/historical/{ticker}/{size}FinancialsApiget_latest_financialsGET/Financials/latest/{ticker}FinancialsApiget_latest_standardized_financialsGET/Financials/std/latest/{ticker}FinancialsApiget_list_available_standardized_financialsGET/Financials/available/{ticker}/listFinancialsApiget_list_standardized_financialsGET/Financials/list/{ticker}MetricsApiget_aggregated_earning_returnsGET/Metrics/earning/{tk_fyq}MetricsApiget_aggregated_earning_returns_by_tickerGET/Metrics/earning/ticker/{ticker}MetricsApiget_all_latest_daily_metricsGET/Metrics/daily/all/latestMetricsApiget_all_latest_financial_metricsGET/Metrics/financial/all/latestMetricsApiget_all_latest_value_metricsGET/Metrics/value/all/latestMetricsApiget_current_metricsGET/Metrics/currentMetricsApiget_current_momentumGET/Metrics/momentum/current/{ticker}MetricsApiget_distinct_metric_metadata_propertiesGET/Metrics/metadata/properties/distinctMetricsApiget_historical_daily_metricsGET/Metrics/historical/daily/{ticker}MetricsApiget_historical_growth_metricsGET/Metrics/growth/historical/{ticker}MetricsApiget_historical_indicatorsGET/Metrics/historical/indicators/{ticker}MetricsApiget_historical_metricsGET/Metrics/historicalMetricsApiget_historical_momentumGET/Metrics/momentum/historical/{ticker}MetricsApiget_historical_valueGET/Metrics/historical/value/{ticker}MetricsApiget_latest_financials_periodGET/Metrics/financials/latest/periodMetricsApiget_latest_growth_metricsGET/Metrics/growth/latest/{ticker}MetricsApiget_list_financial_metrics_metadataGET/Metrics/metadata/list/financialsMetricsApiget_list_metric_viewsGET/Metrics/view/listMetricsApiget_list_metrics_descriptionGET/Metrics/description/listMetricsApiget_list_metrics_metadataGET/Metrics/metadata/listMetricsApiget_market_index_returnsGET/Metrics/merket/returns/{ticker}MetricsApiget_metric_viewGET/Metrics/view/{id}MetricsApiget_metric_view_by_nameGET/Metrics/view/name/{name}MetricsApiget_metrics_by_periodGET/Metrics/byperiodMetricsApiget_metrics_metadataGET/Metrics/metadata/{name}MetricsApiget_metrics_statisticsGET/Metrics/statisticsMetricsApiget_monthly_returnsGET/Metrics/returns/monthly/{ticker}/{sinceYear}MetricsApiget_raw_historical_returnsGET/Metrics/earning/raw/historical/{ticker}MetricsApiget_sector_returnsGET/Metrics/sector/returnsNewsApigetGET/News/{id}NewsApiget_aggregated_ticker_newsGET/News/aggregated/{ticker}NewsApiget_all_sectors_newsGET/News/sector/all/{size}NewsApiget_latest_highlight_newsGET/News/highlight/latestNewsApiget_latest_newsGET/News/latestNewsApiget_list_highlights_by_idGET/News/highlight/list/byidNewsApiget_market_highlightGET/News/highlight/{id}NewsApiget_market_highlightsGET/News/highlight/listNewsApiget_news_by_categoryGET/News/list/{category}NewsApiget_news_by_sectorGET/News/sector/{sector}NewsApiget_news_categoriesGET/News/categoriesNewsApiget_news_listGET/News/list/filterNewsApiget_ticker_newsGET/News/stock/{ticker}NewsApiget_tickers_with_newsGET/News/tickersNewsApiget_top_newsGET/News/list/topPriceApiget_all_latest_pricesGET/Price/latest/allPriceApiget_all_previous_closesGET/Price/close/allPriceApiget_historical_pricesGET/Price/historicalPriceApiget_latest_market_indicesGET/Price/latest/market_indicesPriceApiget_latest_pricePOST/Price/latestPriceApiget_today_intraday_pricesGET/Price/intraday/todayScreenerApiget_all_sectors_returnsGET/Screener/sectors/all_returnsScreenerApiget_all_sectors_returns_today_saGET/Screener/sa/sector/returns/todayScreenerApiget_dow_tickersGET/Screener/dow/tickersScreenerApiget_list_ip_osGET/Screener/ipo/listScreenerApiget_list_screening_profilesGET/Screener/profile/listScreenerApiget_screening_profileGET/Screener/profile/{id}ScreenerApiget_screening_profile_by_nameGET/Screener/profile/name/{name}ScreenerApiget_top_stocksGET/Screener/top/{category}ScreenerApiget_upcoming_iposGET/Screener/ipo/upcomingScreenerApisearchGET/Screener/searchSearchApisearch_stocksGET/Search/{query}/{size}SettingsApicheck_i8t_versionGET/Settings/i8terminal/version/check/{version}SettingsApiget_i8t_versionGET/Settings/i8terminal/versionSettingsApiset_i8t_versionPUT/Settings/i8terminal/versionStockInfoApiget_all_active_companiesGET/StockInfo/companies/activeStockInfoApiget_all_stock_infoGET/StockInfo/all/{marketIndex}StockInfoApiget_all_stocks_popularityGET/StockInfo/popularity/allStockInfoApiget_company_infoGET/StockInfo/companyinfo/{ticker}StockInfoApiget_latest_ratingGET/StockInfo/rating/latest/{ticker}StockInfoApiget_list_exchange_sectorGET/StockInfo/list/exchangesectorStockInfoApiget_stock_infoGET/StockInfo/{ticker}StockInfoApiget_stock_info_listGET/StockInfo/listStockInfoApiget_stock_info_masterGET/StockInfo/{ticker}/masterStockInfoApiget_stock_info_multiGET/StockInfo/multiStockInfoApiget_stock_summaryGET/StockInfo/{ticker}/summaryStockInfoApiget_stock_summary_multiGET/StockInfo/summaryStockInfoApiget_stocks_popularityGET/StockInfo/popularityStockInfoApiget_stocks_popularity_by_sectorGET/StockInfo/popularity/bysectorStockInfoApiget_top_stocks_popularityGET/StockInfo/popularity/topStockInfoApiget_trading_calendarGET/StockInfo/calendarStockInfoApihealthy_checkGET/healthTagsApiget_all_tags_infoGET/Tags/all/infoTagsApiget_all_ticker_tagsGET/Tags/all/tickerTagsApiget_tag_detailsGET/Tags/{tagId}UserApiadd_to_watchlistPOST/User/watchlist/addUserApicreate_login_authentication_requestPOST/User/authentication/request/loginUserApicreate_plotPOST/User/plotUserApicreate_screenPOST/User/screenUserApicreate_watchlistPOST/User/watchlistUserApiget_aggregated_terminal_os_and_versionsGET/User/terminal/os/versionsUserApiget_rolesGET/User/rolesUserApiget_screenGET/User/screen/{id}UserApiget_screens_by_userGET/User/screen/byuser/{userId}UserApiget_terminal_logGET/User/terminal/log/{id}UserApiget_terminal_logsGET/User/terminal/list/logUserApiget_watchlistGET/User/watchlist/{id}UserApiget_watchlist_by_name_user_idGET/User/watchlist/bynameUserApiget_watchlists_by_userGET/User/watchlist/byuser/{userId}UserApilog_terminal_usagePOST/User/terminal/logUserApilogin_userPOST/User/loginUserApilogin_with_codePOST/User/login/codeUserApiremove_from_watchlistPOST/User/watchlist/removeDocumentation For ModelsActiveCompanyDtoAddToWatchlistDtoAuthenticationRequestAuthenticationSourceCompanyInfoDtoCreateAuthReqDtoCreatePlotDtoCreateScreenDtoCreateWatchlistDtoCurrentMetricsDtoCurrentMomentumMetricsDtoDailyMetricsDtoDetailedLatestPriceDtoDiscoverySourceEarningMetricsDtoFinancialMetricMetadataDtoFinancialReportDtoFinancialTagFinancialsGrowthGetListMetricViewsDtoGetListMetricsDescriptionDtoGetListMetricsMetadataDtoGetListScreeningProfilesDtoGetMetricViewDtoGetMetricsMetadataDtoGetScreeningProfileDtoGetScreensByUserDtoGetWatchlistsByUserDtoHistoricalDailyMetricsDtoHistoricalFinancialMetricsHistoricalIndicatorDtoHistoricalMetricValueDtoHistoricalReturnHistoricalReturnsDtoHistoricalValueMetricsHistoryLengthI8TerminalCheckVersionDtoI8TerminalVersionI8TerminalVersionDtoLatestFinancialMetricsDtoLatestFinancialsDtoLatestFinancialsWithGrowthDtoLatestPriceDtoListExchangeSectorDtoLogTerminalUsageLoginUserDtoLoginWithCodeDtoMarketHighlightDtoMarketHighlightStatusMetadataPropertiesDtoMetricGroupDtoMetricNameDtoMetricsMetricsByPeriodDtoMetricsMetadataResponseDtoMetricsStatisticsDtoMomentumMetricDtoMonthlyMetricsMonthlyReturnsNewsCategoriesDtoNewsSourcePeriodMetricValuePeriodReturnPlotResponseDtoPreviousCloseDtoProfileNameRecentEarningDtoRemoveFromWatchlistDtoReqTypeResultFieldReturnMetricsSAAttributesPricesSASectorPriceDtoScreenScreenDtoScreeningCategoryDtoSectorReturnsDtoStandardizedFinancialStockEarningDtoStockFinancialStockFinancialMetricsStockInfoDtoStockInfoMasterDtoStockIpoStockNewsStockNewsDetailsStockNewsStatusStockPopularityDetailsDtoStockPopularityDtoStockPriceStockPriceDtoStockRatingDtoStockSummaryDtoSymbolsCurrentMetricsDtoSymbolsHistoricalMetricsDtoTagDetailsDtoTagInfoDtoTerminalLogDtoTerminalLogOSVersionsDtoTradingCalendarDetailsDtoUpcomingEarningDtoUserDtoValueMetricsDtoWatchlistWatchlistDtoDocumentation For AuthorizationapiKeyType: API keyAPI key parameter name: apiKeyLocation: URL query stringbearerCoreAuthType: API keyAPI key parameter name: AuthorizationLocation: HTTP headerAuthorinfo@investoreight.com