investor8-sdk

Name	investor8-sdk JSON
Version	1.1.108 JSON
	download
home_page
Summary	Investoreight Core API
upload_time	2023-11-09 07:36:32
maintainer
docs_url	None
author
requires_python
license
keywords	swagger investoreight core api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI
coveralls test coverage	No coveralls.

            # investor8-sdk
Investoreight API Documentation:  https://api.investoreight.com/api-docs/index.html

This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.1
- Package version: 1.1.108
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
For more information, please visit [https://www.investoreight.com](https://www.investoreight.com)

## Requirements.

Python 2.7 and 3.4+

## Installation & Usage
### pip install

If the python package is hosted on Github, you can install directly from Github

```sh
pip install git+https://github.com/investoreight/investor8-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/investoreight/investor8-sdk.git`)

Then import the package:
```python
import investor8_sdk 
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import investor8_sdk
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
from __future__ import print_function
import time
import investor8_sdk
from investor8_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
configuration = 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: bearerCoreAuth
configuration = 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 class
api_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)
except ApiException as e:
    print("Exception when calling EarningsApi->get_earnings_by_date: %s\n" % e)

# Configure API key authorization: apiKey
configuration = 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: bearerCoreAuth
configuration = 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 class
api_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)
except ApiException as e:
    print("Exception when calling EarningsApi->get_historical_earnings: %s\n" % e)

# Configure API key authorization: apiKey
configuration = 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: bearerCoreAuth
configuration = 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 class
api_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)
except ApiException as e:
    print("Exception when calling EarningsApi->get_recent_earnings: %s\n" % e)

# Configure API key authorization: apiKey
configuration = 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: bearerCoreAuth
configuration = 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 class
api_instance = investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))

try:
    api_response = api_instance.get_today_earnings()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EarningsApi->get_today_earnings: %s\n" % e)

# Configure API key authorization: apiKey
configuration = 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: bearerCoreAuth
configuration = 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 class
api_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)
except ApiException as e:
    print("Exception when calling EarningsApi->get_upcoming_earning: %s\n" % e)

# Configure API key authorization: apiKey
configuration = 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: bearerCoreAuth
configuration = 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 class
api_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)
except ApiException as e:
    print("Exception when calling EarningsApi->get_upcoming_earnings: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *https://api.investoreight.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EarningsApi* | [**get_earnings_by_date**](docs/EarningsApi.md#get_earnings_by_date) | **GET** /Earnings/by_date | 
*EarningsApi* | [**get_historical_earnings**](docs/EarningsApi.md#get_historical_earnings) | **GET** /Earnings/historical/{ticker} | 
*EarningsApi* | [**get_recent_earnings**](docs/EarningsApi.md#get_recent_earnings) | **GET** /Earnings/recent | 
*EarningsApi* | [**get_today_earnings**](docs/EarningsApi.md#get_today_earnings) | **GET** /Earnings/today | 
*EarningsApi* | [**get_upcoming_earning**](docs/EarningsApi.md#get_upcoming_earning) | **GET** /Earnings/upcoming/{ticker} | 
*EarningsApi* | [**get_upcoming_earnings**](docs/EarningsApi.md#get_upcoming_earnings) | **GET** /Earnings/upcoming/all | 
*FinancialsApi* | [**get_all_latest_financials**](docs/FinancialsApi.md#get_all_latest_financials) | **GET** /Financials/all/latest | 
*FinancialsApi* | [**get_dict_available_standardized_financials**](docs/FinancialsApi.md#get_dict_available_standardized_financials) | **GET** /Financials/available/{ticker}/dict | 
*FinancialsApi* | [**get_financials_by_id**](docs/FinancialsApi.md#get_financials_by_id) | **GET** /Financials/byid/{id} | 
*FinancialsApi* | [**get_financials_single**](docs/FinancialsApi.md#get_financials_single) | **GET** /Financials/single | 
*FinancialsApi* | [**get_historical_financials**](docs/FinancialsApi.md#get_historical_financials) | **GET** /Financials/historical/{ticker}/{size} | 
*FinancialsApi* | [**get_latest_financials**](docs/FinancialsApi.md#get_latest_financials) | **GET** /Financials/latest/{ticker} | 
*FinancialsApi* | [**get_latest_standardized_financials**](docs/FinancialsApi.md#get_latest_standardized_financials) | **GET** /Financials/std/latest/{ticker} | 
*FinancialsApi* | [**get_list_available_standardized_financials**](docs/FinancialsApi.md#get_list_available_standardized_financials) | **GET** /Financials/available/{ticker}/list | 
*FinancialsApi* | [**get_list_standardized_financials**](docs/FinancialsApi.md#get_list_standardized_financials) | **GET** /Financials/list/{ticker} | 
*MetricsApi* | [**get_aggregated_earning_returns**](docs/MetricsApi.md#get_aggregated_earning_returns) | **GET** /Metrics/earning/{tk_fyq} | 
*MetricsApi* | [**get_aggregated_earning_returns_by_ticker**](docs/MetricsApi.md#get_aggregated_earning_returns_by_ticker) | **GET** /Metrics/earning/ticker/{ticker} | 
*MetricsApi* | [**get_all_latest_daily_metrics**](docs/MetricsApi.md#get_all_latest_daily_metrics) | **GET** /Metrics/daily/all/latest | 
*MetricsApi* | [**get_all_latest_financial_metrics**](docs/MetricsApi.md#get_all_latest_financial_metrics) | **GET** /Metrics/financial/all/latest | 
*MetricsApi* | [**get_all_latest_value_metrics**](docs/MetricsApi.md#get_all_latest_value_metrics) | **GET** /Metrics/value/all/latest | 
*MetricsApi* | [**get_current_metrics**](docs/MetricsApi.md#get_current_metrics) | **GET** /Metrics/current | 
*MetricsApi* | [**get_current_momentum**](docs/MetricsApi.md#get_current_momentum) | **GET** /Metrics/momentum/current/{ticker} | 
*MetricsApi* | [**get_distinct_metric_metadata_properties**](docs/MetricsApi.md#get_distinct_metric_metadata_properties) | **GET** /Metrics/metadata/properties/distinct | 
*MetricsApi* | [**get_historical_daily_metrics**](docs/MetricsApi.md#get_historical_daily_metrics) | **GET** /Metrics/historical/daily/{ticker} | 
*MetricsApi* | [**get_historical_growth_metrics**](docs/MetricsApi.md#get_historical_growth_metrics) | **GET** /Metrics/growth/historical/{ticker} | 
*MetricsApi* | [**get_historical_indicators**](docs/MetricsApi.md#get_historical_indicators) | **GET** /Metrics/historical/indicators/{ticker} | 
*MetricsApi* | [**get_historical_metrics**](docs/MetricsApi.md#get_historical_metrics) | **GET** /Metrics/historical | 
*MetricsApi* | [**get_historical_momentum**](docs/MetricsApi.md#get_historical_momentum) | **GET** /Metrics/momentum/historical/{ticker} | 
*MetricsApi* | [**get_historical_value**](docs/MetricsApi.md#get_historical_value) | **GET** /Metrics/historical/value/{ticker} | 
*MetricsApi* | [**get_latest_financials_period**](docs/MetricsApi.md#get_latest_financials_period) | **GET** /Metrics/financials/latest/period | 
*MetricsApi* | [**get_latest_growth_metrics**](docs/MetricsApi.md#get_latest_growth_metrics) | **GET** /Metrics/growth/latest/{ticker} | 
*MetricsApi* | [**get_list_financial_metrics_metadata**](docs/MetricsApi.md#get_list_financial_metrics_metadata) | **GET** /Metrics/metadata/list/financials | 
*MetricsApi* | [**get_list_metric_views**](docs/MetricsApi.md#get_list_metric_views) | **GET** /Metrics/view/list | 
*MetricsApi* | [**get_list_metrics_description**](docs/MetricsApi.md#get_list_metrics_description) | **GET** /Metrics/description/list | 
*MetricsApi* | [**get_list_metrics_metadata**](docs/MetricsApi.md#get_list_metrics_metadata) | **GET** /Metrics/metadata/list | 
*MetricsApi* | [**get_market_index_returns**](docs/MetricsApi.md#get_market_index_returns) | **GET** /Metrics/merket/returns/{ticker} | 
*MetricsApi* | [**get_metric_view**](docs/MetricsApi.md#get_metric_view) | **GET** /Metrics/view/{id} | 
*MetricsApi* | [**get_metric_view_by_name**](docs/MetricsApi.md#get_metric_view_by_name) | **GET** /Metrics/view/name/{name} | 
*MetricsApi* | [**get_metrics_by_period**](docs/MetricsApi.md#get_metrics_by_period) | **GET** /Metrics/byperiod | 
*MetricsApi* | [**get_metrics_metadata**](docs/MetricsApi.md#get_metrics_metadata) | **GET** /Metrics/metadata/{name} | 
*MetricsApi* | [**get_metrics_statistics**](docs/MetricsApi.md#get_metrics_statistics) | **GET** /Metrics/statistics | 
*MetricsApi* | [**get_monthly_returns**](docs/MetricsApi.md#get_monthly_returns) | **GET** /Metrics/returns/monthly/{ticker}/{sinceYear} | 
*MetricsApi* | [**get_raw_historical_returns**](docs/MetricsApi.md#get_raw_historical_returns) | **GET** /Metrics/earning/raw/historical/{ticker} | 
*MetricsApi* | [**get_sector_returns**](docs/MetricsApi.md#get_sector_returns) | **GET** /Metrics/sector/returns | 
*NewsApi* | [**get**](docs/NewsApi.md#get) | **GET** /News/{id} | 
*NewsApi* | [**get_aggregated_ticker_news**](docs/NewsApi.md#get_aggregated_ticker_news) | **GET** /News/aggregated/{ticker} | 
*NewsApi* | [**get_all_sectors_news**](docs/NewsApi.md#get_all_sectors_news) | **GET** /News/sector/all/{size} | 
*NewsApi* | [**get_latest_highlight_news**](docs/NewsApi.md#get_latest_highlight_news) | **GET** /News/highlight/latest | 
*NewsApi* | [**get_latest_news**](docs/NewsApi.md#get_latest_news) | **GET** /News/latest | 
*NewsApi* | [**get_list_highlights_by_id**](docs/NewsApi.md#get_list_highlights_by_id) | **GET** /News/highlight/list/byid | 
*NewsApi* | [**get_market_highlight**](docs/NewsApi.md#get_market_highlight) | **GET** /News/highlight/{id} | 
*NewsApi* | [**get_market_highlights**](docs/NewsApi.md#get_market_highlights) | **GET** /News/highlight/list | 
*NewsApi* | [**get_news_by_category**](docs/NewsApi.md#get_news_by_category) | **GET** /News/list/{category} | 
*NewsApi* | [**get_news_by_sector**](docs/NewsApi.md#get_news_by_sector) | **GET** /News/sector/{sector} | 
*NewsApi* | [**get_news_categories**](docs/NewsApi.md#get_news_categories) | **GET** /News/categories | 
*NewsApi* | [**get_news_list**](docs/NewsApi.md#get_news_list) | **GET** /News/list/filter | 
*NewsApi* | [**get_ticker_news**](docs/NewsApi.md#get_ticker_news) | **GET** /News/stock/{ticker} | 
*NewsApi* | [**get_tickers_with_news**](docs/NewsApi.md#get_tickers_with_news) | **GET** /News/tickers | 
*NewsApi* | [**get_top_news**](docs/NewsApi.md#get_top_news) | **GET** /News/list/top | 
*PriceApi* | [**get_all_latest_prices**](docs/PriceApi.md#get_all_latest_prices) | **GET** /Price/latest/all | 
*PriceApi* | [**get_all_previous_closes**](docs/PriceApi.md#get_all_previous_closes) | **GET** /Price/close/all | 
*PriceApi* | [**get_historical_prices**](docs/PriceApi.md#get_historical_prices) | **GET** /Price/historical | 
*PriceApi* | [**get_latest_market_indices**](docs/PriceApi.md#get_latest_market_indices) | **GET** /Price/latest/market_indices | 
*PriceApi* | [**get_latest_price**](docs/PriceApi.md#get_latest_price) | **POST** /Price/latest | 
*PriceApi* | [**get_today_intraday_prices**](docs/PriceApi.md#get_today_intraday_prices) | **GET** /Price/intraday/today | 
*ScreenerApi* | [**get_all_sectors_returns**](docs/ScreenerApi.md#get_all_sectors_returns) | **GET** /Screener/sectors/all_returns | 
*ScreenerApi* | [**get_all_sectors_returns_today_sa**](docs/ScreenerApi.md#get_all_sectors_returns_today_sa) | **GET** /Screener/sa/sector/returns/today | 
*ScreenerApi* | [**get_dow_tickers**](docs/ScreenerApi.md#get_dow_tickers) | **GET** /Screener/dow/tickers | 
*ScreenerApi* | [**get_list_ip_os**](docs/ScreenerApi.md#get_list_ip_os) | **GET** /Screener/ipo/list | 
*ScreenerApi* | [**get_list_screening_profiles**](docs/ScreenerApi.md#get_list_screening_profiles) | **GET** /Screener/profile/list | 
*ScreenerApi* | [**get_screening_profile**](docs/ScreenerApi.md#get_screening_profile) | **GET** /Screener/profile/{id} | 
*ScreenerApi* | [**get_screening_profile_by_name**](docs/ScreenerApi.md#get_screening_profile_by_name) | **GET** /Screener/profile/name/{name} | 
*ScreenerApi* | [**get_top_stocks**](docs/ScreenerApi.md#get_top_stocks) | **GET** /Screener/top/{category} | 
*ScreenerApi* | [**get_upcoming_ipos**](docs/ScreenerApi.md#get_upcoming_ipos) | **GET** /Screener/ipo/upcoming | 
*ScreenerApi* | [**search**](docs/ScreenerApi.md#search) | **GET** /Screener/search | 
*SearchApi* | [**search_stocks**](docs/SearchApi.md#search_stocks) | **GET** /Search/{query}/{size} | 
*SettingsApi* | [**check_i8t_version**](docs/SettingsApi.md#check_i8t_version) | **GET** /Settings/i8terminal/version/check/{version} | 
*SettingsApi* | [**get_i8t_version**](docs/SettingsApi.md#get_i8t_version) | **GET** /Settings/i8terminal/version | 
*SettingsApi* | [**set_i8t_version**](docs/SettingsApi.md#set_i8t_version) | **PUT** /Settings/i8terminal/version | 
*StockInfoApi* | [**get_all_active_companies**](docs/StockInfoApi.md#get_all_active_companies) | **GET** /StockInfo/companies/active | 
*StockInfoApi* | [**get_all_stock_info**](docs/StockInfoApi.md#get_all_stock_info) | **GET** /StockInfo/all/{marketIndex} | 
*StockInfoApi* | [**get_all_stocks_popularity**](docs/StockInfoApi.md#get_all_stocks_popularity) | **GET** /StockInfo/popularity/all | 
*StockInfoApi* | [**get_company_info**](docs/StockInfoApi.md#get_company_info) | **GET** /StockInfo/companyinfo/{ticker} | 
*StockInfoApi* | [**get_latest_rating**](docs/StockInfoApi.md#get_latest_rating) | **GET** /StockInfo/rating/latest/{ticker} | 
*StockInfoApi* | [**get_list_exchange_sector**](docs/StockInfoApi.md#get_list_exchange_sector) | **GET** /StockInfo/list/exchangesector | 
*StockInfoApi* | [**get_stock_info**](docs/StockInfoApi.md#get_stock_info) | **GET** /StockInfo/{ticker} | 
*StockInfoApi* | [**get_stock_info_list**](docs/StockInfoApi.md#get_stock_info_list) | **GET** /StockInfo/list | 
*StockInfoApi* | [**get_stock_info_master**](docs/StockInfoApi.md#get_stock_info_master) | **GET** /StockInfo/{ticker}/master | 
*StockInfoApi* | [**get_stock_info_multi**](docs/StockInfoApi.md#get_stock_info_multi) | **GET** /StockInfo/multi | 
*StockInfoApi* | [**get_stock_summary**](docs/StockInfoApi.md#get_stock_summary) | **GET** /StockInfo/{ticker}/summary | 
*StockInfoApi* | [**get_stock_summary_multi**](docs/StockInfoApi.md#get_stock_summary_multi) | **GET** /StockInfo/summary | 
*StockInfoApi* | [**get_stocks_popularity**](docs/StockInfoApi.md#get_stocks_popularity) | **GET** /StockInfo/popularity | 
*StockInfoApi* | [**get_stocks_popularity_by_sector**](docs/StockInfoApi.md#get_stocks_popularity_by_sector) | **GET** /StockInfo/popularity/bysector | 
*StockInfoApi* | [**get_top_stocks_popularity**](docs/StockInfoApi.md#get_top_stocks_popularity) | **GET** /StockInfo/popularity/top | 
*StockInfoApi* | [**get_trading_calendar**](docs/StockInfoApi.md#get_trading_calendar) | **GET** /StockInfo/calendar | 
*StockInfoApi* | [**healthy_check**](docs/StockInfoApi.md#healthy_check) | **GET** /health | 
*TagsApi* | [**get_all_tags_info**](docs/TagsApi.md#get_all_tags_info) | **GET** /Tags/all/info | 
*TagsApi* | [**get_all_ticker_tags**](docs/TagsApi.md#get_all_ticker_tags) | **GET** /Tags/all/ticker | 
*TagsApi* | [**get_tag_details**](docs/TagsApi.md#get_tag_details) | **GET** /Tags/{tagId} | 
*UserApi* | [**add_to_watchlist**](docs/UserApi.md#add_to_watchlist) | **POST** /User/watchlist/add | 
*UserApi* | [**create_login_authentication_request**](docs/UserApi.md#create_login_authentication_request) | **POST** /User/authentication/request/login | 
*UserApi* | [**create_plot**](docs/UserApi.md#create_plot) | **POST** /User/plot | 
*UserApi* | [**create_screen**](docs/UserApi.md#create_screen) | **POST** /User/screen | 
*UserApi* | [**create_watchlist**](docs/UserApi.md#create_watchlist) | **POST** /User/watchlist | 
*UserApi* | [**get_aggregated_terminal_os_and_versions**](docs/UserApi.md#get_aggregated_terminal_os_and_versions) | **GET** /User/terminal/os/versions | 
*UserApi* | [**get_roles**](docs/UserApi.md#get_roles) | **GET** /User/roles | 
*UserApi* | [**get_screen**](docs/UserApi.md#get_screen) | **GET** /User/screen/{id} | 
*UserApi* | [**get_screens_by_user**](docs/UserApi.md#get_screens_by_user) | **GET** /User/screen/byuser/{userId} | 
*UserApi* | [**get_terminal_log**](docs/UserApi.md#get_terminal_log) | **GET** /User/terminal/log/{id} | 
*UserApi* | [**get_terminal_logs**](docs/UserApi.md#get_terminal_logs) | **GET** /User/terminal/list/log | 
*UserApi* | [**get_watchlist**](docs/UserApi.md#get_watchlist) | **GET** /User/watchlist/{id} | 
*UserApi* | [**get_watchlist_by_name_user_id**](docs/UserApi.md#get_watchlist_by_name_user_id) | **GET** /User/watchlist/byname | 
*UserApi* | [**get_watchlists_by_user**](docs/UserApi.md#get_watchlists_by_user) | **GET** /User/watchlist/byuser/{userId} | 
*UserApi* | [**log_terminal_usage**](docs/UserApi.md#log_terminal_usage) | **POST** /User/terminal/log | 
*UserApi* | [**login_user**](docs/UserApi.md#login_user) | **POST** /User/login | 
*UserApi* | [**login_with_code**](docs/UserApi.md#login_with_code) | **POST** /User/login/code | 
*UserApi* | [**remove_from_watchlist**](docs/UserApi.md#remove_from_watchlist) | **POST** /User/watchlist/remove | 

## Documentation For Models

 - [ActiveCompanyDto](docs/ActiveCompanyDto.md)
 - [AddToWatchlistDto](docs/AddToWatchlistDto.md)
 - [AuthenticationRequest](docs/AuthenticationRequest.md)
 - [AuthenticationSource](docs/AuthenticationSource.md)
 - [CompanyInfoDto](docs/CompanyInfoDto.md)
 - [CreateAuthReqDto](docs/CreateAuthReqDto.md)
 - [CreatePlotDto](docs/CreatePlotDto.md)
 - [CreateScreenDto](docs/CreateScreenDto.md)
 - [CreateWatchlistDto](docs/CreateWatchlistDto.md)
 - [CurrentMetricsDto](docs/CurrentMetricsDto.md)
 - [CurrentMomentumMetricsDto](docs/CurrentMomentumMetricsDto.md)
 - [DailyMetricsDto](docs/DailyMetricsDto.md)
 - [DetailedLatestPriceDto](docs/DetailedLatestPriceDto.md)
 - [DiscoverySource](docs/DiscoverySource.md)
 - [EarningMetricsDto](docs/EarningMetricsDto.md)
 - [FinancialMetricMetadataDto](docs/FinancialMetricMetadataDto.md)
 - [FinancialReportDto](docs/FinancialReportDto.md)
 - [FinancialTag](docs/FinancialTag.md)
 - [FinancialsGrowth](docs/FinancialsGrowth.md)
 - [GetListMetricViewsDto](docs/GetListMetricViewsDto.md)
 - [GetListMetricsDescriptionDto](docs/GetListMetricsDescriptionDto.md)
 - [GetListMetricsMetadataDto](docs/GetListMetricsMetadataDto.md)
 - [GetListScreeningProfilesDto](docs/GetListScreeningProfilesDto.md)
 - [GetMetricViewDto](docs/GetMetricViewDto.md)
 - [GetMetricsMetadataDto](docs/GetMetricsMetadataDto.md)
 - [GetScreeningProfileDto](docs/GetScreeningProfileDto.md)
 - [GetScreensByUserDto](docs/GetScreensByUserDto.md)
 - [GetWatchlistsByUserDto](docs/GetWatchlistsByUserDto.md)
 - [HistoricalDailyMetricsDto](docs/HistoricalDailyMetricsDto.md)
 - [HistoricalFinancialMetrics](docs/HistoricalFinancialMetrics.md)
 - [HistoricalIndicatorDto](docs/HistoricalIndicatorDto.md)
 - [HistoricalMetricValueDto](docs/HistoricalMetricValueDto.md)
 - [HistoricalReturn](docs/HistoricalReturn.md)
 - [HistoricalReturnsDto](docs/HistoricalReturnsDto.md)
 - [HistoricalValueMetrics](docs/HistoricalValueMetrics.md)
 - [HistoryLength](docs/HistoryLength.md)
 - [I8TerminalCheckVersionDto](docs/I8TerminalCheckVersionDto.md)
 - [I8TerminalVersion](docs/I8TerminalVersion.md)
 - [I8TerminalVersionDto](docs/I8TerminalVersionDto.md)
 - [LatestFinancialMetricsDto](docs/LatestFinancialMetricsDto.md)
 - [LatestFinancialsDto](docs/LatestFinancialsDto.md)
 - [LatestFinancialsWithGrowthDto](docs/LatestFinancialsWithGrowthDto.md)
 - [LatestPriceDto](docs/LatestPriceDto.md)
 - [ListExchangeSectorDto](docs/ListExchangeSectorDto.md)
 - [LogTerminalUsage](docs/LogTerminalUsage.md)
 - [LoginUserDto](docs/LoginUserDto.md)
 - [LoginWithCodeDto](docs/LoginWithCodeDto.md)
 - [MarketHighlightDto](docs/MarketHighlightDto.md)
 - [MarketHighlightStatus](docs/MarketHighlightStatus.md)
 - [MetadataPropertiesDto](docs/MetadataPropertiesDto.md)
 - [MetricGroupDto](docs/MetricGroupDto.md)
 - [MetricNameDto](docs/MetricNameDto.md)
 - [Metrics](docs/Metrics.md)
 - [MetricsByPeriodDto](docs/MetricsByPeriodDto.md)
 - [MetricsMetadataResponseDto](docs/MetricsMetadataResponseDto.md)
 - [MetricsStatisticsDto](docs/MetricsStatisticsDto.md)
 - [MomentumMetricDto](docs/MomentumMetricDto.md)
 - [MonthlyMetrics](docs/MonthlyMetrics.md)
 - [MonthlyReturns](docs/MonthlyReturns.md)
 - [NewsCategoriesDto](docs/NewsCategoriesDto.md)
 - [NewsSource](docs/NewsSource.md)
 - [PeriodMetricValue](docs/PeriodMetricValue.md)
 - [PeriodReturn](docs/PeriodReturn.md)
 - [PlotResponseDto](docs/PlotResponseDto.md)
 - [PreviousCloseDto](docs/PreviousCloseDto.md)
 - [ProfileName](docs/ProfileName.md)
 - [RecentEarningDto](docs/RecentEarningDto.md)
 - [RemoveFromWatchlistDto](docs/RemoveFromWatchlistDto.md)
 - [ReqType](docs/ReqType.md)
 - [ResultField](docs/ResultField.md)
 - [ReturnMetrics](docs/ReturnMetrics.md)
 - [SAAttributesPrices](docs/SAAttributesPrices.md)
 - [SASectorPriceDto](docs/SASectorPriceDto.md)
 - [Screen](docs/Screen.md)
 - [ScreenDto](docs/ScreenDto.md)
 - [ScreeningCategoryDto](docs/ScreeningCategoryDto.md)
 - [SectorReturnsDto](docs/SectorReturnsDto.md)
 - [StandardizedFinancial](docs/StandardizedFinancial.md)
 - [StockEarningDto](docs/StockEarningDto.md)
 - [StockFinancial](docs/StockFinancial.md)
 - [StockFinancialMetrics](docs/StockFinancialMetrics.md)
 - [StockInfoDto](docs/StockInfoDto.md)
 - [StockInfoMasterDto](docs/StockInfoMasterDto.md)
 - [StockIpo](docs/StockIpo.md)
 - [StockNews](docs/StockNews.md)
 - [StockNewsDetails](docs/StockNewsDetails.md)
 - [StockNewsStatus](docs/StockNewsStatus.md)
 - [StockPopularityDetailsDto](docs/StockPopularityDetailsDto.md)
 - [StockPopularityDto](docs/StockPopularityDto.md)
 - [StockPrice](docs/StockPrice.md)
 - [StockPriceDto](docs/StockPriceDto.md)
 - [StockRatingDto](docs/StockRatingDto.md)
 - [StockSummaryDto](docs/StockSummaryDto.md)
 - [SymbolsCurrentMetricsDto](docs/SymbolsCurrentMetricsDto.md)
 - [SymbolsHistoricalMetricsDto](docs/SymbolsHistoricalMetricsDto.md)
 - [TagDetailsDto](docs/TagDetailsDto.md)
 - [TagInfoDto](docs/TagInfoDto.md)
 - [TerminalLogDto](docs/TerminalLogDto.md)
 - [TerminalLogOSVersionsDto](docs/TerminalLogOSVersionsDto.md)
 - [TradingCalendarDetailsDto](docs/TradingCalendarDetailsDto.md)
 - [UpcomingEarningDto](docs/UpcomingEarningDto.md)
 - [UserDto](docs/UserDto.md)
 - [ValueMetricsDto](docs/ValueMetricsDto.md)
 - [Watchlist](docs/Watchlist.md)
 - [WatchlistDto](docs/WatchlistDto.md)

## Documentation For Authorization


## apiKey

- **Type**: API key
- **API key parameter name**: apiKey
- **Location**: URL query string

## bearerCoreAuth

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Author

info@investoreight.com



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "investor8-sdk",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Swagger,Investoreight Core API",
    "author": "",
    "author_email": "info@investoreight.com",
    "download_url": "https://files.pythonhosted.org/packages/08/1d/831eb23c241ccdad078e1fbb417e105bcf2fb87f0d9abf87b97782c747ff/investor8-sdk-1.1.108.tar.gz",
    "platform": null,
    "description": "# investor8-sdk\nInvestoreight API Documentation:  https://api.investoreight.com/api-docs/index.html\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0.1\n- Package version: 1.1.108\n- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen\nFor more information, please visit [https://www.investoreight.com](https://www.investoreight.com)\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/investoreight/investor8-sdk.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/investoreight/investor8-sdk.git`)\n\nThen import the package:\n```python\nimport investor8_sdk \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport investor8_sdk\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport investor8_sdk\nfrom investor8_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Configure API key authorization: apiKey\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['apiKey'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['apiKey'] = 'Bearer'\n# Configure API key authorization: bearerCoreAuth\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['Authorization'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['Authorization'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))\nfrom_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)\nto_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)\nticker = 'ticker_example' # str |  (optional)\n\ntry:\n    api_response = api_instance.get_earnings_by_date(from_date=from_date, to_date=to_date, ticker=ticker)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling EarningsApi->get_earnings_by_date: %s\\n\" % e)\n\n# Configure API key authorization: apiKey\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['apiKey'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['apiKey'] = 'Bearer'\n# Configure API key authorization: bearerCoreAuth\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['Authorization'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['Authorization'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))\nticker = 'ticker_example' # str | \nsize = 8 # int |  (optional) (default to 8)\n\ntry:\n    api_response = api_instance.get_historical_earnings(ticker, size=size)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling EarningsApi->get_historical_earnings: %s\\n\" % e)\n\n# Configure API key authorization: apiKey\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['apiKey'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['apiKey'] = 'Bearer'\n# Configure API key authorization: bearerCoreAuth\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['Authorization'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['Authorization'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))\nsize = 300 # int |  (optional) (default to 300)\nrefresh_cache = false # bool |  (optional) (default to false)\n\ntry:\n    api_response = api_instance.get_recent_earnings(size=size, refresh_cache=refresh_cache)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling EarningsApi->get_recent_earnings: %s\\n\" % e)\n\n# Configure API key authorization: apiKey\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['apiKey'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['apiKey'] = 'Bearer'\n# Configure API key authorization: bearerCoreAuth\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['Authorization'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['Authorization'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))\n\ntry:\n    api_response = api_instance.get_today_earnings()\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling EarningsApi->get_today_earnings: %s\\n\" % e)\n\n# Configure API key authorization: apiKey\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['apiKey'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['apiKey'] = 'Bearer'\n# Configure API key authorization: bearerCoreAuth\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['Authorization'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['Authorization'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))\nticker = 'ticker_example' # str | \nrefresh_cache = false # bool |  (optional) (default to false)\n\ntry:\n    api_response = api_instance.get_upcoming_earning(ticker, refresh_cache=refresh_cache)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling EarningsApi->get_upcoming_earning: %s\\n\" % e)\n\n# Configure API key authorization: apiKey\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['apiKey'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['apiKey'] = 'Bearer'\n# Configure API key authorization: bearerCoreAuth\nconfiguration = investor8_sdk.Configuration()\nconfiguration.api_key['Authorization'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['Authorization'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = investor8_sdk.EarningsApi(investor8_sdk.ApiClient(configuration))\nsize = 300 # int |  (optional) (default to 300)\nrefresh_cache = false # bool |  (optional) (default to false)\n\ntry:\n    api_response = api_instance.get_upcoming_earnings(size=size, refresh_cache=refresh_cache)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling EarningsApi->get_upcoming_earnings: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.investoreight.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*EarningsApi* | [**get_earnings_by_date**](docs/EarningsApi.md#get_earnings_by_date) | **GET** /Earnings/by_date | \n*EarningsApi* | [**get_historical_earnings**](docs/EarningsApi.md#get_historical_earnings) | **GET** /Earnings/historical/{ticker} | \n*EarningsApi* | [**get_recent_earnings**](docs/EarningsApi.md#get_recent_earnings) | **GET** /Earnings/recent | \n*EarningsApi* | [**get_today_earnings**](docs/EarningsApi.md#get_today_earnings) | **GET** /Earnings/today | \n*EarningsApi* | [**get_upcoming_earning**](docs/EarningsApi.md#get_upcoming_earning) | **GET** /Earnings/upcoming/{ticker} | \n*EarningsApi* | [**get_upcoming_earnings**](docs/EarningsApi.md#get_upcoming_earnings) | **GET** /Earnings/upcoming/all | \n*FinancialsApi* | [**get_all_latest_financials**](docs/FinancialsApi.md#get_all_latest_financials) | **GET** /Financials/all/latest | \n*FinancialsApi* | [**get_dict_available_standardized_financials**](docs/FinancialsApi.md#get_dict_available_standardized_financials) | **GET** /Financials/available/{ticker}/dict | \n*FinancialsApi* | [**get_financials_by_id**](docs/FinancialsApi.md#get_financials_by_id) | **GET** /Financials/byid/{id} | \n*FinancialsApi* | [**get_financials_single**](docs/FinancialsApi.md#get_financials_single) | **GET** /Financials/single | \n*FinancialsApi* | [**get_historical_financials**](docs/FinancialsApi.md#get_historical_financials) | **GET** /Financials/historical/{ticker}/{size} | \n*FinancialsApi* | [**get_latest_financials**](docs/FinancialsApi.md#get_latest_financials) | **GET** /Financials/latest/{ticker} | \n*FinancialsApi* | [**get_latest_standardized_financials**](docs/FinancialsApi.md#get_latest_standardized_financials) | **GET** /Financials/std/latest/{ticker} | \n*FinancialsApi* | [**get_list_available_standardized_financials**](docs/FinancialsApi.md#get_list_available_standardized_financials) | **GET** /Financials/available/{ticker}/list | \n*FinancialsApi* | [**get_list_standardized_financials**](docs/FinancialsApi.md#get_list_standardized_financials) | **GET** /Financials/list/{ticker} | \n*MetricsApi* | [**get_aggregated_earning_returns**](docs/MetricsApi.md#get_aggregated_earning_returns) | **GET** /Metrics/earning/{tk_fyq} | \n*MetricsApi* | [**get_aggregated_earning_returns_by_ticker**](docs/MetricsApi.md#get_aggregated_earning_returns_by_ticker) | **GET** /Metrics/earning/ticker/{ticker} | \n*MetricsApi* | [**get_all_latest_daily_metrics**](docs/MetricsApi.md#get_all_latest_daily_metrics) | **GET** /Metrics/daily/all/latest | \n*MetricsApi* | [**get_all_latest_financial_metrics**](docs/MetricsApi.md#get_all_latest_financial_metrics) | **GET** /Metrics/financial/all/latest | \n*MetricsApi* | [**get_all_latest_value_metrics**](docs/MetricsApi.md#get_all_latest_value_metrics) | **GET** /Metrics/value/all/latest | \n*MetricsApi* | [**get_current_metrics**](docs/MetricsApi.md#get_current_metrics) | **GET** /Metrics/current | \n*MetricsApi* | [**get_current_momentum**](docs/MetricsApi.md#get_current_momentum) | **GET** /Metrics/momentum/current/{ticker} | \n*MetricsApi* | [**get_distinct_metric_metadata_properties**](docs/MetricsApi.md#get_distinct_metric_metadata_properties) | **GET** /Metrics/metadata/properties/distinct | \n*MetricsApi* | [**get_historical_daily_metrics**](docs/MetricsApi.md#get_historical_daily_metrics) | **GET** /Metrics/historical/daily/{ticker} | \n*MetricsApi* | [**get_historical_growth_metrics**](docs/MetricsApi.md#get_historical_growth_metrics) | **GET** /Metrics/growth/historical/{ticker} | \n*MetricsApi* | [**get_historical_indicators**](docs/MetricsApi.md#get_historical_indicators) | **GET** /Metrics/historical/indicators/{ticker} | \n*MetricsApi* | [**get_historical_metrics**](docs/MetricsApi.md#get_historical_metrics) | **GET** /Metrics/historical | \n*MetricsApi* | [**get_historical_momentum**](docs/MetricsApi.md#get_historical_momentum) | **GET** /Metrics/momentum/historical/{ticker} | \n*MetricsApi* | [**get_historical_value**](docs/MetricsApi.md#get_historical_value) | **GET** /Metrics/historical/value/{ticker} | \n*MetricsApi* | [**get_latest_financials_period**](docs/MetricsApi.md#get_latest_financials_period) | **GET** /Metrics/financials/latest/period | \n*MetricsApi* | [**get_latest_growth_metrics**](docs/MetricsApi.md#get_latest_growth_metrics) | **GET** /Metrics/growth/latest/{ticker} | \n*MetricsApi* | [**get_list_financial_metrics_metadata**](docs/MetricsApi.md#get_list_financial_metrics_metadata) | **GET** /Metrics/metadata/list/financials | \n*MetricsApi* | [**get_list_metric_views**](docs/MetricsApi.md#get_list_metric_views) | **GET** /Metrics/view/list | \n*MetricsApi* | [**get_list_metrics_description**](docs/MetricsApi.md#get_list_metrics_description) | **GET** /Metrics/description/list | \n*MetricsApi* | [**get_list_metrics_metadata**](docs/MetricsApi.md#get_list_metrics_metadata) | **GET** /Metrics/metadata/list | \n*MetricsApi* | [**get_market_index_returns**](docs/MetricsApi.md#get_market_index_returns) | **GET** /Metrics/merket/returns/{ticker} | \n*MetricsApi* | [**get_metric_view**](docs/MetricsApi.md#get_metric_view) | **GET** /Metrics/view/{id} | \n*MetricsApi* | [**get_metric_view_by_name**](docs/MetricsApi.md#get_metric_view_by_name) | **GET** /Metrics/view/name/{name} | \n*MetricsApi* | [**get_metrics_by_period**](docs/MetricsApi.md#get_metrics_by_period) | **GET** /Metrics/byperiod | \n*MetricsApi* | [**get_metrics_metadata**](docs/MetricsApi.md#get_metrics_metadata) | **GET** /Metrics/metadata/{name} | \n*MetricsApi* | [**get_metrics_statistics**](docs/MetricsApi.md#get_metrics_statistics) | **GET** /Metrics/statistics | \n*MetricsApi* | [**get_monthly_returns**](docs/MetricsApi.md#get_monthly_returns) | **GET** /Metrics/returns/monthly/{ticker}/{sinceYear} | \n*MetricsApi* | [**get_raw_historical_returns**](docs/MetricsApi.md#get_raw_historical_returns) | **GET** /Metrics/earning/raw/historical/{ticker} | \n*MetricsApi* | [**get_sector_returns**](docs/MetricsApi.md#get_sector_returns) | **GET** /Metrics/sector/returns | \n*NewsApi* | [**get**](docs/NewsApi.md#get) | **GET** /News/{id} | \n*NewsApi* | [**get_aggregated_ticker_news**](docs/NewsApi.md#get_aggregated_ticker_news) | **GET** /News/aggregated/{ticker} | \n*NewsApi* | [**get_all_sectors_news**](docs/NewsApi.md#get_all_sectors_news) | **GET** /News/sector/all/{size} | \n*NewsApi* | [**get_latest_highlight_news**](docs/NewsApi.md#get_latest_highlight_news) | **GET** /News/highlight/latest | \n*NewsApi* | [**get_latest_news**](docs/NewsApi.md#get_latest_news) | **GET** /News/latest | \n*NewsApi* | [**get_list_highlights_by_id**](docs/NewsApi.md#get_list_highlights_by_id) | **GET** /News/highlight/list/byid | \n*NewsApi* | [**get_market_highlight**](docs/NewsApi.md#get_market_highlight) | **GET** /News/highlight/{id} | \n*NewsApi* | [**get_market_highlights**](docs/NewsApi.md#get_market_highlights) | **GET** /News/highlight/list | \n*NewsApi* | [**get_news_by_category**](docs/NewsApi.md#get_news_by_category) | **GET** /News/list/{category} | \n*NewsApi* | [**get_news_by_sector**](docs/NewsApi.md#get_news_by_sector) | **GET** /News/sector/{sector} | \n*NewsApi* | [**get_news_categories**](docs/NewsApi.md#get_news_categories) | **GET** /News/categories | \n*NewsApi* | [**get_news_list**](docs/NewsApi.md#get_news_list) | **GET** /News/list/filter | \n*NewsApi* | [**get_ticker_news**](docs/NewsApi.md#get_ticker_news) | **GET** /News/stock/{ticker} | \n*NewsApi* | [**get_tickers_with_news**](docs/NewsApi.md#get_tickers_with_news) | **GET** /News/tickers | \n*NewsApi* | [**get_top_news**](docs/NewsApi.md#get_top_news) | **GET** /News/list/top | \n*PriceApi* | [**get_all_latest_prices**](docs/PriceApi.md#get_all_latest_prices) | **GET** /Price/latest/all | \n*PriceApi* | [**get_all_previous_closes**](docs/PriceApi.md#get_all_previous_closes) | **GET** /Price/close/all | \n*PriceApi* | [**get_historical_prices**](docs/PriceApi.md#get_historical_prices) | **GET** /Price/historical | \n*PriceApi* | [**get_latest_market_indices**](docs/PriceApi.md#get_latest_market_indices) | **GET** /Price/latest/market_indices | \n*PriceApi* | [**get_latest_price**](docs/PriceApi.md#get_latest_price) | **POST** /Price/latest | \n*PriceApi* | [**get_today_intraday_prices**](docs/PriceApi.md#get_today_intraday_prices) | **GET** /Price/intraday/today | \n*ScreenerApi* | [**get_all_sectors_returns**](docs/ScreenerApi.md#get_all_sectors_returns) | **GET** /Screener/sectors/all_returns | \n*ScreenerApi* | [**get_all_sectors_returns_today_sa**](docs/ScreenerApi.md#get_all_sectors_returns_today_sa) | **GET** /Screener/sa/sector/returns/today | \n*ScreenerApi* | [**get_dow_tickers**](docs/ScreenerApi.md#get_dow_tickers) | **GET** /Screener/dow/tickers | \n*ScreenerApi* | [**get_list_ip_os**](docs/ScreenerApi.md#get_list_ip_os) | **GET** /Screener/ipo/list | \n*ScreenerApi* | [**get_list_screening_profiles**](docs/ScreenerApi.md#get_list_screening_profiles) | **GET** /Screener/profile/list | \n*ScreenerApi* | [**get_screening_profile**](docs/ScreenerApi.md#get_screening_profile) | **GET** /Screener/profile/{id} | \n*ScreenerApi* | [**get_screening_profile_by_name**](docs/ScreenerApi.md#get_screening_profile_by_name) | **GET** /Screener/profile/name/{name} | \n*ScreenerApi* | [**get_top_stocks**](docs/ScreenerApi.md#get_top_stocks) | **GET** /Screener/top/{category} | \n*ScreenerApi* | [**get_upcoming_ipos**](docs/ScreenerApi.md#get_upcoming_ipos) | **GET** /Screener/ipo/upcoming | \n*ScreenerApi* | [**search**](docs/ScreenerApi.md#search) | **GET** /Screener/search | \n*SearchApi* | [**search_stocks**](docs/SearchApi.md#search_stocks) | **GET** /Search/{query}/{size} | \n*SettingsApi* | [**check_i8t_version**](docs/SettingsApi.md#check_i8t_version) | **GET** /Settings/i8terminal/version/check/{version} | \n*SettingsApi* | [**get_i8t_version**](docs/SettingsApi.md#get_i8t_version) | **GET** /Settings/i8terminal/version | \n*SettingsApi* | [**set_i8t_version**](docs/SettingsApi.md#set_i8t_version) | **PUT** /Settings/i8terminal/version | \n*StockInfoApi* | [**get_all_active_companies**](docs/StockInfoApi.md#get_all_active_companies) | **GET** /StockInfo/companies/active | \n*StockInfoApi* | [**get_all_stock_info**](docs/StockInfoApi.md#get_all_stock_info) | **GET** /StockInfo/all/{marketIndex} | \n*StockInfoApi* | [**get_all_stocks_popularity**](docs/StockInfoApi.md#get_all_stocks_popularity) | **GET** /StockInfo/popularity/all | \n*StockInfoApi* | [**get_company_info**](docs/StockInfoApi.md#get_company_info) | **GET** /StockInfo/companyinfo/{ticker} | \n*StockInfoApi* | [**get_latest_rating**](docs/StockInfoApi.md#get_latest_rating) | **GET** /StockInfo/rating/latest/{ticker} | \n*StockInfoApi* | [**get_list_exchange_sector**](docs/StockInfoApi.md#get_list_exchange_sector) | **GET** /StockInfo/list/exchangesector | \n*StockInfoApi* | [**get_stock_info**](docs/StockInfoApi.md#get_stock_info) | **GET** /StockInfo/{ticker} | \n*StockInfoApi* | [**get_stock_info_list**](docs/StockInfoApi.md#get_stock_info_list) | **GET** /StockInfo/list | \n*StockInfoApi* | [**get_stock_info_master**](docs/StockInfoApi.md#get_stock_info_master) | **GET** /StockInfo/{ticker}/master | \n*StockInfoApi* | [**get_stock_info_multi**](docs/StockInfoApi.md#get_stock_info_multi) | **GET** /StockInfo/multi | \n*StockInfoApi* | [**get_stock_summary**](docs/StockInfoApi.md#get_stock_summary) | **GET** /StockInfo/{ticker}/summary | \n*StockInfoApi* | [**get_stock_summary_multi**](docs/StockInfoApi.md#get_stock_summary_multi) | **GET** /StockInfo/summary | \n*StockInfoApi* | [**get_stocks_popularity**](docs/StockInfoApi.md#get_stocks_popularity) | **GET** /StockInfo/popularity | \n*StockInfoApi* | [**get_stocks_popularity_by_sector**](docs/StockInfoApi.md#get_stocks_popularity_by_sector) | **GET** /StockInfo/popularity/bysector | \n*StockInfoApi* | [**get_top_stocks_popularity**](docs/StockInfoApi.md#get_top_stocks_popularity) | **GET** /StockInfo/popularity/top | \n*StockInfoApi* | [**get_trading_calendar**](docs/StockInfoApi.md#get_trading_calendar) | **GET** /StockInfo/calendar | \n*StockInfoApi* | [**healthy_check**](docs/StockInfoApi.md#healthy_check) | **GET** /health | \n*TagsApi* | [**get_all_tags_info**](docs/TagsApi.md#get_all_tags_info) | **GET** /Tags/all/info | \n*TagsApi* | [**get_all_ticker_tags**](docs/TagsApi.md#get_all_ticker_tags) | **GET** /Tags/all/ticker | \n*TagsApi* | [**get_tag_details**](docs/TagsApi.md#get_tag_details) | **GET** /Tags/{tagId} | \n*UserApi* | [**add_to_watchlist**](docs/UserApi.md#add_to_watchlist) | **POST** /User/watchlist/add | \n*UserApi* | [**create_login_authentication_request**](docs/UserApi.md#create_login_authentication_request) | **POST** /User/authentication/request/login | \n*UserApi* | [**create_plot**](docs/UserApi.md#create_plot) | **POST** /User/plot | \n*UserApi* | [**create_screen**](docs/UserApi.md#create_screen) | **POST** /User/screen | \n*UserApi* | [**create_watchlist**](docs/UserApi.md#create_watchlist) | **POST** /User/watchlist | \n*UserApi* | [**get_aggregated_terminal_os_and_versions**](docs/UserApi.md#get_aggregated_terminal_os_and_versions) | **GET** /User/terminal/os/versions | \n*UserApi* | [**get_roles**](docs/UserApi.md#get_roles) | **GET** /User/roles | \n*UserApi* | [**get_screen**](docs/UserApi.md#get_screen) | **GET** /User/screen/{id} | \n*UserApi* | [**get_screens_by_user**](docs/UserApi.md#get_screens_by_user) | **GET** /User/screen/byuser/{userId} | \n*UserApi* | [**get_terminal_log**](docs/UserApi.md#get_terminal_log) | **GET** /User/terminal/log/{id} | \n*UserApi* | [**get_terminal_logs**](docs/UserApi.md#get_terminal_logs) | **GET** /User/terminal/list/log | \n*UserApi* | [**get_watchlist**](docs/UserApi.md#get_watchlist) | **GET** /User/watchlist/{id} | \n*UserApi* | [**get_watchlist_by_name_user_id**](docs/UserApi.md#get_watchlist_by_name_user_id) | **GET** /User/watchlist/byname | \n*UserApi* | [**get_watchlists_by_user**](docs/UserApi.md#get_watchlists_by_user) | **GET** /User/watchlist/byuser/{userId} | \n*UserApi* | [**log_terminal_usage**](docs/UserApi.md#log_terminal_usage) | **POST** /User/terminal/log | \n*UserApi* | [**login_user**](docs/UserApi.md#login_user) | **POST** /User/login | \n*UserApi* | [**login_with_code**](docs/UserApi.md#login_with_code) | **POST** /User/login/code | \n*UserApi* | [**remove_from_watchlist**](docs/UserApi.md#remove_from_watchlist) | **POST** /User/watchlist/remove | \n\n## Documentation For Models\n\n - [ActiveCompanyDto](docs/ActiveCompanyDto.md)\n - [AddToWatchlistDto](docs/AddToWatchlistDto.md)\n - [AuthenticationRequest](docs/AuthenticationRequest.md)\n - [AuthenticationSource](docs/AuthenticationSource.md)\n - [CompanyInfoDto](docs/CompanyInfoDto.md)\n - [CreateAuthReqDto](docs/CreateAuthReqDto.md)\n - [CreatePlotDto](docs/CreatePlotDto.md)\n - [CreateScreenDto](docs/CreateScreenDto.md)\n - [CreateWatchlistDto](docs/CreateWatchlistDto.md)\n - [CurrentMetricsDto](docs/CurrentMetricsDto.md)\n - [CurrentMomentumMetricsDto](docs/CurrentMomentumMetricsDto.md)\n - [DailyMetricsDto](docs/DailyMetricsDto.md)\n - [DetailedLatestPriceDto](docs/DetailedLatestPriceDto.md)\n - [DiscoverySource](docs/DiscoverySource.md)\n - [EarningMetricsDto](docs/EarningMetricsDto.md)\n - [FinancialMetricMetadataDto](docs/FinancialMetricMetadataDto.md)\n - [FinancialReportDto](docs/FinancialReportDto.md)\n - [FinancialTag](docs/FinancialTag.md)\n - [FinancialsGrowth](docs/FinancialsGrowth.md)\n - [GetListMetricViewsDto](docs/GetListMetricViewsDto.md)\n - [GetListMetricsDescriptionDto](docs/GetListMetricsDescriptionDto.md)\n - [GetListMetricsMetadataDto](docs/GetListMetricsMetadataDto.md)\n - [GetListScreeningProfilesDto](docs/GetListScreeningProfilesDto.md)\n - [GetMetricViewDto](docs/GetMetricViewDto.md)\n - [GetMetricsMetadataDto](docs/GetMetricsMetadataDto.md)\n - [GetScreeningProfileDto](docs/GetScreeningProfileDto.md)\n - [GetScreensByUserDto](docs/GetScreensByUserDto.md)\n - [GetWatchlistsByUserDto](docs/GetWatchlistsByUserDto.md)\n - [HistoricalDailyMetricsDto](docs/HistoricalDailyMetricsDto.md)\n - [HistoricalFinancialMetrics](docs/HistoricalFinancialMetrics.md)\n - [HistoricalIndicatorDto](docs/HistoricalIndicatorDto.md)\n - [HistoricalMetricValueDto](docs/HistoricalMetricValueDto.md)\n - [HistoricalReturn](docs/HistoricalReturn.md)\n - [HistoricalReturnsDto](docs/HistoricalReturnsDto.md)\n - [HistoricalValueMetrics](docs/HistoricalValueMetrics.md)\n - [HistoryLength](docs/HistoryLength.md)\n - [I8TerminalCheckVersionDto](docs/I8TerminalCheckVersionDto.md)\n - [I8TerminalVersion](docs/I8TerminalVersion.md)\n - [I8TerminalVersionDto](docs/I8TerminalVersionDto.md)\n - [LatestFinancialMetricsDto](docs/LatestFinancialMetricsDto.md)\n - [LatestFinancialsDto](docs/LatestFinancialsDto.md)\n - [LatestFinancialsWithGrowthDto](docs/LatestFinancialsWithGrowthDto.md)\n - [LatestPriceDto](docs/LatestPriceDto.md)\n - [ListExchangeSectorDto](docs/ListExchangeSectorDto.md)\n - [LogTerminalUsage](docs/LogTerminalUsage.md)\n - [LoginUserDto](docs/LoginUserDto.md)\n - [LoginWithCodeDto](docs/LoginWithCodeDto.md)\n - [MarketHighlightDto](docs/MarketHighlightDto.md)\n - [MarketHighlightStatus](docs/MarketHighlightStatus.md)\n - [MetadataPropertiesDto](docs/MetadataPropertiesDto.md)\n - [MetricGroupDto](docs/MetricGroupDto.md)\n - [MetricNameDto](docs/MetricNameDto.md)\n - [Metrics](docs/Metrics.md)\n - [MetricsByPeriodDto](docs/MetricsByPeriodDto.md)\n - [MetricsMetadataResponseDto](docs/MetricsMetadataResponseDto.md)\n - [MetricsStatisticsDto](docs/MetricsStatisticsDto.md)\n - [MomentumMetricDto](docs/MomentumMetricDto.md)\n - [MonthlyMetrics](docs/MonthlyMetrics.md)\n - [MonthlyReturns](docs/MonthlyReturns.md)\n - [NewsCategoriesDto](docs/NewsCategoriesDto.md)\n - [NewsSource](docs/NewsSource.md)\n - [PeriodMetricValue](docs/PeriodMetricValue.md)\n - [PeriodReturn](docs/PeriodReturn.md)\n - [PlotResponseDto](docs/PlotResponseDto.md)\n - [PreviousCloseDto](docs/PreviousCloseDto.md)\n - [ProfileName](docs/ProfileName.md)\n - [RecentEarningDto](docs/RecentEarningDto.md)\n - [RemoveFromWatchlistDto](docs/RemoveFromWatchlistDto.md)\n - [ReqType](docs/ReqType.md)\n - [ResultField](docs/ResultField.md)\n - [ReturnMetrics](docs/ReturnMetrics.md)\n - [SAAttributesPrices](docs/SAAttributesPrices.md)\n - [SASectorPriceDto](docs/SASectorPriceDto.md)\n - [Screen](docs/Screen.md)\n - [ScreenDto](docs/ScreenDto.md)\n - [ScreeningCategoryDto](docs/ScreeningCategoryDto.md)\n - [SectorReturnsDto](docs/SectorReturnsDto.md)\n - [StandardizedFinancial](docs/StandardizedFinancial.md)\n - [StockEarningDto](docs/StockEarningDto.md)\n - [StockFinancial](docs/StockFinancial.md)\n - [StockFinancialMetrics](docs/StockFinancialMetrics.md)\n - [StockInfoDto](docs/StockInfoDto.md)\n - [StockInfoMasterDto](docs/StockInfoMasterDto.md)\n - [StockIpo](docs/StockIpo.md)\n - [StockNews](docs/StockNews.md)\n - [StockNewsDetails](docs/StockNewsDetails.md)\n - [StockNewsStatus](docs/StockNewsStatus.md)\n - [StockPopularityDetailsDto](docs/StockPopularityDetailsDto.md)\n - [StockPopularityDto](docs/StockPopularityDto.md)\n - [StockPrice](docs/StockPrice.md)\n - [StockPriceDto](docs/StockPriceDto.md)\n - [StockRatingDto](docs/StockRatingDto.md)\n - [StockSummaryDto](docs/StockSummaryDto.md)\n - [SymbolsCurrentMetricsDto](docs/SymbolsCurrentMetricsDto.md)\n - [SymbolsHistoricalMetricsDto](docs/SymbolsHistoricalMetricsDto.md)\n - [TagDetailsDto](docs/TagDetailsDto.md)\n - [TagInfoDto](docs/TagInfoDto.md)\n - [TerminalLogDto](docs/TerminalLogDto.md)\n - [TerminalLogOSVersionsDto](docs/TerminalLogOSVersionsDto.md)\n - [TradingCalendarDetailsDto](docs/TradingCalendarDetailsDto.md)\n - [UpcomingEarningDto](docs/UpcomingEarningDto.md)\n - [UserDto](docs/UserDto.md)\n - [ValueMetricsDto](docs/ValueMetricsDto.md)\n - [Watchlist](docs/Watchlist.md)\n - [WatchlistDto](docs/WatchlistDto.md)\n\n## Documentation For Authorization\n\n\n## apiKey\n\n- **Type**: API key\n- **API key parameter name**: apiKey\n- **Location**: URL query string\n\n## bearerCoreAuth\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## Author\n\ninfo@investoreight.com\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Investoreight Core API",
    "version": "1.1.108",
    "project_urls": {
        "Bug Tracker": "https://github.com/investoreight/investor8-sdk/issues",
        "Documentation": "https://github.com/investoreight/investor8-sdk#readme",
        "Download": "https://github.com/investoreight/investor8-sdk/releases",
        "Homepage": "https://www.investoreight.com/",
        "Source Code": "https://github.com/investoreight/investor8-sdk"
    },
    "split_keywords": [
        "swagger",
        "investoreight core api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "081d831eb23c241ccdad078e1fbb417e105bcf2fb87f0d9abf87b97782c747ff",
                "md5": "f993d188904c44b45c8604a38199f887",
                "sha256": "0cdb15bd8c89d113eed8189b0958b8cbb0b942168752f8245a3d83ac280e1ce7"
            },
            "downloads": -1,
            "filename": "investor8-sdk-1.1.108.tar.gz",
            "has_sig": false,
            "md5_digest": "f993d188904c44b45c8604a38199f887",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 132699,
            "upload_time": "2023-11-09T07:36:32",
            "upload_time_iso_8601": "2023-11-09T07:36:32.830616Z",
            "url": "https://files.pythonhosted.org/packages/08/1d/831eb23c241ccdad078e1fbb417e105bcf2fb87f0d9abf87b97782c747ff/investor8-sdk-1.1.108.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-09 07:36:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "investoreight",
    "github_project": "investor8-sdk",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "investor8-sdk"
}