diff --git a/docs/Company.md b/docs/Company.md index 2fa31cd1..beb9a917 100644 --- a/docs/Company.md +++ b/docs/Company.md @@ -43,7 +43,7 @@ Name | Type | Description **industry_category** | str | The company's operating industry category   **industry_group** | str | The company's operating industry group   **template** | str | The financial statement template used by Intrinio to standardize the as reported data   -**standardized_active** | bool | If true, the company has standardized and as reported fundamental data via the Intrinio API; if false, the company has as-reported data only   +**standardized_active** | bool | If True, the company has standardized and as reported fundamental data via the Intrinio API; if False, the company has as-reported data only   **first_fundamental_date** | date | The period end date of the company's first reported fundamental   **last_fundamental_date** | date | The period end date of the company's last reported fundamental   **first_stock_price_date** | date | The date of the company's first stock price, based on the company's primary security, which is typically traded on US exchages   diff --git a/docs/CompanyApi.md b/docs/CompanyApi.md index 64c71d04..a37e28a4 100644 --- a/docs/CompanyApi.md +++ b/docs/CompanyApi.md @@ -74,17 +74,17 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -latest_filing_date = '\"~null\"' -sic = '\"~null\"' -template = '\"~null\"' -sector = '\"~null\"' -industry_category = '\"~null\"' -industry_group = '\"~null\"' -has_fundamentals = true -has_stock_prices = true -thea_enabled = "~null" +latest_filing_date = '' +sic = '' +template = '' +sector = '' +industry_category = '' +industry_group = '' +has_fundamentals = True +has_stock_prices = True +thea_enabled = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.CompanyApi().get_all_companies(latest_filing_date=latest_filing_date, sic=sic, template=template, sector=sector, industry_category=industry_category, industry_group=industry_group, has_fundamentals=has_fundamentals, has_stock_prices=has_stock_prices, thea_enabled=thea_enabled, page_size=page_size, next_page=next_page) print(response) @@ -108,8 +108,8 @@ Name | Type | Description | Notes **sector** | str| Return companies in the given industry sector | [optional]   **industry_category** | str| Return companies in the given industry category | [optional]   **industry_group** | str| Return companies in the given industry group | [optional]   - **has_fundamentals** | bool| Return only companies that have fundamentals when true | [optional]   - **has_stock_prices** | bool| Return only companies that have stock prices when true | [optional]   + **has_fundamentals** | bool| Return only companies that have fundamentals when True | [optional]   + **has_stock_prices** | bool| Return only companies that have stock prices when True | [optional]   **thea_enabled** | bool| Return companies whose have been read by our Thea NLP and are ready for our company answers endpoint | [optional]   **page_size** | int| The number of results to return | [optional] [default to 100]   **next_page** | str| Gets the next page of data from a previous API call | [optional]   @@ -171,8 +171,8 @@ intrinio.ApiClient().allow_retries(True) on_date = '2013-10-20' page_size = 100 -next_page = '\"~null\"' -next_page2 = '\"~null\"' +next_page = '' +next_page2 = '' response = intrinio.CompanyApi().get_all_companies_daily_metrics(on_date=on_date, page_size=page_size, next_page=next_page, next_page2=next_page2) print(response) @@ -250,21 +250,21 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -specific_source = '\"~null\"' +specific_source = '' page_size = 100 -sentiment = '\"~null\"' -topic = '\"~null\"' -company = '\"AAPL\"' -security = '\"AAPL\"' -start_date = '\"~null\"' -end_date = '\"~null\"' -language = '\"~null\"' -word_count_greater_than = "~null" -word_count_less_than = "~null" -is_spam = "~null" -business_relevance_greater_than = "~null" -business_relevance_less_than = "~null" -next_page = '\"~null\"' +sentiment = '' +topic = '' +company = 'AAPL' +security = 'AAPL' +start_date = '' +end_date = '' +language = '' +word_count_greater_than = '' +word_count_less_than = '' +is_spam = '' +business_relevance_greater_than = '' +business_relevance_less_than = '' +next_page = '' response = intrinio.CompanyApi().get_all_company_news(specific_source=specific_source, page_size=page_size, sentiment=sentiment, topic=topic, company=company, security=security, start_date=start_date, end_date=end_date, language=language, word_count_greater_than=word_count_greater_than, word_count_less_than=word_count_less_than, is_spam=is_spam, business_relevance_greater_than=business_relevance_greater_than, business_relevance_less_than=business_relevance_less_than, next_page=next_page) print(response) @@ -353,7 +353,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' response = intrinio.CompanyApi().get_company(identifier) print(response) @@ -428,8 +428,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -query = '\"What do they believe in?\"' +identifier = 'AAPL' +query = 'What do they believe in?' response = intrinio.CompanyApi().get_company_answers(identifier, query) print(response) @@ -505,11 +505,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' on_date = '2013-10-20' page_size = 100 -next_page = '\"~null\"' -next_page2 = '\"~null\"' +next_page = '' +next_page2 = '' response = intrinio.CompanyApi().get_company_daily_metrics(identifier, on_date=on_date, page_size=page_size, next_page=next_page, next_page2=next_page2) print(response) @@ -588,8 +588,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"marketcap\"' +identifier = 'AAPL' +tag = 'marketcap' response = intrinio.CompanyApi().get_company_data_point_number(identifier, tag) print(response) @@ -665,8 +665,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"ceo\"' +identifier = 'AAPL' +tag = 'ceo' response = intrinio.CompanyApi().get_company_data_point_text(identifier, tag) print(response) @@ -742,13 +742,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -report_type = '\"~null\"' -start_date = '\"2015-01-01\"' -end_date = '\"~null\"' -thea_enabled = "~null" +identifier = 'AAPL' +report_type = '' +start_date = '2015-01-01' +end_date = '' +thea_enabled = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.CompanyApi().get_company_filings(identifier, report_type=report_type, start_date=start_date, end_date=end_date, thea_enabled=thea_enabled, page_size=page_size, next_page=next_page) print(response) @@ -829,19 +829,19 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -filed_after = '\"~null\"' -filed_before = '\"~null\"' -reported_only = false -fiscal_year = "~null" -statement_code = '\"~null\"' -type = '\"~null\"' -start_date = '\"~null\"' -end_date = '\"~null\"' -updated_after = '\"2022-12-01\"' -updated_before = '\"2022-12-01\"' +identifier = 'AAPL' +filed_after = '' +filed_before = '' +reported_only = False +fiscal_year = '' +statement_code = '' +type = '' +start_date = '' +end_date = '' +updated_after = '2022-12-01' +updated_before = '2022-12-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.CompanyApi().get_company_fundamentals(identifier, filed_after=filed_after, filed_before=filed_before, reported_only=reported_only, fiscal_year=fiscal_year, statement_code=statement_code, type=type, start_date=start_date, end_date=end_date, updated_after=updated_after, updated_before=updated_before, page_size=page_size, next_page=next_page) print(response) @@ -928,15 +928,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"marketcap\"' +identifier = 'AAPL' +tag = 'marketcap' frequency = 'daily' -type = '\"~null\"' -start_date = '\"2018-01-01\"' -end_date = '\"~null\"' +type = '' +start_date = '2018-01-01' +end_date = '' sort_order = 'desc' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.CompanyApi().get_company_historical_data(identifier, tag, frequency=frequency, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, page_size=page_size, next_page=next_page) print(response) @@ -1019,14 +1019,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -ticker = '\"UBER\"' -status = '\"~null\"' -start_date = '\"~null\"' -end_date = '\"~null\"' -offer_amount_greater_than = "~null" -offer_amount_less_than = "~null" +ticker = 'UBER' +status = '' +start_date = '' +end_date = '' +offer_amount_greater_than = '' +offer_amount_less_than = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.CompanyApi().get_company_ipos(ticker=ticker, status=status, start_date=start_date, end_date=end_date, offer_amount_greater_than=offer_amount_greater_than, offer_amount_less_than=offer_amount_less_than, page_size=page_size, next_page=next_page) print(response) @@ -1108,21 +1108,21 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -specific_source = '\"~null\"' +identifier = 'AAPL' +specific_source = '' page_size = 100 -sentiment = '\"~null\"' -topic = '\"~null\"' -security = '\"AAPL\"' -start_date = '\"~null\"' -end_date = '\"~null\"' -language = '\"~null\"' -word_count_greater_than = "~null" -word_count_less_than = "~null" -is_spam = "~null" -business_relevance_greater_than = "~null" -business_relevance_less_than = "~null" -next_page = '\"~null\"' +sentiment = '' +topic = '' +security = 'AAPL' +start_date = '' +end_date = '' +language = '' +word_count_greater_than = '' +word_count_less_than = '' +is_spam = '' +business_relevance_greater_than = '' +business_relevance_less_than = '' +next_page = '' response = intrinio.CompanyApi().get_company_news(identifier, specific_source=specific_source, page_size=page_size, sentiment=sentiment, topic=topic, security=security, start_date=start_date, end_date=end_date, language=language, word_count_greater_than=word_count_greater_than, word_count_less_than=word_count_less_than, is_spam=is_spam, business_relevance_greater_than=business_relevance_greater_than, business_relevance_less_than=business_relevance_less_than, next_page=next_page) print(response) @@ -1211,10 +1211,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -news_story_id = '\"new_aBcDef\"' -publication_date = '\"~null\"' -specific_source = '\"~null\"' -next_page = '\"~null\"' +news_story_id = 'new_aBcDef' +publication_date = '' +specific_source = '' +next_page = '' response = intrinio.CompanyApi().get_company_news_body(news_story_id, publication_date, specific_source=specific_source, next_page=next_page) print(response) @@ -1292,11 +1292,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -float_date_greater_than = '\"~null\"' -float_date_less_than = '\"~null\"' -next_page = '\"~null\"' -next_page2 = '\"~null\"' +identifier = 'AAPL' +float_date_greater_than = '' +float_date_less_than = '' +next_page = '' +next_page2 = '' response = intrinio.CompanyApi().get_company_public_float(identifier, float_date_greater_than=float_date_greater_than, float_date_less_than=float_date_less_than, next_page=next_page, next_page2=next_page2) print(response) @@ -1375,8 +1375,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -next_page = '\"~null\"' +identifier = 'AAPL' +next_page = '' response = intrinio.CompanyApi().get_company_securities(identifier, next_page=next_page) print(response) @@ -1452,14 +1452,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' -ownership_type = '\"D\"' -next_page = '\"~null\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' +ownership_type = 'D' +next_page = '' page_size = 1000 -sort_by = '\"updated_on\"' -next_page2 = '\"~null\"' +sort_by = 'updated_on' +next_page2 = '' response = intrinio.CompanyApi().insider_transaction_filings_by_company(identifier, start_date=start_date, end_date=end_date, ownership_type=ownership_type, next_page=next_page, page_size=page_size, sort_by=sort_by, next_page2=next_page2) print(response) @@ -1541,8 +1541,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -next_page = '\"~null\"' +identifier = 'AAPL' +next_page = '' response = intrinio.CompanyApi().latest_insider_transaction_filing_by_company(identifier, next_page=next_page) print(response) @@ -1618,9 +1618,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -statement_code = '\"income_statement\"' -fiscal_period = '\"FY\"' +identifier = 'AAPL' +statement_code = 'income_statement' +fiscal_period = 'FY' fiscal_year = 2017 response = intrinio.CompanyApi().lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year) @@ -1699,7 +1699,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -text = '\"Apple\"' +text = 'Apple' response = intrinio.CompanyApi().recognize_company(text) print(response) @@ -1774,9 +1774,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -query = '\"Apple\"' -active = true -mode = '\"~null\"' +query = 'Apple' +active = True +mode = '' page_size = 100 response = intrinio.CompanyApi().search_companies(query, active=active, mode=mode, page_size=page_size) @@ -1796,7 +1796,7 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | str| Search parameters |   - **active** | bool| When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. Not setting this value returns all. Not used when mode is set. | [optional]   + **active** | bool| When True, return companies that are actively traded (having stock prices within the past 14 days). When False, return companies that are not actively traded or never have been traded. Not setting this value returns all. Not used when mode is set. | [optional]   **mode** | str| When set, changes search mode to the specified mode. | [optional]   **page_size** | int| The number of results to return | [optional] [default to 100]  
@@ -1855,9 +1855,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -end_date_greater_than = '\"~null\"' -end_date_less_than = '\"~null\"' +identifier = 'AAPL' +end_date_greater_than = '' +end_date_less_than = '' response = intrinio.CompanyApi().shares_outstanding_by_company(identifier, end_date_greater_than=end_date_greater_than, end_date_less_than=end_date_less_than) print(response) diff --git a/docs/DataPointApi.md b/docs/DataPointApi.md index db3560c4..037717c8 100644 --- a/docs/DataPointApi.md +++ b/docs/DataPointApi.md @@ -54,8 +54,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"marketcap\"' +identifier = 'AAPL' +tag = 'marketcap' response = intrinio.DataPointApi().get_data_point_number(identifier, tag) print(response) @@ -131,8 +131,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"ceo\"' +identifier = 'AAPL' +tag = 'ceo' response = intrinio.DataPointApi().get_data_point_text(identifier, tag) print(response) diff --git a/docs/DataTagApi.md b/docs/DataTagApi.md index bb58724f..9f826b5f 100644 --- a/docs/DataTagApi.md +++ b/docs/DataTagApi.md @@ -55,13 +55,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -tag = '\"~null\"' -type = '\"~null\"' -parent = '\"~null\"' -statement_code = '\"income_statement\"' +tag = '' +type = '' +parent = '' +statement_code = 'income_statement' fs_template = 'industrial' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.DataTagApi().get_all_data_tags(tag=tag, type=type, parent=parent, statement_code=statement_code, fs_template=fs_template, page_size=page_size, next_page=next_page) print(response) @@ -142,7 +142,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"marketcap\"' +identifier = 'marketcap' response = intrinio.DataTagApi().get_data_tag_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) -query = '\"revenue\"' +query = 'revenue' page_size = 100 response = intrinio.DataTagApi().search_data_tags(query, page_size=page_size) diff --git a/docs/ESGApi.md b/docs/ESGApi.md index 2e5f5127..0a3e779e 100644 --- a/docs/ESGApi.md +++ b/docs/ESGApi.md @@ -56,11 +56,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -country = '\"Canada\"' -industry = '\"Retail\"' -ticker = '\"SHOP\"' +country = 'Canada' +industry = 'Retail' +ticker = 'SHOP' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ESGApi().get_esg_companies(country=country, industry=industry, ticker=ticker, page_size=page_size, next_page=next_page) print(response) @@ -138,9 +138,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ESGApi().get_esg_company_comprehensive_ratings(identifier, page_size=page_size, next_page=next_page) print(response) @@ -216,9 +216,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ESGApi().get_esg_company_ratings(identifier, page_size=page_size, next_page=next_page) print(response) @@ -294,9 +294,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -country = '\"USA\"' +country = 'USA' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ESGApi().get_esg_latest(country=country, page_size=page_size, next_page=next_page) print(response) @@ -372,9 +372,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -country = '\"USA\"' +country = 'USA' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ESGApi().get_esg_latest_comprehensive(country=country, page_size=page_size, next_page=next_page) print(response) diff --git a/docs/ETF.md b/docs/ETF.md index 0100ead1..125c3149 100644 --- a/docs/ETF.md +++ b/docs/ETF.md @@ -26,7 +26,7 @@ Name | Type | Description **inception_date** | date | Inception Date for the ETF as published by the ETF sponsor   **data_change_date** | date | The last date on which there was a change in a classifications data field for this ETF   **close_date** | date | The date on which this ETF was de-listed if it is no longer listed   -**is_live_listed** | bool | If true, the ETF is still listed on an exchange; if false, the ETF is no longer listed   +**is_live_listed** | bool | If True, the ETF is still listed on an exchange; if False, the ETF is no longer listed   **legal_structure** | str | The legal structure as defined in the prospectus   **intraday_nav_ticker** | str | Intra-day NAV ticker for the Exchange Traded Fund (ETF)   **primary_ticker** | str | The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes   @@ -36,8 +36,8 @@ Name | Type | Description **asset_class** | str | Captures the underlying nature of the securities in the Exchanged Traded Product (ETP)   **other_asset_types** | str | If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets   **market_cap_range** | str | Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)   -**holds_only_nyse_stocks** | bool | If true, the ETF is an equity ETF and holds only stocks listed on NYSE   -**holds_only_nasdaq_stocks** | bool | If false, the ETF is an equity ETF and holds only stocks listed on Nasdaq   +**holds_only_nyse_stocks** | bool | If True, the ETF is an equity ETF and holds only stocks listed on NYSE   +**holds_only_nasdaq_stocks** | bool | If False, the ETF is an equity ETF and holds only stocks listed on Nasdaq   **growth_value_tilt** | str | Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'   **growth_type** | str | For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores   **value_type** | str | For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores   @@ -89,14 +89,14 @@ Name | Type | Description **clean_energy_type** | str | This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.   **dividend_type** | str | This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus   **regular_dividend_payor_type** | str | This field is populated if the ETF has a value of 'Dividend – Regular Payors' in the 'dividend_type' field   -**holds_ml_ps** | bool | If true, the ETF’s investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy   -**holds_preferred_stock** | bool | If true, the ETF’s investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy   -**holds_closed_end_funds** | bool | IF true, if the ETF’s investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy   +**holds_ml_ps** | bool | If True, the ETF’s investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy   +**holds_preferred_stock** | bool | If True, the ETF’s investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy   +**holds_closed_end_funds** | bool | IF True, if the ETF’s investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy   **quant_strategies_type** | str | This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy   **other_quant_models** | str | For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF   **hedge_fund_type** | str | For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy   **derivatives_based** | str | This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio   -**holds_ad_rs** | bool | If true, he ETF’s investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy   +**holds_ad_rs** | bool | If True, he ETF’s investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy   **index_linked** | str | This field identifies whether an ETF is index linked or active   **includes_short_exposure** | bool | This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF   **index_name** | str | This field identifies the name of the underlying index tracked by the ETF, if applicable   @@ -114,7 +114,7 @@ Name | Type | Description **single_category_designation** | str | This categorization is created for those users who want every ETF to be ‘forced’ into a single bucket, so that the assets for all categories will always sum to the total market   **registered_countries** | str | The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe   **issuing_entity_country_code** | str | The name of the legal entity that issued the Exchange Traded Product (ETP)   -**ucits** | bool | If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant   +**ucits** | bool | If True, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant   **replication_structure** | str | The replication structure of the Exchange Traded Product (ETP)   **domicile** | str | 2 letter ISO country code for the country where the ETP is domiciled   **base_currency** | str | Base currency of the Exchange Traded Product (ETP) in which the net asset value (NAV) is calculated. Reported using the 3-digit ISO currency code   diff --git a/docs/ETFsApi.md b/docs/ETFsApi.md index 3273a7bb..1a098ef1 100644 --- a/docs/ETFsApi.md +++ b/docs/ETFsApi.md @@ -58,9 +58,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -exchange = '\"XNAS\"' +exchange = 'XNAS' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ETFsApi().get_all_etfs(exchange=exchange, page_size=page_size, next_page=next_page) print(response) @@ -137,7 +137,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"SPY\"' +identifier = 'SPY' response = intrinio.ETFsApi().get_etf(identifier) print(response) @@ -212,7 +212,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"SPY\"' +identifier = 'SPY' response = intrinio.ETFsApi().get_etf_analytics(identifier) print(response) @@ -287,9 +287,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"SPY\"' +identifier = 'SPY' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ETFsApi().get_etf_holdings(identifier, page_size=page_size, next_page=next_page) print(response) @@ -366,7 +366,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"SPY\"' +identifier = 'SPY' response = intrinio.ETFsApi().get_etf_stats(identifier) print(response) @@ -441,8 +441,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -query = '\"iShares\"' -mode = '\"~null\"' +query = 'iShares' +mode = '' response = intrinio.ETFsApi().search_etfs(query, mode=mode) print(response) diff --git a/docs/FilingApi.md b/docs/FilingApi.md index 4950e04f..074893cd 100644 --- a/docs/FilingApi.md +++ b/docs/FilingApi.md @@ -63,15 +63,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -company = '\"AAPL\"' -report_type = '\"10-Q\"' -start_date = '\"2015-01-01\"' -end_date = '\"~null\"' -industry_category = '\"~null\"' -industry_group = '\"~null\"' -thea_enabled = "~null" +company = 'AAPL' +report_type = '10-Q' +start_date = '2015-01-01' +end_date = '' +industry_category = '' +industry_group = '' +thea_enabled = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.FilingApi().get_all_filings(company=company, report_type=report_type, start_date=start_date, end_date=end_date, industry_category=industry_category, industry_group=industry_group, thea_enabled=thea_enabled, page_size=page_size, next_page=next_page) print(response) @@ -154,14 +154,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -company = '\"AAPL\"' -report_type = '\"10-Q\"' -filing_start_date = '\"~null\"' -filing_end_date = '\"~null\"' -period_ended_start_date = '\"~null\"' -period_ended_end_date = '\"~null\"' +company = 'AAPL' +report_type = '10-Q' +filing_start_date = '' +filing_end_date = '' +period_ended_start_date = '' +period_ended_end_date = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.FilingApi().get_all_notes(company=company, report_type=report_type, filing_start_date=filing_start_date, filing_end_date=filing_end_date, period_ended_start_date=period_ended_start_date, period_ended_end_date=period_ended_end_date, page_size=page_size, next_page=next_page) print(response) @@ -242,8 +242,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"fil_B73xBG\"' -query = '\"What do they believe in?\"' +identifier = 'fil_B73xBG' +query = 'What do they believe in?' response = intrinio.FilingApi().get_filing_answers(identifier, query) print(response) @@ -319,7 +319,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -id = '\"fil_7Kn2P6\"' +id = 'fil_7Kn2P6' response = intrinio.FilingApi().get_filing_by_id(id) print(response) @@ -394,14 +394,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"fil_B73xBG\"' -statement_code = '\"~null\"' -type = '\"~null\"' -fiscal_year = "~null" -fiscal_period = '\"~null\"' -start_date = '\"~null\"' -end_date = '\"~null\"' -next_page = '\"~null\"' +identifier = 'fil_B73xBG' +statement_code = '' +type = '' +fiscal_year = '' +fiscal_period = '' +start_date = '' +end_date = '' +next_page = '' response = intrinio.FilingApi().get_filing_fundamentals(identifier, statement_code=statement_code, type=type, fiscal_year=fiscal_year, fiscal_period=fiscal_period, start_date=start_date, end_date=end_date, next_page=next_page) print(response) @@ -483,7 +483,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"fil_B73xBG\"' +identifier = 'fil_B73xBG' response = intrinio.FilingApi().get_filing_html(identifier) print(response) @@ -557,7 +557,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"fil_B73xBG\"' +identifier = 'fil_B73xBG' response = intrinio.FilingApi().get_filing_text(identifier) print(response) @@ -632,7 +632,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"xbn_ydK3QL\"' +identifier = 'xbn_ydK3QL' content_format = 'text' response = intrinio.FilingApi().get_note(identifier, content_format=content_format) @@ -708,7 +708,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"xbn_ydK3QL\"' +identifier = 'xbn_ydK3QL' response = intrinio.FilingApi().get_note_html(identifier) print(response) @@ -782,7 +782,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"xbn_ydK3QL\"' +identifier = 'xbn_ydK3QL' response = intrinio.FilingApi().get_note_text(identifier) print(response) @@ -857,9 +857,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -query = '\"inflation\"' -filing_start_date = '\"2018-07-15\"' -filing_end_date = '\"2018-11-30\"' +query = 'inflation' +filing_start_date = '2018-07-15' +filing_end_date = '2018-11-30' page_size = 100 response = intrinio.FilingApi().search_notes(query, filing_start_date=filing_start_date, filing_end_date=filing_end_date, page_size=page_size) diff --git a/docs/ForexApi.md b/docs/ForexApi.md index 9f544cd1..50dea1f4 100644 --- a/docs/ForexApi.md +++ b/docs/ForexApi.md @@ -197,15 +197,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -pair = '\"EURUSD\"' -timeframe = '\"D1\"' +pair = 'EURUSD' +timeframe = 'D1' timezone = 'UTC' -start_date = '\"2018-01-01\"' -start_time = '\"~null\"' -end_date = '\"2019-01-01\"' -end_time = '\"~null\"' +start_date = '2018-01-01' +start_time = '' +end_date = '2019-01-01' +end_time = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ForexApi().get_forex_prices(pair, timeframe, timezone=timezone, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, page_size=page_size, next_page=next_page) print(response) diff --git a/docs/FundamentalsApi.md b/docs/FundamentalsApi.md index 0a715457..316cc9ad 100644 --- a/docs/FundamentalsApi.md +++ b/docs/FundamentalsApi.md @@ -58,19 +58,19 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -filed_after = '\"2022-01-01\"' -filed_before = '\"2022-12-01\"' -reported_only = false +filed_after = '2022-01-01' +filed_before = '2022-12-01' +reported_only = False fiscal_year = 2017 -statement_code = '\"~null\"' -type = 'false' -fiscal_period = '\"FY\"' -start_date = '\"2022-01-01\"' -end_date = '\"2022-12-01\"' -updated_after = '\"2022-12-01\"' -updated_before = '\"2022-12-01\"' -template = '\"indu\"' -next_page = '\"~null\"' +statement_code = '' +type = 'False' +fiscal_period = 'FY' +start_date = '2022-01-01' +end_date = '2022-12-01' +updated_after = '2022-12-01' +updated_before = '2022-12-01' +template = 'indu' +next_page = '' response = intrinio.FundamentalsApi().filter_fundamental(filed_after=filed_after, filed_before=filed_before, reported_only=reported_only, fiscal_year=fiscal_year, statement_code=statement_code, type=type, fiscal_period=fiscal_period, start_date=start_date, end_date=end_date, updated_after=updated_after, updated_before=updated_before, template=template, next_page=next_page) print(response) @@ -157,7 +157,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -id = '\"fun_ge9LlE\"' +id = 'fun_ge9LlE' response = intrinio.FundamentalsApi().get_fundamental_by_id(id) print(response) @@ -232,7 +232,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -id = '\"AAPL-income_statement-2018-Q1\"' +id = 'AAPL-income_statement-2018-Q1' response = intrinio.FundamentalsApi().get_fundamental_reported_financials(id) print(response) @@ -307,7 +307,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -id = '\"AAPL-income_statement-2018-Q1\"' +id = 'AAPL-income_statement-2018-Q1' response = intrinio.FundamentalsApi().get_fundamental_standardized_financials(id) print(response) @@ -382,8 +382,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -id = '\"AAPL-income_statement-2020-FY\"' -tag = '\"ceo\"' +id = 'AAPL-income_statement-2020-FY' +tag = 'ceo' response = intrinio.FundamentalsApi().get_fundamental_standardized_financials_dimensions(id, tag) print(response) @@ -459,10 +459,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -statement_code = '\"income_statement\"' +identifier = 'AAPL' +statement_code = 'income_statement' fiscal_year = 2017 -fiscal_period = '\"FY\"' +fiscal_period = 'FY' response = intrinio.FundamentalsApi().lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period) print(response) diff --git a/docs/HistoricalDataApi.md b/docs/HistoricalDataApi.md index bfc75d2b..96fd120a 100644 --- a/docs/HistoricalDataApi.md +++ b/docs/HistoricalDataApi.md @@ -53,15 +53,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"marketcap\"' +identifier = 'AAPL' +tag = 'marketcap' frequency = 'daily' -type = '\"~null\"' -start_date = '\"2015-01-01\"' -end_date = '\"~null\"' +type = '' +start_date = '2015-01-01' +end_date = '' sort_order = 'desc' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.HistoricalDataApi().get_historical_data(identifier, tag, frequency=frequency, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, page_size=page_size, next_page=next_page) print(response) diff --git a/docs/IndexApi.md b/docs/IndexApi.md index f83b5097..cdbac084 100644 --- a/docs/IndexApi.md +++ b/docs/IndexApi.md @@ -77,7 +77,7 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.IndexApi().get_all_economic_indices(page_size=page_size, next_page=next_page) print(response) @@ -153,8 +153,8 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) page_size = 100 -start_date = '\"~null\"' -end_date = '\"~null\"' +start_date = '' +end_date = '' response = intrinio.IndexApi().get_all_eod_index_prices(page_size=page_size, start_date=start_date, end_date=end_date) print(response) @@ -379,7 +379,7 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.IndexApi().get_all_sic_indices(page_size=page_size, next_page=next_page) print(response) @@ -455,7 +455,7 @@ intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.IndexApi().get_all_stock_market_indices(page_size=page_size, next_page=next_page) print(response) @@ -531,7 +531,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$GDP\"' +identifier = '$GDP' response = intrinio.IndexApi().get_economic_index_by_id(identifier) print(response) @@ -606,8 +606,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$GDP\"' -tag = '\"level\"' +identifier = '$GDP' +tag = 'level' response = intrinio.IndexApi().get_economic_index_data_point_number(identifier, tag) print(response) @@ -683,8 +683,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$GDP\"' -tag = '\"level\"' +identifier = '$GDP' +tag = 'level' response = intrinio.IndexApi().get_economic_index_data_point_text(identifier, tag) print(response) @@ -760,14 +760,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$GDP\"' -tag = '\"level\"' -type = '\"~null\"' -start_date = '\"2018-01-01\"' -end_date = '\"~null\"' +identifier = '$GDP' +tag = 'level' +type = '' +start_date = '2018-01-01' +end_date = '' sort_order = 'desc' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.IndexApi().get_economic_index_historical_data(identifier, tag, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, page_size=page_size, next_page=next_page) print(response) @@ -848,10 +848,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"SPX\"' +identifier = 'SPX' page_size = 100 -start_date = '\"~null\"' -end_date = '\"~null\"' +start_date = '' +end_date = '' response = intrinio.IndexApi().get_eod_index_price_by_id(identifier, page_size=page_size, start_date=start_date, end_date=end_date) print(response) @@ -928,7 +928,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"SPX\"' +identifier = 'SPX' response = intrinio.IndexApi().get_index_summary_by_id(identifier) print(response) @@ -1002,7 +1002,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"SPX\"' +identifier = 'SPX' response = intrinio.IndexApi().get_realtime_index_price_by_id(identifier) print(response) @@ -1076,7 +1076,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$SIC.2911\"' +identifier = '$SIC.2911' response = intrinio.IndexApi().get_sic_index_by_id(identifier) print(response) @@ -1151,8 +1151,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$SIC.2911\"' -tag = '\"marketcap\"' +identifier = '$SIC.2911' +tag = 'marketcap' response = intrinio.IndexApi().get_sic_index_data_point_number(identifier, tag) print(response) @@ -1228,8 +1228,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$SIC.2911\"' -tag = '\"marketcap\"' +identifier = '$SIC.2911' +tag = 'marketcap' response = intrinio.IndexApi().get_sic_index_data_point_text(identifier, tag) print(response) @@ -1305,14 +1305,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$SIC.1\"' -tag = '\"marketcap\"' -type = '\"~null\"' -start_date = '\"2018-01-01\"' -end_date = '\"~null\"' +identifier = '$SIC.1' +tag = 'marketcap' +type = '' +start_date = '2018-01-01' +end_date = '' sort_order = 'desc' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.IndexApi().get_sic_index_historical_data(identifier, tag, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, page_size=page_size, next_page=next_page) print(response) @@ -1393,7 +1393,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$DJI\"' +identifier = '$DJI' response = intrinio.IndexApi().get_stock_market_index_by_id(identifier) print(response) @@ -1468,8 +1468,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$DJI\"' -tag = '\"level\"' +identifier = '$DJI' +tag = 'level' response = intrinio.IndexApi().get_stock_market_index_data_point_number(identifier, tag) print(response) @@ -1545,8 +1545,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$DJI\"' -tag = '\"level\"' +identifier = '$DJI' +tag = 'level' response = intrinio.IndexApi().get_stock_market_index_data_point_text(identifier, tag) print(response) @@ -1622,14 +1622,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"$DJI\"' -tag = '\"level\"' -type = '\"~null\"' -start_date = '\"2018-01-01\"' -end_date = '\"~null\"' +identifier = '$DJI' +tag = 'level' +type = '' +start_date = '2018-01-01' +end_date = '' sort_order = 'desc' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.IndexApi().get_stock_market_index_historical_data(identifier, tag, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, page_size=page_size, next_page=next_page) print(response) @@ -1711,7 +1711,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -query = '\"GDP\"' +query = 'GDP' page_size = 100 response = intrinio.IndexApi().search_economic_indices(query, page_size=page_size) @@ -1788,7 +1788,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -query = '\"agriculture\"' +query = 'agriculture' page_size = 100 response = intrinio.IndexApi().search_sic_indices(query, page_size=page_size) @@ -1865,7 +1865,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -query = '\"dow\"' +query = 'dow' page_size = 100 response = intrinio.IndexApi().search_stock_markets_indices(query, page_size=page_size) diff --git a/docs/InsiderTransaction.md b/docs/InsiderTransaction.md index de7c57a3..bdd5720d 100644 --- a/docs/InsiderTransaction.md +++ b/docs/InsiderTransaction.md @@ -12,12 +12,12 @@ Name | Type | Description ------------ | ------------- | ------------- -**director** | bool | (true/false) A boolean indicating whether or not the owner is a director in the company   -**officer** | bool | (true/false) A boolean indicating whether or not the owner is a officer in the company   -**ten_percent_owner** | bool | (true/false) A boolean indicating whether or not the owner has a ten percent or greater interest in the company   -**other_relation** | bool | (true/false) A boolean indicating whether or not the owner has another relationship with the company beside, direct, officer, or significant owner in the company   +**director** | bool | (True/False) A boolean indicating whether or not the owner is a director in the company   +**officer** | bool | (True/False) A boolean indicating whether or not the owner is a officer in the company   +**ten_percent_owner** | bool | (True/False) A boolean indicating whether or not the owner has a ten percent or greater interest in the company   +**other_relation** | bool | (True/False) A boolean indicating whether or not the owner has another relationship with the company beside, direct, officer, or significant owner in the company   **officer_title** | str | The officer title of the owner in the company   -**derivative_transaction** | bool | (true) A boolean indicating the transaction is a derivative transaction, which may or may not become common stock due to various possible exercise or conversion requirements   +**derivative_transaction** | bool | (True) A boolean indicating the transaction is a derivative transaction, which may or may not become common stock due to various possible exercise or conversion requirements   **ticker** | str | The ticker symbol for the company’s common stock   **security_title** | str | The name of the derivative security transacted   **conversion_exercise_price** | float | The conversion or exercise price of the derivative security transacted   diff --git a/docs/InsiderTransactionFilingsApi.md b/docs/InsiderTransactionFilingsApi.md index d200da40..7aab2ac5 100644 --- a/docs/InsiderTransactionFilingsApi.md +++ b/docs/InsiderTransactionFilingsApi.md @@ -53,11 +53,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -start_date = '\"2015-01-01\"' -end_date = '\"~null\"' +start_date = '2015-01-01' +end_date = '' page_size = 100 -sort_by = '\"updated_on\"' -next_page = '\"~null\"' +sort_by = 'updated_on' +next_page = '' response = intrinio.InsiderTransactionFilingsApi().get_all_insider_transaction_filings(start_date=start_date, end_date=end_date, page_size=page_size, sort_by=sort_by, next_page=next_page) print(response) diff --git a/docs/MunicipalityApi.md b/docs/MunicipalityApi.md index e7a502fc..51bb6242 100644 --- a/docs/MunicipalityApi.md +++ b/docs/MunicipalityApi.md @@ -55,19 +55,19 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -has_financials = "~null" -government_name = '\"~null\"' -government_type = '\"~null\"' -area_name = '\"~null\"' -area_type = '\"~null\"' -city = '\"~null\"' -state = '\"~null\"' -zipcode = "~null" -population_greater_than = "~null" -population_less_than = "~null" -enrollment_greater_than = "~null" -enrollment_less_than = "~null" -next_page = '\"~null\"' +has_financials = '' +government_name = '' +government_type = '' +area_name = '' +area_type = '' +city = '' +state = '' +zipcode = '' +population_greater_than = '' +population_less_than = '' +enrollment_greater_than = '' +enrollment_less_than = '' +next_page = '' response = intrinio.MunicipalityApi().get_all_municipalities(has_financials=has_financials, government_name=government_name, government_type=government_type, area_name=area_name, area_type=area_type, city=city, state=state, zipcode=zipcode, population_greater_than=population_greater_than, population_less_than=population_less_than, enrollment_greater_than=enrollment_greater_than, enrollment_less_than=enrollment_less_than, next_page=next_page) print(response) @@ -154,7 +154,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -id = '\"mun_Xn7x4z\"' +id = 'mun_Xn7x4z' response = intrinio.MunicipalityApi().get_municipality_by_id(id) print(response) @@ -229,7 +229,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -id = '\"mun_Xn7x4z\"' +id = 'mun_Xn7x4z' fiscal_year = 2017 response = intrinio.MunicipalityApi().get_municipality_financials(id, fiscal_year=fiscal_year) diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md index 3bb0e0d2..6f2b3195 100644 --- a/docs/OptionsApi.md +++ b/docs/OptionsApi.md @@ -224,11 +224,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"MSFT\"' -after = '\"2022-01-01\"' -before = '\"2023-04-01\"' -source = '\"~null\"' -include_related_symbols = false +symbol = 'MSFT' +after = '2022-01-01' +before = '2023-04-01' +source = '' +include_related_symbols = False response = intrinio.OptionsApi().get_option_expirations_realtime(symbol, after=after, before=before, source=source, include_related_symbols=include_related_symbols) print(response) @@ -307,13 +307,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"MSFT\"' +symbol = 'MSFT' strike = 95 -source = '\"~null\"' -stock_price_source = '\"~null\"' -model = '\"~null\"' -show_extended_price = "~null" -include_related_symbols = false +source = '' +stock_price_source = '' +model = '' +show_extended_price = '' +include_related_symbols = False response = intrinio.OptionsApi().get_option_strikes_realtime(symbol, strike, source=source, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, include_related_symbols=include_related_symbols) print(response) @@ -394,10 +394,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"AAPL\"' -type = '\"put\"' +symbol = 'AAPL' +type = 'put' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.OptionsApi().get_options(symbol, type=type, page_size=page_size, next_page=next_page) print(response) @@ -481,10 +481,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"AAPL\"' -type = '\"put\"' -source = '\"~null\"' -include_related_symbols = false +symbol = 'AAPL' +type = 'put' +source = '' +include_related_symbols = False response = intrinio.OptionsApi().get_options_by_symbol_realtime(symbol, type=type, source=source, include_related_symbols=include_related_symbols) print(response) @@ -568,11 +568,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"MSFT\"' -expiration = '\"2019-04-05\"' -date = '\"~null\"' -type = '\"~null\"' -moneyness = '\"~null\"' +symbol = 'MSFT' +expiration = '2019-04-05' +date = '' +type = '' +moneyness = '' page_size = 100 response = intrinio.OptionsApi().get_options_chain(symbol, expiration, date=date, type=type, moneyness=moneyness, page_size=page_size) @@ -656,10 +656,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"AAPL\"' -expiration = '\"2023-01-20\"' -type = '\"~null\"' -include_related_symbols = false +symbol = 'AAPL' +expiration = '2023-01-20' +type = '' +include_related_symbols = False response = intrinio.OptionsApi().get_options_chain_eod(symbol, expiration, type=type, include_related_symbols=include_related_symbols) print(response) @@ -741,15 +741,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"MSFT\"' -expiration = '\"2023-01-20\"' -source = '\"~null\"' -type = '\"~null\"' -moneyness = '\"~null\"' -stock_price_source = '\"~null\"' -model = '\"~null\"' -show_extended_price = "~null" -include_related_symbols = false +symbol = 'MSFT' +expiration = '2023-01-20' +source = '' +type = '' +moneyness = '' +stock_price_source = '' +model = '' +show_extended_price = '' +include_related_symbols = False response = intrinio.OptionsApi().get_options_chain_realtime(symbol, expiration, source=source, type=type, moneyness=moneyness, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price, include_related_symbols=include_related_symbols) print(response) @@ -839,9 +839,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"MSFT\"' -after = '\"2019-01-01\"' -before = '\"2019-12-31\"' +symbol = 'MSFT' +after = '2019-01-01' +before = '2019-12-31' response = intrinio.OptionsApi().get_options_expirations(symbol, after=after, before=before) print(response) @@ -918,10 +918,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"MSFT\"' -after = '\"2019-01-01\"' -before = '\"2019-12-31\"' -include_related_symbols = false +symbol = 'MSFT' +after = '2019-01-01' +before = '2019-12-31' +include_related_symbols = False response = intrinio.OptionsApi().get_options_expirations_eod(symbol, after=after, before=before, include_related_symbols=include_related_symbols) print(response) @@ -999,11 +999,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"SPY___230103P00380000\"' -interval_size = '\"5m\"' -source = '\"~null\"' +identifier = 'SPY___230103P00380000' +interval_size = '5m' +source = '' page_size = 100 -end_time = '\"~null\"' +end_time = '' response = intrinio.OptionsApi().get_options_interval_by_contract(identifier, interval_size, source=source, page_size=page_size, end_time=end_time) print(response) @@ -1082,8 +1082,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -open_time = '\"~null\"' +source = '' +open_time = '' response = intrinio.OptionsApi().get_options_interval_movers(source=source, open_time=open_time) print(response) @@ -1159,8 +1159,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -open_time = '\"~null\"' +source = '' +open_time = '' response = intrinio.OptionsApi().get_options_interval_movers_change(source=source, open_time=open_time) print(response) @@ -1236,8 +1236,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -open_time = '\"~null\"' +source = '' +open_time = '' response = intrinio.OptionsApi().get_options_interval_movers_volume(source=source, open_time=open_time) print(response) @@ -1313,11 +1313,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"MSFT190405C00118000\"' -start_date = '\"2019-01-01\"' -end_date = '\"2019-12-31\"' +identifier = 'MSFT190405C00118000' +start_date = '2019-01-01' +end_date = '2019-12-31' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.OptionsApi().get_options_prices(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1396,11 +1396,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -show_stats = "~null" -stock_price_source = '\"~null\"' -model = '\"~null\"' -show_extended_price = "~null" +source = '' +show_stats = '' +stock_price_source = '' +model = '' +show_extended_price = '' body = { "contracts": [ "A220121P00055000", @@ -1487,8 +1487,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL230616P00190000\"' -next_page = '\"~null\"' +identifier = 'AAPL230616P00190000' +next_page = '' response = intrinio.OptionsApi().get_options_prices_eod(identifier, next_page=next_page, ) print(response) @@ -1566,11 +1566,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL230120C00090000\"' -source = '\"~null\"' -stock_price_source = '\"~null\"' -model = '\"~null\"' -show_extended_price = "~null" +identifier = 'AAPL230120C00090000' +source = '' +stock_price_source = '' +model = '' +show_extended_price = '' response = intrinio.OptionsApi().get_options_prices_realtime(identifier, source=source, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price) print(response) @@ -1649,14 +1649,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"MSFT\"' -source = '\"~null\"' -iv_mode = '\"~null\"' -next_page = '\"~null\"' +symbol = 'MSFT' +source = '' +iv_mode = '' +next_page = '' page_size = 250 -stock_price_source = '\"~null\"' -model = '\"~null\"' -show_extended_price = "~null" +stock_price_source = '' +model = '' +show_extended_price = '' response = intrinio.OptionsApi().get_options_prices_realtime_by_ticker(symbol, source=source, iv_mode=iv_mode, next_page=next_page, page_size=page_size, stock_price_source=stock_price_source, model=model, show_extended_price=show_extended_price) print(response) @@ -1738,8 +1738,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -at_datetime = '\"~null\"' +source = '' +at_datetime = '' response = intrinio.OptionsApi().get_options_snapshots(source=source, at_datetime=at_datetime) print(response) @@ -1815,9 +1815,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL230120C00090000\"' -source = '\"~null\"' -show_extended_price = "~null" +identifier = 'AAPL230120C00090000' +source = '' +show_extended_price = '' response = intrinio.OptionsApi().get_options_stats_realtime(identifier, source=source, show_extended_price=show_extended_price) print(response) @@ -1894,8 +1894,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"AAPL\"' -source = '\"~null\"' +symbol = 'AAPL' +source = '' response = intrinio.OptionsApi().get_unusual_activity(symbol, source=source) print(response) @@ -1971,13 +1971,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -symbol = '\"AAPL\"' -next_page = '\"~null\"' +symbol = 'AAPL' +next_page = '' page_size = 1000 -activity_type = '\"~null\"' -sentiment = '\"~null\"' -start_date = '\"2022-02-01\"' -end_date = '\"2022-02-03\"' +activity_type = '' +sentiment = '' +start_date = '2022-02-01' +end_date = '2022-02-03' minimum_total_value = 100000.0 maximum_total_value = 200000.0 @@ -2062,7 +2062,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' +source = '' response = intrinio.OptionsApi().get_unusual_activity_universal(source=source) print(response) @@ -2137,12 +2137,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -next_page = '\"~null\"' +next_page = '' page_size = 1000 -activity_type = '\"~null\"' -sentiment = '\"~null\"' -start_date = '\"2022-02-01\"' -end_date = '\"2022-02-03\"' +activity_type = '' +sentiment = '' +start_date = '2022-02-01' +end_date = '2022-02-03' minimum_total_value = 100000.0 maximum_total_value = 200000.0 diff --git a/docs/OwnersApi.md b/docs/OwnersApi.md index 8bb17e23..96a035e4 100644 --- a/docs/OwnersApi.md +++ b/docs/OwnersApi.md @@ -57,9 +57,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -institutional = "~null" +institutional = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.OwnersApi().get_all_owners(institutional=institutional, page_size=page_size, next_page=next_page) print(response) @@ -77,7 +77,7 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **institutional** | bool| Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. | [optional]   + **institutional** | bool| Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are True, False, or omit for both. | [optional]   **page_size** | int| The number of results to return | [optional] [default to 100]   **next_page** | str| Gets the next page of data from a previous API call | [optional]  
@@ -136,7 +136,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"0000001800\"' +identifier = '0000001800' response = intrinio.OwnersApi().get_owner_by_id(identifier) print(response) @@ -211,11 +211,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"0001494730\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = '0001494730' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.OwnersApi().insider_transaction_filings_by_owner(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -296,8 +296,8 @@ intrinio.ApiClient().allow_retries(True) identifier = '430692' page_size = 100 -as_of_date = '\"2021-01-05\"' -next_page = '\"~null\"' +as_of_date = '2021-01-05' +next_page = '' response = intrinio.OwnersApi().institutional_holdings_by_owner(identifier, page_size=page_size, as_of_date=as_of_date, next_page=next_page) print(response) @@ -375,10 +375,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -query = '\"Cook\"' -institutional = "~null" +query = 'Cook' +institutional = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.OwnersApi().search_owners(query, institutional=institutional, page_size=page_size, next_page=next_page) print(response) @@ -397,7 +397,7 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | str| |   - **institutional** | bool| Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. | [optional]   + **institutional** | bool| Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are True, False, or omit for both. | [optional]   **page_size** | int| The number of results to return | [optional] [default to 100]   **next_page** | str| Gets the next page of data from a previous API call | [optional]  
diff --git a/docs/ReportedTag.md b/docs/ReportedTag.md index 4abba8c0..c6fa33d0 100644 --- a/docs/ReportedTag.md +++ b/docs/ReportedTag.md @@ -16,7 +16,7 @@ Name | Type | Description **name** | str | The tag name   **balance** | str | Whether the tag represents a credit or debit   **unit** | str | The unit of the tag   -**abstract** | bool | If true, the tag is an abstract and does not represent a nominal value   +**abstract** | bool | If True, the tag is an abstract and does not represent a nominal value   **sequence** | int | The vertical sequence of the tag when displayed in the financial statement   **depth** | int | The horizontal depth of the tag when displayed in the financial statement   diff --git a/docs/Security.md b/docs/Security.md index fb628870..fa97885a 100644 --- a/docs/Security.md +++ b/docs/Security.md @@ -29,11 +29,11 @@ Name | Type | Description **composite_figi** | str | The country-composite OpenFIGI identifier   **share_class_figi** | str | The global-composite OpenFIGI identifier   **figi_uniqueid** | str | The OpenFIGI unique ID   -**active** | bool | If true, the Security is active and has been recently traded   -**etf** | bool | If true, this Security is an ETF   -**delisted** | bool | If true, the Security is no longer traded on the exchange   -**primary_listing** | bool | If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange   -**primary_security** | bool | If true, the Security is considered by Intrinio to be the primary Security for its company   +**active** | bool | If True, the Security is active and has been recently traded   +**etf** | bool | If True, this Security is an ETF   +**delisted** | bool | If True, the Security is no longer traded on the exchange   +**primary_listing** | bool | If True, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange   +**primary_security** | bool | If True, the Security is considered by Intrinio to be the primary Security for its company   **first_stock_price** | date | The date of the first recorded stock price   **last_stock_price** | date | The date of the last recorded stock price (or the most recent trading day)   **last_stock_price_adjustment** | date | The date of the last stock price adjustment (dividend, split, etc)   diff --git a/docs/SecurityApi.md b/docs/SecurityApi.md index 2b2be4f9..b17e22bf 100644 --- a/docs/SecurityApi.md +++ b/docs/SecurityApi.md @@ -111,25 +111,25 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -active = true -delisted = false -code = '\"~null\"' -currency = '\"~null\"' -ticker = '\"~null\"' -name = '\"~null\"' -composite_mic = '\"~null\"' -exchange_mic = '\"~null\"' -stock_prices_after = '\"~null\"' -stock_prices_before = '\"~null\"' -cik = '\"~null\"' -figi = '\"~null\"' -composite_figi = '\"~null\"' -share_class_figi = '\"~null\"' -figi_unique_id = '\"~null\"' -include_non_figi = false +active = True +delisted = False +code = '' +currency = '' +ticker = '' +name = '' +composite_mic = '' +exchange_mic = '' +stock_prices_after = '' +stock_prices_before = '' +cik = '' +figi = '' +composite_figi = '' +share_class_figi = '' +figi_unique_id = '' +include_non_figi = False page_size = 100 -primary_listing = "~null" -next_page = '\"~null\"' +primary_listing = '' +next_page = '' response = intrinio.SecurityApi().get_all_securities(active=active, delisted=delisted, code=code, currency=currency, ticker=ticker, name=name, composite_mic=composite_mic, exchange_mic=exchange_mic, stock_prices_after=stock_prices_after, stock_prices_before=stock_prices_before, cik=cik, figi=figi, composite_figi=composite_figi, share_class_figi=share_class_figi, figi_unique_id=figi_unique_id, include_non_figi=include_non_figi, page_size=page_size, primary_listing=primary_listing, next_page=next_page) print(response) @@ -147,8 +147,8 @@ print(response) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **active** | bool| When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings). | [optional]   - **delisted** | bool| When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted. | [optional]   + **active** | bool| When True, return securities that are active. When False, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings). | [optional]   + **delisted** | bool| When True, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When False, return securities that have not been delisted. | [optional]   **code** | str| Return securities classified with the given code (<a href=\"https://docs.intrinio.com/documentation/security_codes\" target=\"_blank\">reference</a>). | [optional]   **currency** | str| Return securities traded in the given 3-digit ISO 4217 currency code (<a href=\"https://en.wikipedia.org/wiki/ISO_4217\" target=\"_blank\">reference</a>). | [optional]   **ticker** | str| Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity. | [optional]   @@ -162,9 +162,9 @@ Name | Type | Description | Notes **composite_figi** | str| Return securities with the given Country Composite FIGI (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]   **share_class_figi** | str| Return securities with the given Global Share Class FIGI (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]   **figi_unique_id** | str| Return securities with the given FIGI Unique ID (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]   - **include_non_figi** | bool| When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned. | [optional] [default to false]   + **include_non_figi** | bool| When True, include securities that do not have a FIGI. By default, this is False. If this parameter is not specified, only securities with a FIGI are returned. | [optional] [default to False]   **page_size** | int| The number of results to return | [optional] [default to 100]   - **primary_listing** | bool| If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange. Returns both if omitted. | [optional]   + **primary_listing** | bool| If True, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange. Returns both if omitted. | [optional]   **next_page** | str| Gets the next page of data from a previous API call | [optional]  
@@ -222,7 +222,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' response = intrinio.SecurityApi().get_security_by_id(identifier) print(response) @@ -297,8 +297,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"close_price\"' +identifier = 'AAPL' +tag = 'close_price' response = intrinio.SecurityApi().get_security_data_point_number(identifier, tag) print(response) @@ -374,8 +374,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"figi\"' +identifier = 'AAPL' +tag = 'figi' response = intrinio.SecurityApi().get_security_data_point_text(identifier, tag) print(response) @@ -451,15 +451,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -tag = '\"adj_close_price\"' +identifier = 'AAPL' +tag = 'adj_close_price' frequency = 'daily' -type = '\"~null\"' -start_date = '\"2018-01-01\"' -end_date = '\"~null\"' +type = '' +start_date = '2018-01-01' +end_date = '' sort_order = 'desc' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_historical_data(identifier, tag, frequency=frequency, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, page_size=page_size, next_page=next_page) print(response) @@ -542,7 +542,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"037833100\"' +identifier = '037833100' response = intrinio.SecurityApi().get_security_history_by_identifier(identifier) print(response) @@ -617,7 +617,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -ticker = '\"AAPL\"' +ticker = 'AAPL' response = intrinio.SecurityApi().get_security_history_by_ticker(ticker) print(response) @@ -692,8 +692,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -next_page = '\"~null\"' +identifier = 'AAPL' +next_page = '' response = intrinio.SecurityApi().get_security_insider_ownership(identifier, next_page=next_page) print(response) @@ -769,8 +769,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -open_time = '\"~null\"' +source = '' +open_time = '' response = intrinio.SecurityApi().get_security_interval_movers(source=source, open_time=open_time) print(response) @@ -846,8 +846,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -open_time = '\"~null\"' +source = '' +open_time = '' response = intrinio.SecurityApi().get_security_interval_movers_change(source=source, open_time=open_time) print(response) @@ -923,8 +923,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -open_time = '\"~null\"' +source = '' +open_time = '' response = intrinio.SecurityApi().get_security_interval_movers_volume(source=source, open_time=open_time) print(response) @@ -1000,17 +1000,17 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' interval_size = '15m' -source = '\"~null\"' -start_date = '\"2023-01-01\"' -start_time = '\"~null\"' -end_date = '\"2023-02-01\"' -end_time = '\"~null\"' +source = '' +start_date = '2023-01-01' +start_time = '' +end_date = '2023-02-01' +end_time = '' timezone = 'UTC' page_size = 100 -split_adjusted = false -next_page = '\"~null\"' +split_adjusted = False +next_page = '' response = intrinio.SecurityApi().get_security_interval_prices(identifier, interval_size, source=source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, split_adjusted=split_adjusted, next_page=next_page) print(response) @@ -1037,7 +1037,7 @@ Name | Type | Description | Notes **end_time** | str| Return intervals stopping at the specified time on the `end_date` (24-hour in 'hh:mm:ss' format) | [optional]   **timezone** | str| Returns trading times in this timezone | [optional] [default to UTC]   **page_size** | int| The number of results to return | [optional] [default to 100]   - **split_adjusted** | bool| Whether to return the values adjusted for splits or not. Default is false. | [optional] [default to false]   + **split_adjusted** | bool| Whether to return the values adjusted for splits or not. Default is False. | [optional] [default to False]   **next_page** | str| Gets the next page of data from a previous API call | [optional]  
@@ -1095,14 +1095,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -source = '\"~null\"' -start_date = '\"2018-01-01\"' -start_time = '\"~null\"' -end_date = '\"2019-01-01\"' -end_time = '\"~null\"' +identifier = 'AAPL' +source = '' +start_date = '2018-01-01' +start_time = '' +end_date = '2019-01-01' +end_time = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_intraday_prices(identifier, source=source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, page_size=page_size, next_page=next_page) print(response) @@ -1184,7 +1184,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' response = intrinio.SecurityApi().get_security_latest_dividend_record(identifier) print(response) @@ -1259,7 +1259,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' response = intrinio.SecurityApi().get_security_latest_earnings_record(identifier) print(response) @@ -1334,11 +1334,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_adi(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1417,12 +1417,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 22 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_adtv(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1502,12 +1502,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_adx(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1587,13 +1587,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' short_period = 5 long_period = 34 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_ao(identifier, short_period=short_period, long_period=long_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1674,12 +1674,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_atr(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1759,14 +1759,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 standard_deviations = 2.0 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_bb(identifier, period=period, standard_deviations=standard_deviations, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1848,13 +1848,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 constant = 0.015 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_cci(identifier, period=period, constant=constant, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1935,12 +1935,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_cmf(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2020,13 +2020,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_dc(identifier, period=period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2107,13 +2107,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_dpo(identifier, period=period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2194,12 +2194,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_eom(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2279,11 +2279,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_fi(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2362,14 +2362,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' low_period = 9 medium_period = 26 high_period = 52 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_ichimoku(identifier, low_period=low_period, medium_period=medium_period, high_period=high_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2451,12 +2451,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 10 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_kc(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2536,7 +2536,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' roc1 = 10 roc2 = 15 roc3 = 20 @@ -2546,10 +2546,10 @@ sma2 = 10 sma3 = 10 sma4 = 15 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_kst(identifier, roc1=roc1, roc2=roc2, roc3=roc3, roc4=roc4, sma1=sma1, sma2=sma2, sma3=sma3, sma4=sma4, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2637,15 +2637,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' fast_period = 12 slow_period = 26 signal_period = 9 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_macd(identifier, fast_period=fast_period, slow_period=slow_period, signal_period=signal_period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2728,12 +2728,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_mfi(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2813,13 +2813,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' ema_period = 9 sum_period = 25 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_mi(identifier, ema_period=ema_period, sum_period=sum_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2900,11 +2900,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_nvi(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2983,11 +2983,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_obv(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3066,12 +3066,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 10 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_obv_mean(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3151,13 +3151,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_rsi(identifier, period=period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3238,13 +3238,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_sma(identifier, period=period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3325,13 +3325,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 signal_period = 3 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_sr(identifier, period=period, signal_period=signal_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3412,12 +3412,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 15 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_trix(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3497,14 +3497,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' low_period = 13 high_period = 25 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_tsi(identifier, low_period=low_period, high_period=high_period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3586,17 +3586,17 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' short_period = 7 medium_period = 14 long_period = 28 short_weight = 4.0 medium_weight = 2.0 long_weight = 1.0 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_uo(identifier, short_period=short_period, medium_period=medium_period, long_period=long_period, short_weight=short_weight, medium_weight=medium_weight, long_weight=long_weight, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3681,12 +3681,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_vi(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3766,11 +3766,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_vpt(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3849,11 +3849,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_vwap(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -3932,12 +3932,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_price_technicals_wr(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -4017,8 +4017,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -source = ['\"iex\"'] +identifier = 'AAPL' +source = ['iex'] response = intrinio.SecurityApi().get_security_realtime_price(identifier, source=source) print(response) @@ -4094,8 +4094,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -subsource = '\"~null\"' -date = '\"~null\"' +subsource = '' +date = '' response = intrinio.SecurityApi().get_security_replay_file(subsource, date) print(response) @@ -4171,7 +4171,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -at_datetime = '\"~null\"' +at_datetime = '' response = intrinio.SecurityApi().get_security_snapshots(at_datetime=at_datetime) print(response) @@ -4246,11 +4246,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_stock_price_adjustments(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -4329,12 +4329,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' frequency = 'daily' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_stock_prices(identifier, start_date=start_date, end_date=end_date, frequency=frequency, page_size=page_size, next_page=next_page) print(response) @@ -4414,16 +4414,16 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -source = '\"~null\"' -start_date = '\"~null\"' -start_time = '\"~null\"' -end_date = '\"~null\"' -end_time = '\"~null\"' +source = '' +start_date = '' +start_time = '' +end_date = '' +end_time = '' timezone = 'UTC' page_size = 100 -darkpool_only = false +darkpool_only = False min_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_trades(source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, darkpool_only=darkpool_only, min_size=min_size, next_page=next_page) print(response) @@ -4448,7 +4448,7 @@ Name | Type | Description | Notes **end_time** | str| The end time for the data being requested. | [optional]   **timezone** | str| The timezone the start and end date/times use. | [optional] [default to UTC]   **page_size** | int| The maximum number of results to return per page. | [optional] [default to 100]   - **darkpool_only** | bool| Set to true to show only darkpool trades | [optional] [default to false]   + **darkpool_only** | bool| Set to True to show only darkpool trades | [optional] [default to False]   **min_size** | int| Trades must be larger or equal to this size. | [optional]   **next_page** | str| Gets the next page of data from a previous API call | [optional]  
@@ -4507,17 +4507,17 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -source = '\"~null\"' -start_date = '\"~null\"' -start_time = '\"~null\"' -end_date = '\"~null\"' -end_time = '\"~null\"' +identifier = 'AAPL' +source = '' +start_date = '' +start_time = '' +end_date = '' +end_time = '' timezone = 'UTC' -darkpool_only = false +darkpool_only = False page_size = 100 min_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_trades_by_symbol(identifier, source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, darkpool_only=darkpool_only, page_size=page_size, min_size=min_size, next_page=next_page) print(response) @@ -4542,7 +4542,7 @@ Name | Type | Description | Notes **end_date** | date| The end date for the data being requested. | [optional]   **end_time** | str| The end time for the data being requested. | [optional]   **timezone** | str| The timezone the start and end date/times use. | [optional] [default to UTC]   - **darkpool_only** | bool| Set to true to show only darkpool trades | [optional] [default to false]   + **darkpool_only** | bool| Set to True to show only darkpool trades | [optional] [default to False]   **page_size** | int| The maximum number of results to return per page. | [optional] [default to 100]   **min_size** | int| Trades must be larger or equal to this size. | [optional]   **next_page** | str| Gets the next page of data from a previous API call | [optional]   @@ -4602,7 +4602,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' page_size = 100 response = intrinio.SecurityApi().get_security_zacks_analyst_ratings(identifier, page_size=page_size) @@ -4695,8 +4695,8 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -date = '\"~null\"' +identifier = 'AAPL' +date = '' response = intrinio.SecurityApi().get_security_zacks_analyst_ratings_snapshot(identifier, date=date) print(response) @@ -4772,9 +4772,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_zacks_eps_surprises(identifier, page_size=page_size, next_page=next_page) print(response) @@ -4851,9 +4851,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.SecurityApi().get_security_zacks_sales_surprises(identifier, page_size=page_size, next_page=next_page) print(response) @@ -4944,9 +4944,9 @@ clauses = [ ] logic = intrinio.SecurityScreenGroup(operator="AND", clauses=clauses) -order_column = '\"marketcap\"' +order_column = 'marketcap' order_direction = 'asc' -primary_only = false +primary_only = False page_size = 100 response = intrinio.SecurityApi().screen_securities(logic=logic, order_column=order_column, order_direction=order_direction, primary_only=primary_only, page_size=page_size) @@ -4968,7 +4968,7 @@ Name | Type | Description | Notes **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups. </br> See <a href=\"https://docs.intrinio.com/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions. | [optional]   **order_column** | str| Results returned sorted by this column | [optional]   **order_direction** | str| Sort order to use with the order_column | [optional] [default to asc]   - **primary_only** | bool| Return only primary securities | [optional] [default to false]   + **primary_only** | bool| Return only primary securities | [optional] [default to False]   **page_size** | int| The number of results to return. Maximum for this endpoint is 50000. | [optional] [default to 100]  
@@ -5026,7 +5026,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -query = '\"Apple\"' +query = 'Apple' page_size = 100 response = intrinio.SecurityApi().search_securities(query, page_size=page_size) diff --git a/docs/SecuritySummary.md b/docs/SecuritySummary.md index 8871208b..2af679ee 100644 --- a/docs/SecuritySummary.md +++ b/docs/SecuritySummary.md @@ -22,7 +22,7 @@ Name | Type | Description **figi** | str | The OpenFIGI identifier   **composite_figi** | str | The country-composite OpenFIGI identifier   **share_class_figi** | str | The global-composite OpenFIGI identifier   -**primary_listing** | bool | If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange   +**primary_listing** | bool | If True, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange   [//]: # (END_DEFINITION) diff --git a/docs/StockExchangeApi.md b/docs/StockExchangeApi.md index 086989b3..6efbdd41 100644 --- a/docs/StockExchangeApi.md +++ b/docs/StockExchangeApi.md @@ -58,9 +58,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -city = '\"New York\"' -country = '\"UNITED STATES OF AMERICA\"' -country_code = '\"US\"' +city = 'New York' +country = 'UNITED STATES OF AMERICA' +country_code = 'US' page_size = 100 response = intrinio.StockExchangeApi().get_all_stock_exchanges(city=city, country=country, country_code=country_code, page_size=page_size) @@ -139,7 +139,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"USCOMP\"' +identifier = 'USCOMP' response = intrinio.StockExchangeApi().get_stock_exchange_by_id(identifier) print(response) @@ -214,10 +214,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"USCOMP\"' -date = '\"2018-08-14\"' +identifier = 'USCOMP' +date = '2018-08-14' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.StockExchangeApi().get_stock_exchange_price_adjustments(identifier, date=date, page_size=page_size, next_page=next_page) print(response) @@ -295,10 +295,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"USCOMP\"' -date = '\"2018-08-14\"' +identifier = 'USCOMP' +date = '2018-08-14' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.StockExchangeApi().get_stock_exchange_prices(identifier, date=date, page_size=page_size, next_page=next_page) print(response) @@ -376,12 +376,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"USCOMP\"' -source = ['\"~null\"'] -active_only = "~null" +identifier = 'USCOMP' +source = [''] +active_only = '' page_size = 100 -tickers = ['\"~null\"'] -next_page = '\"~null\"' +tickers = [''] +next_page = '' response = intrinio.StockExchangeApi().get_stock_exchange_realtime_prices(identifier, source=source, active_only=active_only, page_size=page_size, tickers=tickers, next_page=next_page) print(response) @@ -461,9 +461,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"USCOMP\"' +identifier = 'USCOMP' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.StockExchangeApi().get_stock_exchange_securities(identifier, page_size=page_size, next_page=next_page) print(response) diff --git a/docs/StockPrice.md b/docs/StockPrice.md index 6086ea96..81f77f20 100644 --- a/docs/StockPrice.md +++ b/docs/StockPrice.md @@ -13,7 +13,7 @@ Name | Type | Description ------------ | ------------- | ------------- **date** | date | The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)   -**intraperiod** | bool | If true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period   +**intraperiod** | bool | If True, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period   **frequency** | str | The type of period that the stock price represents   **open** | float | The price at the beginning of the period   **high** | float | The highest price over the span of the period   diff --git a/docs/StockPriceSummary.md b/docs/StockPriceSummary.md index d34231f7..e4771bcd 100644 --- a/docs/StockPriceSummary.md +++ b/docs/StockPriceSummary.md @@ -13,7 +13,7 @@ Name | Type | Description ------------ | ------------- | ------------- **date** | date | The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)   -**intraperiod** | bool | If true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period   +**intraperiod** | bool | If True, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period   **frequency** | str | The type of period that the stock price represents   **open** | float | The price at the beginning of the period   **high** | float | The highest price over the span of the period   diff --git a/docs/TechnicalApi.md b/docs/TechnicalApi.md index fcf99f63..28a3e027 100644 --- a/docs/TechnicalApi.md +++ b/docs/TechnicalApi.md @@ -83,11 +83,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_adi(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -166,12 +166,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 22 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_adtv(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -251,12 +251,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_adx(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -336,13 +336,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' short_period = 5 long_period = 34 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_ao(identifier, short_period=short_period, long_period=long_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -423,12 +423,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_atr(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -508,14 +508,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 standard_deviations = 2.0 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_bb(identifier, period=period, standard_deviations=standard_deviations, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -597,13 +597,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 constant = 0.015 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_cci(identifier, period=period, constant=constant, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -684,12 +684,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_cmf(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -769,13 +769,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_dc(identifier, period=period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -856,13 +856,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_dpo(identifier, period=period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -943,12 +943,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_eom(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1028,11 +1028,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_fi(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1111,14 +1111,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' low_period = 9 medium_period = 26 high_period = 52 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_ichimoku(identifier, low_period=low_period, medium_period=medium_period, high_period=high_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1200,12 +1200,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 10 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_kc(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1285,7 +1285,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' roc1 = 10 roc2 = 15 roc3 = 20 @@ -1295,10 +1295,10 @@ sma2 = 10 sma3 = 10 sma4 = 15 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_kst(identifier, roc1=roc1, roc2=roc2, roc3=roc3, roc4=roc4, sma1=sma1, sma2=sma2, sma3=sma3, sma4=sma4, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1386,15 +1386,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' fast_period = 12 slow_period = 26 signal_period = 9 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_macd(identifier, fast_period=fast_period, slow_period=slow_period, signal_period=signal_period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1477,12 +1477,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_mfi(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1562,13 +1562,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' ema_period = 9 sum_period = 25 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_mi(identifier, ema_period=ema_period, sum_period=sum_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1649,11 +1649,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_nvi(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1732,11 +1732,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_obv(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1815,12 +1815,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 10 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_obv_mean(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1900,13 +1900,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_rsi(identifier, period=period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -1987,13 +1987,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 20 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_sma(identifier, period=period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2074,13 +2074,13 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 signal_period = 3 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_sr(identifier, period=period, signal_period=signal_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2161,12 +2161,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 15 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_trix(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2246,14 +2246,14 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' low_period = 13 high_period = 25 price_key = 'close' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_tsi(identifier, low_period=low_period, high_period=high_period, price_key=price_key, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2335,17 +2335,17 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' short_period = 7 medium_period = 14 long_period = 28 short_weight = 4.0 medium_weight = 2.0 long_weight = 1.0 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_uo(identifier, short_period=short_period, medium_period=medium_period, long_period=long_period, short_weight=short_weight, medium_weight=medium_weight, long_weight=long_weight, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2430,12 +2430,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_vi(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2515,11 +2515,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_vpt(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2598,11 +2598,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +identifier = 'AAPL' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_vwap(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) @@ -2681,12 +2681,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' period = 14 -start_date = '\"2018-01-01\"' -end_date = '\"2019-01-01\"' +start_date = '2018-01-01' +end_date = '2019-01-01' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.TechnicalApi().get_security_price_technicals_wr(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page) print(response) diff --git a/docs/ZacksApi.md b/docs/ZacksApi.md index 09bf68d1..89aec515 100644 --- a/docs/ZacksApi.md +++ b/docs/ZacksApi.md @@ -67,9 +67,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_analyst_ratings(identifier=identifier, page_size=page_size, next_page=next_page) print(response) @@ -162,9 +162,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -type = '\"~null\"' -next_page = '\"~null\"' +identifier = 'AAPL' +type = '' +next_page = '' response = intrinio.ZacksApi().get_zacks_ebitda_consensus(identifier=identifier, type=type, next_page=next_page) print(response) @@ -241,15 +241,15 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"~null\"' -end_date = '\"~null\"' -fiscal_year = "~null" -fiscal_period = '\"~null\"' -calendar_year = "~null" -calendar_period = '\"~null\"' +identifier = 'AAPL' +start_date = '' +end_date = '' +fiscal_year = '' +fiscal_period = '' +calendar_year = '' +calendar_period = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_eps_estimates(identifier=identifier, start_date=start_date, end_date=end_date, fiscal_year=fiscal_year, fiscal_period=fiscal_period, calendar_year=calendar_year, calendar_period=calendar_period, page_size=page_size, next_page=next_page) print(response) @@ -332,11 +332,11 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -company = '\"AAPL\"' -industry_group_name = '\"~null\"' -industry_group_number = '\"~null\"' +company = 'AAPL' +industry_group_name = '' +industry_group_number = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_eps_growth_rates(company=company, industry_group_name=industry_group_name, industry_group_number=industry_group_number, page_size=page_size, next_page=next_page) print(response) @@ -415,22 +415,22 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -start_date = '\"~null\"' -end_date = '\"~null\"' -eps_actual_greater = "~null" -eps_actual_less = "~null" -eps_mean_estimate_greater = "~null" -eps_mean_estimate_less = "~null" -eps_amount_diff_greater = "~null" -eps_amount_diff_less = "~null" -eps_percent_diff_greater = "~null" -eps_percent_diff_less = "~null" -eps_count_estimate_greater = "~null" -eps_count_estimate_less = "~null" -eps_std_dev_estimate_greater = "~null" -eps_std_dev_estimate_less = "~null" +start_date = '' +end_date = '' +eps_actual_greater = '' +eps_actual_less = '' +eps_mean_estimate_greater = '' +eps_mean_estimate_less = '' +eps_amount_diff_greater = '' +eps_amount_diff_less = '' +eps_percent_diff_greater = '' +eps_percent_diff_less = '' +eps_count_estimate_greater = '' +eps_count_estimate_less = '' +eps_std_dev_estimate_greater = '' +eps_std_dev_estimate_less = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_eps_surprises(start_date=start_date, end_date=end_date, eps_actual_greater=eps_actual_greater, eps_actual_less=eps_actual_less, eps_mean_estimate_greater=eps_mean_estimate_greater, eps_mean_estimate_less=eps_mean_estimate_less, eps_amount_diff_greater=eps_amount_diff_greater, eps_amount_diff_less=eps_amount_diff_less, eps_percent_diff_greater=eps_percent_diff_greater, eps_percent_diff_less=eps_percent_diff_less, eps_count_estimate_greater=eps_count_estimate_greater, eps_count_estimate_less=eps_count_estimate_less, eps_std_dev_estimate_greater=eps_std_dev_estimate_greater, eps_std_dev_estimate_less=eps_std_dev_estimate_less, page_size=page_size, next_page=next_page) print(response) @@ -520,12 +520,12 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -etf_ticker = '\"SPY\"' -holding_symbol = '\"AAPL\"' -weight_greater = "~null" -weight_less = "~null" +etf_ticker = 'SPY' +holding_symbol = 'AAPL' +weight_greater = '' +weight_less = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_etf_holdings(etf_ticker=etf_ticker, holding_symbol=holding_symbol, weight_greater=weight_greater, weight_less=weight_less, page_size=page_size, next_page=next_page) print(response) @@ -605,7 +605,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_forward_pe(next_page=next_page) print(response) @@ -680,7 +680,7 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"MSFT\"' +identifier = 'MSFT' response = intrinio.ZacksApi().get_zacks_forward_pe_by_identifier(identifier) print(response) @@ -755,9 +755,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -ticker = '\"~null\"' +ticker = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_institutional_holding_companies(ticker=ticker, page_size=page_size, next_page=next_page) print(response) @@ -834,9 +834,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -cik = '\"~null\"' +cik = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_institutional_holding_owners(cik=cik, page_size=page_size, next_page=next_page) print(response) @@ -913,10 +913,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -ticker = '\"~null\"' -owner_cik = '\"~null\"' +ticker = '' +owner_cik = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_institutional_holdings(ticker=ticker, owner_cik=owner_cik, page_size=page_size, next_page=next_page) print(response) @@ -994,9 +994,9 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' +identifier = 'AAPL' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_long_term_growth_rates(identifier=identifier, page_size=page_size, next_page=next_page) print(response) @@ -1073,16 +1073,16 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -start_date = '\"~null\"' -end_date = '\"~null\"' -fiscal_year = "~null" -fiscal_period = '\"~null\"' -calendar_year = "~null" -calendar_period = '\"~null\"' -next_page = '\"~null\"' +identifier = 'AAPL' +start_date = '' +end_date = '' +fiscal_year = '' +fiscal_period = '' +calendar_year = '' +calendar_period = '' +next_page = '' page_size = 100 -next_page2 = '\"~null\"' +next_page2 = '' response = intrinio.ZacksApi().get_zacks_sales_estimates(identifier=identifier, start_date=start_date, end_date=end_date, fiscal_year=fiscal_year, fiscal_period=fiscal_period, calendar_year=calendar_year, calendar_period=calendar_period, next_page=next_page, page_size=page_size, next_page2=next_page2) print(response) @@ -1166,22 +1166,22 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -start_date = '\"~null\"' -end_date = '\"~null\"' -sales_actual_greater = "~null" -sales_actual_less = "~null" -sales_mean_estimate_greater = "~null" -sales_mean_estimate_less = "~null" -sales_amount_diff_greater = "~null" -sales_amount_diff_less = "~null" -sales_percent_diff_greater = "~null" -sales_percent_diff_less = "~null" -sales_count_estimate_greater = "~null" -sales_count_estimate_less = "~null" -sales_std_dev_estimate_greater = "~null" -sales_std_dev_estimate_less = "~null" +start_date = '' +end_date = '' +sales_actual_greater = '' +sales_actual_less = '' +sales_mean_estimate_greater = '' +sales_mean_estimate_less = '' +sales_amount_diff_greater = '' +sales_amount_diff_less = '' +sales_percent_diff_greater = '' +sales_percent_diff_less = '' +sales_count_estimate_greater = '' +sales_count_estimate_less = '' +sales_std_dev_estimate_greater = '' +sales_std_dev_estimate_less = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_sales_surprises(start_date=start_date, end_date=end_date, sales_actual_greater=sales_actual_greater, sales_actual_less=sales_actual_less, sales_mean_estimate_greater=sales_mean_estimate_greater, sales_mean_estimate_less=sales_mean_estimate_less, sales_amount_diff_greater=sales_amount_diff_greater, sales_amount_diff_less=sales_amount_diff_less, sales_percent_diff_greater=sales_percent_diff_greater, sales_percent_diff_less=sales_percent_diff_less, sales_count_estimate_greater=sales_count_estimate_greater, sales_count_estimate_less=sales_count_estimate_less, sales_std_dev_estimate_greater=sales_std_dev_estimate_greater, sales_std_dev_estimate_less=sales_std_dev_estimate_less, page_size=page_size, next_page=next_page) print(response) @@ -1271,10 +1271,10 @@ from intrinio_sdk.rest import ApiException intrinio.ApiClient().set_api_key('YOUR_API_KEY') intrinio.ApiClient().allow_retries(True) -identifier = '\"AAPL\"' -industry_group_number = '\"~null\"' +identifier = 'AAPL' +industry_group_number = '' page_size = 100 -next_page = '\"~null\"' +next_page = '' response = intrinio.ZacksApi().get_zacks_target_price_consensuses(identifier=identifier, industry_group_number=industry_group_number, page_size=page_size, next_page=next_page) print(response) diff --git a/intrinio_sdk/models/security_screen_group.py b/intrinio_sdk/models/security_screen_group.py index 27b53b56..239b6bbd 100644 --- a/intrinio_sdk/models/security_screen_group.py +++ b/intrinio_sdk/models/security_screen_group.py @@ -17,7 +17,7 @@ import six from intrinio_sdk.models.security_screen_clause import SecurityScreenClause # noqa: F401,E501 -from intrinio_sdk.models.security_screen_group import SecurityScreenGroup # noqa: F401,E501 + # noqa: F401,E501 class SecurityScreenGroup(object): diff --git a/intrinio_sdk/models/security_screen_group.py-- b/intrinio_sdk/models/security_screen_group.py-- new file mode 100644 index 00000000..27b53b56 --- /dev/null +++ b/intrinio_sdk/models/security_screen_group.py-- @@ -0,0 +1,272 @@ +# 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.63.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + +from intrinio_sdk.models.security_screen_clause import SecurityScreenClause # noqa: F401,E501 +from intrinio_sdk.models.security_screen_group import SecurityScreenGroup # noqa: F401,E501 + + +class SecurityScreenGroup(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 = { + 'operator': 'str', + 'clauses': 'list[SecurityScreenClause]', + 'groups': 'list[SecurityScreenGroup]' + } + + attribute_map = { + 'operator': 'operator', + 'clauses': 'clauses', + 'groups': 'groups' + } + + def __init__(self, operator=None, clauses=None, groups=None): # noqa: E501 + """SecurityScreenGroup - a model defined in Swagger""" # noqa: E501 + + self._operator = None + self._clauses = None + self._groups = None + self.discriminator = None + + if operator is not None: + self.operator = operator + if clauses is not None: + self.clauses = clauses + if groups is not None: + self.groups = groups + + @property + def operator(self): + """Gets the operator of this SecurityScreenGroup. # noqa: E501 + + The logic operator for the group (AND, OR, NOT) # noqa: E501 + + :return: The operator of this SecurityScreenGroup. # noqa: E501 + :rtype: str + """ + return self._operator + + @property + def operator_dict(self): + """Gets the operator of this SecurityScreenGroup. # noqa: E501 + + The logic operator for the group (AND, OR, NOT) as a dictionary. Useful for Panda Dataframes. # noqa: E501 + + :return: The operator of this SecurityScreenGroup. # noqa: E501 + :rtype: str + """ + + result = None + + value = self.operator + if isinstance(value, list): + result = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result = value.to_dict() + elif isinstance(value, dict): + result = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result = { 'operator': value } + + + return result + + + @operator.setter + def operator(self, operator): + """Sets the operator of this SecurityScreenGroup. + + The logic operator for the group (AND, OR, NOT) # noqa: E501 + + :param operator: The operator of this SecurityScreenGroup. # noqa: E501 + :type: str + """ + + self._operator = operator + + @property + def clauses(self): + """Gets the clauses of this SecurityScreenGroup. # noqa: E501 + + The logic clauses in the group # noqa: E501 + + :return: The clauses of this SecurityScreenGroup. # noqa: E501 + :rtype: list[SecurityScreenClause] + """ + return self._clauses + + @property + def clauses_dict(self): + """Gets the clauses of this SecurityScreenGroup. # noqa: E501 + + The logic clauses in the group as a dictionary. Useful for Panda Dataframes. # noqa: E501 + + :return: The clauses of this SecurityScreenGroup. # noqa: E501 + :rtype: list[SecurityScreenClause] + """ + + result = None + + value = self.clauses + if isinstance(value, list): + result = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result = value.to_dict() + elif isinstance(value, dict): + result = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result = { 'clauses': value } + + + return result + + + @clauses.setter + def clauses(self, clauses): + """Sets the clauses of this SecurityScreenGroup. + + The logic clauses in the group # noqa: E501 + + :param clauses: The clauses of this SecurityScreenGroup. # noqa: E501 + :type: list[SecurityScreenClause] + """ + + self._clauses = clauses + + @property + def groups(self): + """Gets the groups of this SecurityScreenGroup. # noqa: E501 + + The nested groups within the group # noqa: E501 + + :return: The groups of this SecurityScreenGroup. # noqa: E501 + :rtype: list[SecurityScreenGroup] + """ + return self._groups + + @property + def groups_dict(self): + """Gets the groups of this SecurityScreenGroup. # noqa: E501 + + The nested groups within the group as a dictionary. Useful for Panda Dataframes. # noqa: E501 + + :return: The groups of this SecurityScreenGroup. # noqa: E501 + :rtype: list[SecurityScreenGroup] + """ + + result = None + + value = self.groups + if isinstance(value, list): + result = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result = value.to_dict() + elif isinstance(value, dict): + result = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result = { 'groups': value } + + + return result + + + @groups.setter + def groups(self, groups): + """Sets the groups of this SecurityScreenGroup. + + The nested groups within the group # noqa: E501 + + :param groups: The groups of this SecurityScreenGroup. # noqa: E501 + :type: list[SecurityScreenGroup] + """ + + self._groups = groups + + 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, SecurityScreenGroup): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other