diff --git a/README.md b/README.md index 9b828bea..c3aee469 100644 --- a/README.md +++ b/README.md @@ -534,7 +534,6 @@ Class | Method | HTTP request | Description - [FundamentalSummary](docs/FundamentalSummary.md) - [HistoricalData](docs/HistoricalData.md) - [IchimokuKinkoHyoTechnicalValue](docs/IchimokuKinkoHyoTechnicalValue.md) - - [IndexConstituents](docs/IndexConstituents.md) - [InsiderTransaction](docs/InsiderTransaction.md) - [InsiderTransactionFiling](docs/InsiderTransactionFiling.md) - [InstitutionalHolding](docs/InstitutionalHolding.md) diff --git a/docs/ApiResponseIndexConstituents.md b/docs/ApiResponseIndexConstituents.md index f5b606f6..60fcab69 100644 --- a/docs/ApiResponseIndexConstituents.md +++ b/docs/ApiResponseIndexConstituents.md @@ -14,7 +14,7 @@ Name | Type | Description ------------ | ------------- | ------------- **index** | [**ApiResponseIndex**](ApiResponseIndex.md) | The index   **date** | date | The date when an update was last received for the index constituents   -**constituents** | [**IndexConstituents**](IndexConstituents.md) |   +**constituents** | [**list[SecuritySummary]**](SecuritySummary.md) |   [//]: # (END_DEFINITION) @@ -22,7 +22,7 @@ Name | Type | Description [//]: # (CONTAINED_CLASS:ApiResponseIndex) -[//]: # (CONTAINED_CLASS:IndexConstituents) +[//]: # (CONTAINED_CLASS:SecuritySummary) diff --git a/docs/CompanyApi.md b/docs/CompanyApi.md index b6c4eed9..30a5782e 100644 --- a/docs/CompanyApi.md +++ b/docs/CompanyApi.md @@ -588,8 +588,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_company_data_point_identifier_default$$' -tag = '$$v2_company_data_point_item_number_default$$' +identifier = 'AAPL' +tag = 'marketcap' response = intrinio.CompanyApi().get_company_data_point_number(identifier, tag) print(response) @@ -607,8 +607,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_company_data_point_identifier_description$$ |   - **tag** | str| $$v2_company_data_point_item_description$$ |   + **identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
[//]: # (END_PARAMETERS) @@ -665,8 +665,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_company_data_point_identifier_default$$' -tag = '$$v2_company_data_point_item_text_default$$' +identifier = 'AAPL' +tag = 'ceo' response = intrinio.CompanyApi().get_company_data_point_text(identifier, tag) print(response) @@ -684,8 +684,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_company_data_point_identifier_description$$ |   - **tag** | str| $$v2_company_data_point_item_description$$ |   + **identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
[//]: # (END_PARAMETERS) @@ -912,7 +912,7 @@ Name | Type | Description | Notes #### Historical Data for Company -$$v2_company_historical_data_description$$ +Returns historical values for the given `tag` and the Company with the given `identifier` [//]: # (END_OVERVIEW) @@ -928,8 +928,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_company_historical_data_identifier_default$$' -tag = '$$v2_company_historical_data_item_default$$' +identifier = 'AAPL' +tag = 'marketcap' frequency = 'daily' type = '' start_date = '2018-01-01' @@ -954,8 +954,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_company_historical_data_identifier_description$$ |   - **tag** | str| $$v2_company_historical_data_item_description$$ |   + **identifier** | str| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   **frequency** | str| Return historical data in the given frequency | [optional] [default to daily]   **type** | str| Return historical data for given fiscal period type | [optional]   **start_date** | date| Return historical data on or after this date | [optional]   diff --git a/docs/DataPointApi.md b/docs/DataPointApi.md index 918fa88d..037717c8 100644 --- a/docs/DataPointApi.md +++ b/docs/DataPointApi.md @@ -38,7 +38,7 @@ Method | HTTP request | Description #### Data Point (Number) -$$v2_data_point_number_description$$ +Returns a numeric value for the given `tag` and the entity with the given `identifier` [//]: # (END_OVERVIEW) @@ -54,8 +54,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_data_point_identifier_default$$' -tag = '$$v2_data_point_item_number_default$$' +identifier = 'AAPL' +tag = 'marketcap' response = intrinio.DataPointApi().get_data_point_number(identifier, tag) print(response) @@ -73,8 +73,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_data_point_identifier_description$$ |   - **tag** | str| $$v2_data_point_item_description$$ |   + **identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
[//]: # (END_PARAMETERS) @@ -115,7 +115,7 @@ Name | Type | Description | Notes #### Data Point (Text) -$$v2_data_point_text_description$$ +Returns a text value for the given `tag` for the Security with the given `identifier` [//]: # (END_OVERVIEW) @@ -131,8 +131,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_data_point_identifier_default$$' -tag = '$$v2_data_point_item_text_default$$' +identifier = 'AAPL' +tag = 'ceo' response = intrinio.DataPointApi().get_data_point_text(identifier, tag) print(response) @@ -150,8 +150,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_data_point_identifier_description$$ |   - **tag** | str| $$v2_data_point_item_description$$ |   + **identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
[//]: # (END_PARAMETERS) diff --git a/docs/FundamentalsApi.md b/docs/FundamentalsApi.md index 77929e76..316cc9ad 100644 --- a/docs/FundamentalsApi.md +++ b/docs/FundamentalsApi.md @@ -383,7 +383,7 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) id = 'AAPL-income_statement-2020-FY' -tag = '$$v2_data_point_item_text_default$$' +tag = 'ceo' response = intrinio.FundamentalsApi().get_fundamental_standardized_financials_dimensions(id, tag) print(response) @@ -402,7 +402,7 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | str| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |   - **tag** | str| $$v2_data_point_item_description$$ |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
[//]: # (END_PARAMETERS) diff --git a/docs/HistoricalDataApi.md b/docs/HistoricalDataApi.md index 85e90533..96fd120a 100644 --- a/docs/HistoricalDataApi.md +++ b/docs/HistoricalDataApi.md @@ -37,7 +37,7 @@ Method | HTTP request | Description #### Historical Data -$$v2_historical_data_description$$ +Returns historical values for the given `tag` and the entity represented by the given `identifier` [//]: # (END_OVERVIEW) @@ -53,8 +53,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_historical_data_identifier_default$$' -tag = '$$v2_historical_data_item_default$$' +identifier = 'AAPL' +tag = 'marketcap' frequency = 'daily' type = '' start_date = '2015-01-01' @@ -79,8 +79,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_historical_data_identifier_description$$ |   - **tag** | str| $$v2_historical_data_item_description$$ |   + **identifier** | str| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   **frequency** | str| Return historical data in the given frequency | [optional] [default to daily]   **type** | str| Filter by type, when applicable | [optional]   **start_date** | date| Get historical data on or after this date | [optional]   diff --git a/docs/IndexConstituents.md b/docs/IndexConstituents.md deleted file mode 100644 index c8773314..00000000 --- a/docs/IndexConstituents.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[//]: # (CLASS:IndexConstituents) - -[//]: # (KIND:object) - -### IndexConstituents - -#### Properties - -[//]: # (START_DEFINITION) - -Name | Type | Description ------------- | ------------- | ------------- - -[//]: # (END_DEFINITION) - - - diff --git a/docs/SecurityApi.md b/docs/SecurityApi.md index 5876d22f..9876906a 100644 --- a/docs/SecurityApi.md +++ b/docs/SecurityApi.md @@ -223,7 +223,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' response = intrinio.SecurityApi().get_security_by_id(identifier) print(response) @@ -282,7 +282,7 @@ Name | Type | Description | Notes #### Data Point (Number) for Security -$$v2_security_data_point_number_description$$ +Returns a numeric value for the given `tag` for the Security with the given `identifier` [//]: # (END_OVERVIEW) @@ -298,8 +298,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_security_data_point_identifier_default$$' -tag = '$$v2_security_data_point_item_number_default$$' +identifier = 'AAPL' +tag = 'close_price' response = intrinio.SecurityApi().get_security_data_point_number(identifier, tag) print(response) @@ -317,8 +317,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_security_data_point_identifier_description$$ |   - **tag** | str| $$v2_security_data_point_item_description$$ |   + **identifier** | str| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |  
[//]: # (END_PARAMETERS) @@ -359,7 +359,7 @@ Name | Type | Description | Notes #### Data Point (Text) for Security -$$v2_security_data_point_text_description$$ +Returns a text value for the given `tag` for the Security with the given `identifier` [//]: # (END_OVERVIEW) @@ -375,8 +375,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_security_data_point_identifier_default$$' -tag = '$$v2_security_data_point_item_text_default$$' +identifier = 'AAPL' +tag = 'figi' response = intrinio.SecurityApi().get_security_data_point_text(identifier, tag) print(response) @@ -394,7 +394,7 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_security_data_point_identifier_description$$ |   + **identifier** | str| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   **tag** | str| An Intrinio data tag ID or code-name |  
@@ -436,7 +436,7 @@ Name | Type | Description | Notes #### Historical Data for Security -$$v2_security_historical_data_description$$ +Returns historical values for the given `tag` and the Security with the given `identifier` [//]: # (END_OVERVIEW) @@ -452,8 +452,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_security_historical_data_identifier_default$$' -tag = '$$v2_security_historical_data_item_default$$' +identifier = 'AAPL' +tag = 'adj_close_price' frequency = 'daily' type = '' start_date = '2018-01-01' @@ -478,8 +478,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | str| $$v2_security_historical_data_identifier_description$$ |   - **tag** | str| $$v2_security_data_point_item_description$$ |   + **identifier** | str| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + **tag** | str| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |   **frequency** | str| Return historical data in the given frequency | [optional] [default to daily]   **type** | str| Filter by type, when applicable | [optional]   **start_date** | date| Get historical data on or after this date | [optional]   @@ -693,7 +693,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' next_page = '' response = intrinio.SecurityApi().get_security_insider_ownership(identifier, next_page=next_page) @@ -1001,7 +1001,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' interval_size = '15m' source = '' start_date = '2023-01-01' @@ -1082,7 +1082,7 @@ Name | Type | Description | Notes #### Intraday Stock Prices for Security -Deprecated. $$v2_security_intraday_prices_description$$ +Deprecated. Return intraday stock prices for the Security with the given `identifier` [//]: # (END_OVERVIEW) @@ -1098,7 +1098,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' source = '' start_date = '2018-01-01' start_time = '' @@ -1187,7 +1187,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' response = intrinio.SecurityApi().get_security_latest_dividend_record(identifier) print(response) @@ -1262,7 +1262,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' response = intrinio.SecurityApi().get_security_latest_earnings_record(identifier) print(response) @@ -1337,7 +1337,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -1420,7 +1420,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 22 start_date = '2018-01-01' end_date = '2019-01-01' @@ -1505,7 +1505,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -1590,7 +1590,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' short_period = 5 long_period = 34 start_date = '2018-01-01' @@ -1677,7 +1677,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -1762,7 +1762,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 standard_deviations = 2.0 price_key = 'close' @@ -1851,7 +1851,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 constant = 0.015 start_date = '2018-01-01' @@ -1938,7 +1938,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 start_date = '2018-01-01' end_date = '2019-01-01' @@ -2023,7 +2023,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 price_key = 'close' start_date = '2018-01-01' @@ -2110,7 +2110,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 price_key = 'close' start_date = '2018-01-01' @@ -2197,7 +2197,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 start_date = '2018-01-01' end_date = '2019-01-01' @@ -2282,7 +2282,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -2365,7 +2365,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' low_period = 9 medium_period = 26 high_period = 52 @@ -2454,7 +2454,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 10 start_date = '2018-01-01' end_date = '2019-01-01' @@ -2539,7 +2539,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' roc1 = 10 roc2 = 15 roc3 = 20 @@ -2640,7 +2640,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' fast_period = 12 slow_period = 26 signal_period = 9 @@ -2731,7 +2731,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -2816,7 +2816,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' ema_period = 9 sum_period = 25 start_date = '2018-01-01' @@ -2903,7 +2903,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -2986,7 +2986,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -3069,7 +3069,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 10 start_date = '2018-01-01' end_date = '2019-01-01' @@ -3154,7 +3154,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 price_key = 'close' start_date = '2018-01-01' @@ -3241,7 +3241,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 price_key = 'close' start_date = '2018-01-01' @@ -3328,7 +3328,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 signal_period = 3 start_date = '2018-01-01' @@ -3415,7 +3415,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 15 start_date = '2018-01-01' end_date = '2019-01-01' @@ -3500,7 +3500,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' low_period = 13 high_period = 25 price_key = 'close' @@ -3589,7 +3589,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' short_period = 7 medium_period = 14 long_period = 28 @@ -3684,7 +3684,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -3769,7 +3769,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -3852,7 +3852,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -3935,7 +3935,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -4020,7 +4020,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' active_only = False source = 'delayed_sip' next_page = '' @@ -4101,7 +4101,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' source = ['iex,delayed_sip'] response = intrinio.SecurityApi().get_security_realtime_price(identifier, source=source) @@ -4330,7 +4330,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -4413,7 +4413,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' frequency = 'daily' @@ -4686,7 +4686,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' page_size = 100 response = intrinio.SecurityApi().get_security_zacks_analyst_ratings(identifier, page_size=page_size) @@ -4779,7 +4779,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' date = '' response = intrinio.SecurityApi().get_security_zacks_analyst_ratings_snapshot(identifier, date=date) @@ -4856,7 +4856,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' page_size = 100 next_page = '' @@ -4935,7 +4935,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' page_size = 100 next_page = '' diff --git a/docs/StockExchangeApi.md b/docs/StockExchangeApi.md index f999d776..c32ce3ce 100644 --- a/docs/StockExchangeApi.md +++ b/docs/StockExchangeApi.md @@ -142,7 +142,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_mic_default$$' +identifier = 'USCOMP' response = intrinio.StockExchangeApi().get_stock_exchange_by_id(identifier) print(response) @@ -217,7 +217,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_mic_default$$' +identifier = 'USCOMP' min_price = 8.14 page_size = 100 source = 'delayed_sip' @@ -298,7 +298,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_mic_default$$' +identifier = 'USCOMP' min_price = 8.14 page_size = 100 source = 'delayed_sip' @@ -379,7 +379,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_mic_default$$' +identifier = 'USCOMP' date = '2018-08-14' page_size = 100 next_page = '' @@ -460,7 +460,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_mic_default$$' +identifier = 'USCOMP' date = '2018-08-14' start_date = '2020-08-14' end_date = '2022-08-14' @@ -549,7 +549,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_mic_default$$' +identifier = 'USCOMP' tickers = ['AAPL,MSFT,NVDA'] source = 'delayed_sip' active_only = '' @@ -630,7 +630,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_mic_default$$' +identifier = 'USCOMP' source = ['iex,delayed_sip'] active_only = '' traded_today = '' @@ -717,7 +717,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_mic_default$$' +identifier = 'USCOMP' page_size = 100 next_page = '' diff --git a/docs/TechnicalApi.md b/docs/TechnicalApi.md index 4bc78c89..28a3e027 100644 --- a/docs/TechnicalApi.md +++ b/docs/TechnicalApi.md @@ -83,7 +83,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -166,7 +166,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 22 start_date = '2018-01-01' end_date = '2019-01-01' @@ -251,7 +251,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -336,7 +336,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' short_period = 5 long_period = 34 start_date = '2018-01-01' @@ -423,7 +423,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -508,7 +508,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 standard_deviations = 2.0 price_key = 'close' @@ -597,7 +597,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 constant = 0.015 start_date = '2018-01-01' @@ -684,7 +684,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 start_date = '2018-01-01' end_date = '2019-01-01' @@ -769,7 +769,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 price_key = 'close' start_date = '2018-01-01' @@ -856,7 +856,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 price_key = 'close' start_date = '2018-01-01' @@ -943,7 +943,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 start_date = '2018-01-01' end_date = '2019-01-01' @@ -1028,7 +1028,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -1111,7 +1111,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' low_period = 9 medium_period = 26 high_period = 52 @@ -1200,7 +1200,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 10 start_date = '2018-01-01' end_date = '2019-01-01' @@ -1285,7 +1285,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' roc1 = 10 roc2 = 15 roc3 = 20 @@ -1386,7 +1386,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' fast_period = 12 slow_period = 26 signal_period = 9 @@ -1477,7 +1477,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -1562,7 +1562,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' ema_period = 9 sum_period = 25 start_date = '2018-01-01' @@ -1649,7 +1649,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -1732,7 +1732,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -1815,7 +1815,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 10 start_date = '2018-01-01' end_date = '2019-01-01' @@ -1900,7 +1900,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 price_key = 'close' start_date = '2018-01-01' @@ -1987,7 +1987,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 20 price_key = 'close' start_date = '2018-01-01' @@ -2074,7 +2074,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 signal_period = 3 start_date = '2018-01-01' @@ -2161,7 +2161,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 15 start_date = '2018-01-01' end_date = '2019-01-01' @@ -2246,7 +2246,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' low_period = 13 high_period = 25 price_key = 'close' @@ -2335,7 +2335,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' short_period = 7 medium_period = 14 long_period = 28 @@ -2430,7 +2430,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' @@ -2515,7 +2515,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -2598,7 +2598,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' start_date = '2018-01-01' end_date = '2019-01-01' page_size = 100 @@ -2681,7 +2681,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' period = 14 start_date = '2018-01-01' end_date = '2019-01-01' diff --git a/docs/ZacksApi.md b/docs/ZacksApi.md index f16c76dd..89aec515 100644 --- a/docs/ZacksApi.md +++ b/docs/ZacksApi.md @@ -67,7 +67,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '$$v2_ticker_default$$' +identifier = 'AAPL' page_size = 100 next_page = '' diff --git a/intrinio_sdk/__init__.py b/intrinio_sdk/__init__.py index bda65bb7..b17c74e0 100644 --- a/intrinio_sdk/__init__.py +++ b/intrinio_sdk/__init__.py @@ -234,7 +234,6 @@ from intrinio_sdk.models.fundamental_summary import FundamentalSummary from intrinio_sdk.models.historical_data import HistoricalData from intrinio_sdk.models.ichimoku_kinko_hyo_technical_value import IchimokuKinkoHyoTechnicalValue -from intrinio_sdk.models.index_constituents import IndexConstituents from intrinio_sdk.models.insider_transaction import InsiderTransaction from intrinio_sdk.models.insider_transaction_filing import InsiderTransactionFiling from intrinio_sdk.models.institutional_holding import InstitutionalHolding diff --git a/intrinio_sdk/api/company_api.py b/intrinio_sdk/api/company_api.py index ea6bc484..095b48f0 100644 --- a/intrinio_sdk/api/company_api.py +++ b/intrinio_sdk/api/company_api.py @@ -741,8 +741,8 @@ def get_company_data_point_number(self, identifier, tag, **kwargs): # noqa: E50 >>> result = thread.get() :param async bool - :param str identifier: $$v2_company_data_point_identifier_description$$ (required) - :param str tag: $$v2_company_data_point_item_description$$ (required) + :param str identifier: A Company identifier (Ticker, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: float If the method is called asynchronously, returns the request thread. @@ -764,8 +764,8 @@ def get_company_data_point_number_with_http_info(self, identifier, tag, **kwargs >>> result = thread.get() :param async bool - :param str identifier: $$v2_company_data_point_identifier_description$$ (required) - :param str tag: $$v2_company_data_point_item_description$$ (required) + :param str identifier: A Company identifier (Ticker, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: float If the method is called asynchronously, returns the request thread. @@ -844,8 +844,8 @@ def get_company_data_point_text(self, identifier, tag, **kwargs): # noqa: E501 >>> result = thread.get() :param async bool - :param str identifier: $$v2_company_data_point_identifier_description$$ (required) - :param str tag: $$v2_company_data_point_item_description$$ (required) + :param str identifier: A Company identifier (Ticker, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: str If the method is called asynchronously, returns the request thread. @@ -867,8 +867,8 @@ def get_company_data_point_text_with_http_info(self, identifier, tag, **kwargs): >>> result = thread.get() :param async bool - :param str identifier: $$v2_company_data_point_identifier_description$$ (required) - :param str tag: $$v2_company_data_point_item_description$$ (required) + :param str identifier: A Company identifier (Ticker, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: str If the method is called asynchronously, returns the request thread. @@ -1206,15 +1206,15 @@ def get_company_fundamentals_with_http_info(self, identifier, **kwargs): # noqa def get_company_historical_data(self, identifier, tag, **kwargs): # noqa: E501 """Historical Data for Company # noqa: E501 - $$v2_company_historical_data_description$$ # noqa: E501 + Returns historical values for the given `tag` and the Company with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_company_historical_data(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_company_historical_data_identifier_description$$ (required) - :param str tag: $$v2_company_historical_data_item_description$$ (required) + :param str identifier: A Company identifier (Ticker, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :param str frequency: Return historical data in the given frequency :param str type: Return historical data for given fiscal period type :param date start_date: Return historical data on or after this date @@ -1236,15 +1236,15 @@ def get_company_historical_data(self, identifier, tag, **kwargs): # noqa: E501 def get_company_historical_data_with_http_info(self, identifier, tag, **kwargs): # noqa: E501 """Historical Data for Company # noqa: E501 - $$v2_company_historical_data_description$$ # noqa: E501 + Returns historical values for the given `tag` and the Company with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_company_historical_data_with_http_info(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_company_historical_data_identifier_description$$ (required) - :param str tag: $$v2_company_historical_data_item_description$$ (required) + :param str identifier: A Company identifier (Ticker, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :param str frequency: Return historical data in the given frequency :param str type: Return historical data for given fiscal period type :param date start_date: Return historical data on or after this date diff --git a/intrinio_sdk/api/data_point_api.py b/intrinio_sdk/api/data_point_api.py index c794f720..7b6f81bd 100644 --- a/intrinio_sdk/api/data_point_api.py +++ b/intrinio_sdk/api/data_point_api.py @@ -36,15 +36,15 @@ def __init__(self, api_client=None): def get_data_point_number(self, identifier, tag, **kwargs): # noqa: E501 """Data Point (Number) # noqa: E501 - $$v2_data_point_number_description$$ # noqa: E501 + Returns a numeric value for the given `tag` and the entity with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_data_point_number(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_data_point_identifier_description$$ (required) - :param str tag: $$v2_data_point_item_description$$ (required) + :param str identifier: An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: float If the method is called asynchronously, returns the request thread. @@ -59,15 +59,15 @@ def get_data_point_number(self, identifier, tag, **kwargs): # noqa: E501 def get_data_point_number_with_http_info(self, identifier, tag, **kwargs): # noqa: E501 """Data Point (Number) # noqa: E501 - $$v2_data_point_number_description$$ # noqa: E501 + Returns a numeric value for the given `tag` and the entity with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_data_point_number_with_http_info(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_data_point_identifier_description$$ (required) - :param str tag: $$v2_data_point_item_description$$ (required) + :param str identifier: An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: float If the method is called asynchronously, returns the request thread. @@ -139,15 +139,15 @@ def get_data_point_number_with_http_info(self, identifier, tag, **kwargs): # no def get_data_point_text(self, identifier, tag, **kwargs): # noqa: E501 """Data Point (Text) # noqa: E501 - $$v2_data_point_text_description$$ # noqa: E501 + Returns a text value for the given `tag` for the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_data_point_text(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_data_point_identifier_description$$ (required) - :param str tag: $$v2_data_point_item_description$$ (required) + :param str identifier: An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: str If the method is called asynchronously, returns the request thread. @@ -162,15 +162,15 @@ def get_data_point_text(self, identifier, tag, **kwargs): # noqa: E501 def get_data_point_text_with_http_info(self, identifier, tag, **kwargs): # noqa: E501 """Data Point (Text) # noqa: E501 - $$v2_data_point_text_description$$ # noqa: E501 + Returns a text value for the given `tag` for the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_data_point_text_with_http_info(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_data_point_identifier_description$$ (required) - :param str tag: $$v2_data_point_item_description$$ (required) + :param str identifier: An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: str If the method is called asynchronously, returns the request thread. diff --git a/intrinio_sdk/api/fundamentals_api.py b/intrinio_sdk/api/fundamentals_api.py index 04adeefa..d25526db 100644 --- a/intrinio_sdk/api/fundamentals_api.py +++ b/intrinio_sdk/api/fundamentals_api.py @@ -468,7 +468,7 @@ def get_fundamental_standardized_financials_dimensions(self, id, tag, **kwargs): :param async bool :param str id: The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental (required) - :param str tag: $$v2_data_point_item_description$$ (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: ApiResponseStandardizedFinancialsDimensions If the method is called asynchronously, returns the request thread. @@ -491,7 +491,7 @@ def get_fundamental_standardized_financials_dimensions_with_http_info(self, id, :param async bool :param str id: The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental (required) - :param str tag: $$v2_data_point_item_description$$ (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: ApiResponseStandardizedFinancialsDimensions If the method is called asynchronously, returns the request thread. diff --git a/intrinio_sdk/api/historical_data_api.py b/intrinio_sdk/api/historical_data_api.py index 7005bacf..b2bc2992 100644 --- a/intrinio_sdk/api/historical_data_api.py +++ b/intrinio_sdk/api/historical_data_api.py @@ -36,15 +36,15 @@ def __init__(self, api_client=None): def get_historical_data(self, identifier, tag, **kwargs): # noqa: E501 """Historical Data # noqa: E501 - $$v2_historical_data_description$$ # noqa: E501 + Returns historical values for the given `tag` and the entity represented by the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_historical_data(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_historical_data_identifier_description$$ (required) - :param str tag: $$v2_historical_data_item_description$$ (required) + :param str identifier: An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :param str frequency: Return historical data in the given frequency :param str type: Filter by type, when applicable :param date start_date: Get historical data on or after this date @@ -66,15 +66,15 @@ def get_historical_data(self, identifier, tag, **kwargs): # noqa: E501 def get_historical_data_with_http_info(self, identifier, tag, **kwargs): # noqa: E501 """Historical Data # noqa: E501 - $$v2_historical_data_description$$ # noqa: E501 + Returns historical values for the given `tag` and the entity represented by the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_historical_data_with_http_info(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_historical_data_identifier_description$$ (required) - :param str tag: $$v2_historical_data_item_description$$ (required) + :param str identifier: An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :param str frequency: Return historical data in the given frequency :param str type: Filter by type, when applicable :param date start_date: Get historical data on or after this date diff --git a/intrinio_sdk/api/security_api.py b/intrinio_sdk/api/security_api.py index 0765cbe4..67ae92f1 100644 --- a/intrinio_sdk/api/security_api.py +++ b/intrinio_sdk/api/security_api.py @@ -296,15 +296,15 @@ def get_security_by_id_with_http_info(self, identifier, **kwargs): # noqa: E501 def get_security_data_point_number(self, identifier, tag, **kwargs): # noqa: E501 """Data Point (Number) for Security # noqa: E501 - $$v2_security_data_point_number_description$$ # noqa: E501 + Returns a numeric value for the given `tag` for the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_security_data_point_number(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_security_data_point_identifier_description$$ (required) - :param str tag: $$v2_security_data_point_item_description$$ (required) + :param str identifier: A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: float If the method is called asynchronously, returns the request thread. @@ -319,15 +319,15 @@ def get_security_data_point_number(self, identifier, tag, **kwargs): # noqa: E5 def get_security_data_point_number_with_http_info(self, identifier, tag, **kwargs): # noqa: E501 """Data Point (Number) for Security # noqa: E501 - $$v2_security_data_point_number_description$$ # noqa: E501 + Returns a numeric value for the given `tag` for the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_security_data_point_number_with_http_info(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_security_data_point_identifier_description$$ (required) - :param str tag: $$v2_security_data_point_item_description$$ (required) + :param str identifier: A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :return: float If the method is called asynchronously, returns the request thread. @@ -399,14 +399,14 @@ def get_security_data_point_number_with_http_info(self, identifier, tag, **kwarg def get_security_data_point_text(self, identifier, tag, **kwargs): # noqa: E501 """Data Point (Text) for Security # noqa: E501 - $$v2_security_data_point_text_description$$ # noqa: E501 + Returns a text value for the given `tag` for the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_security_data_point_text(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_security_data_point_identifier_description$$ (required) + :param str identifier: A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) (required) :param str tag: An Intrinio data tag ID or code-name (required) :return: str If the method is called asynchronously, @@ -422,14 +422,14 @@ def get_security_data_point_text(self, identifier, tag, **kwargs): # noqa: E501 def get_security_data_point_text_with_http_info(self, identifier, tag, **kwargs): # noqa: E501 """Data Point (Text) for Security # noqa: E501 - $$v2_security_data_point_text_description$$ # noqa: E501 + Returns a text value for the given `tag` for the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_security_data_point_text_with_http_info(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_security_data_point_identifier_description$$ (required) + :param str identifier: A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) (required) :param str tag: An Intrinio data tag ID or code-name (required) :return: str If the method is called asynchronously, @@ -502,15 +502,15 @@ def get_security_data_point_text_with_http_info(self, identifier, tag, **kwargs) def get_security_historical_data(self, identifier, tag, **kwargs): # noqa: E501 """Historical Data for Security # noqa: E501 - $$v2_security_historical_data_description$$ # noqa: E501 + Returns historical values for the given `tag` and the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_security_historical_data(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_security_historical_data_identifier_description$$ (required) - :param str tag: $$v2_security_data_point_item_description$$ (required) + :param str identifier: A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :param str frequency: Return historical data in the given frequency :param str type: Filter by type, when applicable :param date start_date: Get historical data on or after this date @@ -532,15 +532,15 @@ def get_security_historical_data(self, identifier, tag, **kwargs): # noqa: E501 def get_security_historical_data_with_http_info(self, identifier, tag, **kwargs): # noqa: E501 """Historical Data for Security # noqa: E501 - $$v2_security_historical_data_description$$ # noqa: E501 + Returns historical values for the given `tag` and the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_security_historical_data_with_http_info(identifier, tag, _async=True) >>> result = thread.get() :param async bool - :param str identifier: $$v2_security_historical_data_identifier_description$$ (required) - :param str tag: $$v2_security_data_point_item_description$$ (required) + :param str identifier: A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) (required) + :param str tag: An Intrinio data tag ID or code (reference) (required) :param str frequency: Return historical data in the given frequency :param str type: Filter by type, when applicable :param date start_date: Get historical data on or after this date @@ -1352,7 +1352,7 @@ def get_security_interval_prices_with_http_info(self, identifier, interval_size, def get_security_intraday_prices(self, identifier, **kwargs): # noqa: E501 """Intraday Stock Prices for Security # noqa: E501 - Deprecated. $$v2_security_intraday_prices_description$$ # noqa: E501 + Deprecated. Return intraday stock prices for the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_security_intraday_prices(identifier, _async=True) @@ -1381,7 +1381,7 @@ def get_security_intraday_prices(self, identifier, **kwargs): # noqa: E501 def get_security_intraday_prices_with_http_info(self, identifier, **kwargs): # noqa: E501 """Intraday Stock Prices for Security # noqa: E501 - Deprecated. $$v2_security_intraday_prices_description$$ # noqa: E501 + Deprecated. Return intraday stock prices for the Security with the given `identifier` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async=True >>> thread = api.get_security_intraday_prices_with_http_info(identifier, _async=True) diff --git a/intrinio_sdk/models/__init__.py b/intrinio_sdk/models/__init__.py index 3cc61266..15a1675b 100644 --- a/intrinio_sdk/models/__init__.py +++ b/intrinio_sdk/models/__init__.py @@ -208,7 +208,6 @@ from intrinio_sdk.models.fundamental_summary import FundamentalSummary from intrinio_sdk.models.historical_data import HistoricalData from intrinio_sdk.models.ichimoku_kinko_hyo_technical_value import IchimokuKinkoHyoTechnicalValue -from intrinio_sdk.models.index_constituents import IndexConstituents from intrinio_sdk.models.insider_transaction import InsiderTransaction from intrinio_sdk.models.insider_transaction_filing import InsiderTransactionFiling from intrinio_sdk.models.institutional_holding import InstitutionalHolding diff --git a/intrinio_sdk/models/api_response_index_constituents.py b/intrinio_sdk/models/api_response_index_constituents.py index 9edcb988..1b8b524f 100644 --- a/intrinio_sdk/models/api_response_index_constituents.py +++ b/intrinio_sdk/models/api_response_index_constituents.py @@ -17,7 +17,7 @@ import six from intrinio_sdk.models.api_response_index import ApiResponseIndex # noqa: F401,E501 -from intrinio_sdk.models.index_constituents import IndexConstituents # noqa: F401,E501 +from intrinio_sdk.models.security_summary import SecuritySummary # noqa: F401,E501 class ApiResponseIndexConstituents(object): @@ -36,7 +36,7 @@ class ApiResponseIndexConstituents(object): swagger_types = { 'index': 'ApiResponseIndex', 'date': 'date', - 'constituents': 'IndexConstituents' + 'constituents': 'list[SecuritySummary]' } attribute_map = { @@ -178,7 +178,7 @@ def constituents(self): :return: The constituents of this ApiResponseIndexConstituents. # noqa: E501 - :rtype: IndexConstituents + :rtype: list[SecuritySummary] """ return self._constituents @@ -188,7 +188,7 @@ def constituents_dict(self): :return: The constituents of this ApiResponseIndexConstituents. # noqa: E501 - :rtype: IndexConstituents + :rtype: list[SecuritySummary] """ result = None @@ -220,7 +220,7 @@ def constituents(self, constituents): :param constituents: The constituents of this ApiResponseIndexConstituents. # noqa: E501 - :type: IndexConstituents + :type: list[SecuritySummary] """ self._constituents = constituents diff --git a/intrinio_sdk/models/api_response_security_interval_prices.py b/intrinio_sdk/models/api_response_security_interval_prices.py index fa2b579b..6a58fbe6 100644 --- a/intrinio_sdk/models/api_response_security_interval_prices.py +++ b/intrinio_sdk/models/api_response_security_interval_prices.py @@ -230,7 +230,7 @@ def source(self, source): :param source: The source of this ApiResponseSecurityIntervalPrices. # noqa: E501 :type: str """ - allowed_values = ["$$v2_stock_price_interval_sources_enum$$"] # noqa: E501 + allowed_values = ["realtime", "delayed", "nasdaq_basic", "nasdaq_basic_filtered"] # noqa: E501 if source not in allowed_values: raise ValueError( "Invalid value for `source` ({0}), must be one of {1}" # noqa: E501 diff --git a/intrinio_sdk/models/api_response_security_intraday_prices.py b/intrinio_sdk/models/api_response_security_intraday_prices.py index e935590f..abf6132f 100644 --- a/intrinio_sdk/models/api_response_security_intraday_prices.py +++ b/intrinio_sdk/models/api_response_security_intraday_prices.py @@ -230,7 +230,7 @@ def source(self, source): :param source: The source of this ApiResponseSecurityIntradayPrices. # noqa: E501 :type: str """ - allowed_values = ["$$v2_stock_price_intraday_sources_enum$$"] # noqa: E501 + allowed_values = ["iex", "bats"] # noqa: E501 if source not in allowed_values: raise ValueError( "Invalid value for `source` ({0}), must be one of {1}" # noqa: E501 diff --git a/intrinio_sdk/models/index_constituents.py b/intrinio_sdk/models/index_constituents.py deleted file mode 100644 index 18aaaf36..00000000 --- a/intrinio_sdk/models/index_constituents.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - Intrinio API - - Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner. # noqa: E501 - - OpenAPI spec version: 2.75.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -import pprint -import re # noqa: F401 - -import six - -from intrinio_sdk.models.security_summary import SecuritySummary # noqa: F401,E501 - - -class IndexConstituents(object): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - } - - attribute_map = { - } - - def __init__(self): # noqa: E501 - """IndexConstituents - a model defined in Swagger""" # noqa: E501 - self.discriminator = None - - def to_dict(self): - """Returns the model properties as a dict""" - result = {} - - for attr, _ in six.iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, IndexConstituents): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other diff --git a/test/test_index_constituents.py b/test/test_index_constituents.py deleted file mode 100644 index 26ab0b8d..00000000 --- a/test/test_index_constituents.py +++ /dev/null @@ -1,40 +0,0 @@ -# coding: utf-8 - -""" - Intrinio API - - Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner. # noqa: E501 - - OpenAPI spec version: 2.75.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - - -from __future__ import absolute_import - -import unittest - -import intrinio_sdk -from intrinio_sdk.models.index_constituents import IndexConstituents # noqa: E501 -from intrinio_sdk.rest import ApiException - - -class TestIndexConstituents(unittest.TestCase): - """IndexConstituents unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testIndexConstituents(self): - """Test IndexConstituents""" - # FIXME: construct object with mandatory attributes with example values - # model = intrinio_sdk.models.index_constituents.IndexConstituents() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main()