intrinio-sdk 1.0.0

data/docs/FilingSummary.md

@@ -0,0 +1,16 @@
+# Intrinio::FilingSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the Filing | [optional] 
+**filing_date** | **Date** | The date when the filing was submitted to the SEC by the company | [optional] 
+**accepted_date** | **DateTime** | The date and time when the filing was accepted by SEC | [optional] 
+**period_end_date** | **Date** | The ending date of the fiscal period for the filing | [optional] 
+**report_type** | **String** | The filing report type | [optional] 
+**sec_unique_id** | **String** | A unique identifier for the filing provided by the SEC | [optional] 
+**filing_url** | **String** | The URL to the filing page on the SEC site | [optional] 
+**report_url** | **String** | The URL to the actual report on the SEC site | [optional] 
+**instance_url** | **String** | The URL for the XBRL filing for the report | [optional] 
+
+

data/docs/Fundamental.md

@@ -0,0 +1,16 @@
+# Intrinio::Fundamental
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the Fundamental | [optional] 
+**statement_code** | **String** | The code of the financial statement that the Fundamental represents | [optional] 
+**fiscal_year** | **Float** | The fiscal year | [optional] 
+**fiscal_period** | **String** | The fiscal period | [optional] 
+**type** | **String** | The type of Fundamental | [optional] 
+**start_date** | **Date** | The period start date | [optional] 
+**end_date** | **Date** | The period start date | [optional] 
+**filing_date** | **Date** | The date and time when the Fundamental was filed with the SEC | [optional] 
+**company** | [**CompanySummary**](CompanySummary.md) | The Company that the Fundamental was belongs to | [optional] 
+
+

data/docs/FundamentalSummary.md

@@ -0,0 +1,15 @@
+# Intrinio::FundamentalSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the Fundamental | [optional] 
+**statement_code** | **String** | The code of the financial statement that the Fundamental represents | [optional] 
+**fiscal_year** | **Float** | The fiscal year | [optional] 
+**fiscal_period** | **String** | The fiscal period | [optional] 
+**type** | **String** | The type of Fundamental | [optional] 
+**start_date** | **Date** | The period start date | [optional] 
+**end_date** | **Date** | The period start date | [optional] 
+**filing_date** | **Date** | The date and time when the Fundamental was filed with the SEC | [optional] 
+
+

data/docs/FundamentalsApi.md

@@ -0,0 +1,181 @@
+# Intrinio::FundamentalsApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_fundamental_by_id**](FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Get a Fundamental by ID
+[**get_fundamental_reported_financials**](FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Get Reported Financials for a Fundamental
+[**get_fundamental_standardized_financials**](FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Get Standardized Financials for a Fundamental
+[**lookup_fundamental**](FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup a Fundamental
+
+
+# **get_fundamental_by_id**
+> Fundamental get_fundamental_by_id(id)
+
+Get a Fundamental by ID
+
+Retrieves detailed fundamental data for the given `fundamental_id`.
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+fundamentals_api = Intrinio::FundamentalsApi.new
+
+id = "fun_ge9LlE" # String | The Intrinio ID for the Fundamental
+
+
+begin
+  result = fundamentals_api.get_fundamental_by_id(id)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FundamentalsApi->get_fundamental_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The Intrinio ID for the Fundamental | 
+
+### Return type
+
+[**Fundamental**](Fundamental.md)
+
+# **get_fundamental_reported_financials**
+> ApiResponseReportedFinancials get_fundamental_reported_financials(id)
+
+Get Reported Financials for a Fundamental
+
+Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+fundamentals_api = Intrinio::FundamentalsApi.new
+
+id = "fun_ge9LlE" # String | The Intrinio ID for the Fundamental
+
+
+begin
+  result = fundamentals_api.get_fundamental_reported_financials(id)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FundamentalsApi->get_fundamental_reported_financials: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The Intrinio ID for the Fundamental | 
+
+### Return type
+
+[**ApiResponseReportedFinancials**](ApiResponseReportedFinancials.md)
+
+# **get_fundamental_standardized_financials**
+> ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id)
+
+Get Standardized Financials for a Fundamental
+
+Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+fundamentals_api = Intrinio::FundamentalsApi.new
+
+id = "fun_ge9LlE" # String | The Intrinio ID for the Fundamental
+
+
+begin
+  result = fundamentals_api.get_fundamental_standardized_financials(id)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FundamentalsApi->get_fundamental_standardized_financials: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The Intrinio ID for the Fundamental | 
+
+### Return type
+
+[**ApiResponseStandardizedFinancials**](ApiResponseStandardizedFinancials.md)
+
+# **lookup_fundamental**
+> Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
+
+Lookup a Fundamental
+
+Returns the Fundamental for the Company with the given `identifier` and with the given parameters
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+fundamentals_api = Intrinio::FundamentalsApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+statement_code = "income_statement" # String | The statement code
+
+fiscal_year = 2017 # Integer | The fiscal year
+
+fiscal_period = "FY" # String | The fiscal period
+
+
+begin
+  result = fundamentals_api.lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling FundamentalsApi->lookup_fundamental: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **statement_code** | **String**| The statement code | 
+ **fiscal_year** | **Integer**| The fiscal year | 
+ **fiscal_period** | **String**| The fiscal period | 
+
+### Return type
+
+[**Fundamental**](Fundamental.md)
+

data/docs/HistoricalData.md

@@ -0,0 +1,9 @@
+# Intrinio::HistoricalData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **Date** | The date that the value is present | [optional] 
+**value** | **Float** | The historical value | [optional] 
+
+

data/docs/HistoricalDataApi.md

@@ -0,0 +1,64 @@
+# Intrinio::HistoricalDataApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_historical_data**](HistoricalDataApi.md#get_historical_data) | **GET** /historical_data/{identifier}/{tag} | Get Historical Data
+
+
+# **get_historical_data**
+> ApiResponseHistoricalData get_historical_data(identifier, tag, opts)
+
+Get Historical Data
+
+Returns historical values for the given `tag` and the entity represented by the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+historicalData_api = Intrinio::HistoricalDataApi.new
+
+identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
+
+tag = "marketcap" # String | An Intrinio data tag ID or code-name
+
+opts = { 
+  type: nil, # String | Filter by type, when applicable
+  start_date: Date.parse("2015-01-01"), # Date | Get historical data on or after this date
+  end_date: Date.parse("2019-01-01"), # Date | Get historical date on or before this date
+  sort_order: "desc", # String | Sort by date `asc` or `desc`
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = historicalData_api.get_historical_data(identifier, tag, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling HistoricalDataApi->get_historical_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+ **type** | **String**| Filter by type, when applicable | [optional] 
+ **start_date** | **Date**| Get historical data on or after this date | [optional] 
+ **end_date** | **Date**| Get historical date on or before this date | [optional] 
+ **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseHistoricalData**](ApiResponseHistoricalData.md)
+

data/docs/IndexApi.md

@@ -0,0 +1,800 @@
+# Intrinio::IndexApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_all_economic_indices**](IndexApi.md#get_all_economic_indices) | **GET** /indices/economic | Get All Economic Indices
+[**get_all_sic_indices**](IndexApi.md#get_all_sic_indices) | **GET** /indices/sic | Get All SIC Indices
+[**get_all_stock_market_indices**](IndexApi.md#get_all_stock_market_indices) | **GET** /indices/stock_market | Get All Stock Market Indices
+[**get_economic_index_by_id**](IndexApi.md#get_economic_index_by_id) | **GET** /indices/economic/{identifier} | Get an Economic Index by ID
+[**get_economic_index_data_point_number**](IndexApi.md#get_economic_index_data_point_number) | **GET** /indices/economic/{identifier}/data_point/{tag}/number | Get Economic Index Data Point (Number)
+[**get_economic_index_data_point_text**](IndexApi.md#get_economic_index_data_point_text) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Get Economic Index Data Point (Text)
+[**get_economic_index_historical_data**](IndexApi.md#get_economic_index_historical_data) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Get Economic Index Historical Data
+[**get_sic_index_by_id**](IndexApi.md#get_sic_index_by_id) | **GET** /indices/sic/{identifier} | Get an SIC Index by ID
+[**get_sic_index_data_point_number**](IndexApi.md#get_sic_index_data_point_number) | **GET** /indices/sic/{identifier}/data_point/{tag}/number | Get SIC Index Data Point (Number)
+[**get_sic_index_data_point_text**](IndexApi.md#get_sic_index_data_point_text) | **GET** /indices/sic/{identifier}/data_point/{tag}/text | Get SIC Index Data Point (Text)
+[**get_sic_index_historical_data**](IndexApi.md#get_sic_index_historical_data) | **GET** /indices/sic/{identifier}/historical_data/{tag} | Get SIC Index Historical Data
+[**get_stock_market_index_by_id**](IndexApi.md#get_stock_market_index_by_id) | **GET** /indices/stock_market/{identifier} | Get a Stock Market Index by ID
+[**get_stock_market_index_data_point_number**](IndexApi.md#get_stock_market_index_data_point_number) | **GET** /indices/stock_market/{identifier}/data_point/{tag}/number | Get Stock Market Index Data Point (Number)
+[**get_stock_market_index_data_point_text**](IndexApi.md#get_stock_market_index_data_point_text) | **GET** /indices/stock_market/{identifier}/data_point/{tag}/text | Get Stock Market Index Data Point (Text)
+[**get_stock_market_index_historical_data**](IndexApi.md#get_stock_market_index_historical_data) | **GET** /indices/stock_market/{identifier}/historical_data/{tag} | Get Stock Market Index Historical Data
+[**search_economic_indices**](IndexApi.md#search_economic_indices) | **GET** /indices/economic/search | Search Economic Indices
+[**search_sic_indices**](IndexApi.md#search_sic_indices) | **GET** /indices/sic/search | Search SIC Indices
+[**search_stock_markets_indices**](IndexApi.md#search_stock_markets_indices) | **GET** /indices/stock_market/search | Search Stock Market Indices
+
+
+# **get_all_economic_indices**
+> ApiResponseEconomicIndices get_all_economic_indices(opts)
+
+Get All Economic Indices
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+opts = { 
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = index_api.get_all_economic_indices(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_all_economic_indices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseEconomicIndices**](ApiResponseEconomicIndices.md)
+
+# **get_all_sic_indices**
+> ApiResponseSICIndices get_all_sic_indices(opts)
+
+Get All SIC Indices
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+opts = { 
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = index_api.get_all_sic_indices(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_all_sic_indices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseSICIndices**](ApiResponseSICIndices.md)
+
+# **get_all_stock_market_indices**
+> ApiResponseStockMarketIndices get_all_stock_market_indices(opts)
+
+Get All Stock Market Indices
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+opts = { 
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = index_api.get_all_stock_market_indices(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_all_stock_market_indices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseStockMarketIndices**](ApiResponseStockMarketIndices.md)
+
+# **get_economic_index_by_id**
+> EconomicIndex get_economic_index_by_id(identifier)
+
+Get an Economic Index by ID
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
+
+
+begin
+  result = index_api.get_economic_index_by_id(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_economic_index_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+
+### Return type
+
+[**EconomicIndex**](EconomicIndex.md)
+
+# **get_economic_index_data_point_number**
+> Float get_economic_index_data_point_number(identifier, tag)
+
+Get Economic Index Data Point (Number)
+
+Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "level" # String | An Intrinio data tag ID or code-name
+
+
+begin
+  result = index_api.get_economic_index_data_point_number(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_economic_index_data_point_number: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**Float**
+
+# **get_economic_index_data_point_text**
+> String get_economic_index_data_point_text(identifier, tag)
+
+Get Economic Index Data Point (Text)
+
+Returns a text value for the given `tag` for the Economic Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "level" # String | An Intrinio data tag ID or code-name
+
+
+begin
+  result = index_api.get_economic_index_data_point_text(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_economic_index_data_point_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**String**
+
+# **get_economic_index_historical_data**
+> ApiResponseEconomicIndexHistoricalData get_economic_index_historical_data(identifier, tag, opts)
+
+Get Economic Index Historical Data
+
+Returns historical values for the given `tag` and the Economic Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "level" # String | An Intrinio data tag ID or code-name
+
+opts = { 
+  type: nil, # String | Filter by type, when applicable
+  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
+  end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
+  sort_order: "desc", # String | Sort by date `asc` or `desc`
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = index_api.get_economic_index_historical_data(identifier, tag, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_economic_index_historical_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+ **type** | **String**| Filter by type, when applicable | [optional] 
+ **start_date** | **Date**| Get historical data on or after this date | [optional] 
+ **end_date** | **Date**| Get historical data on or before this date | [optional] 
+ **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseEconomicIndexHistoricalData**](ApiResponseEconomicIndexHistoricalData.md)
+
+# **get_sic_index_by_id**
+> SICIndex get_sic_index_by_id(identifier)
+
+Get an SIC Index by ID
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID)
+
+
+begin
+  result = index_api.get_sic_index_by_id(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_sic_index_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+
+### Return type
+
+[**SICIndex**](SICIndex.md)
+
+# **get_sic_index_data_point_number**
+> Float get_sic_index_data_point_number(identifier, tag)
+
+Get SIC Index Data Point (Number)
+
+Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "level" # String | An Intrinio data tag ID or code-name
+
+
+begin
+  result = index_api.get_sic_index_data_point_number(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_sic_index_data_point_number: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**Float**
+
+# **get_sic_index_data_point_text**
+> String get_sic_index_data_point_text(identifier, tag)
+
+Get SIC Index Data Point (Text)
+
+Returns a text value for the given `tag` for the SIC Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "level" # String | An Intrinio data tag ID or code-name
+
+
+begin
+  result = index_api.get_sic_index_data_point_text(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_sic_index_data_point_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**String**
+
+# **get_sic_index_historical_data**
+> ApiResponseSICIndexHistoricalData get_sic_index_historical_data(identifier, tag, opts)
+
+Get SIC Index Historical Data
+
+Returns historical values for the given `tag` and the SIC Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$SIC.1" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "marketcap" # String | An Intrinio data tag ID or code-name
+
+opts = { 
+  type: nil, # String | Filter by type, when applicable
+  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
+  end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
+  sort_order: "desc", # String | Sort by date `asc` or `desc`
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = index_api.get_sic_index_historical_data(identifier, tag, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_sic_index_historical_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+ **type** | **String**| Filter by type, when applicable | [optional] 
+ **start_date** | **Date**| Get historical data on or after this date | [optional] 
+ **end_date** | **Date**| Get historical data on or before this date | [optional] 
+ **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseSICIndexHistoricalData**](ApiResponseSICIndexHistoricalData.md)
+
+# **get_stock_market_index_by_id**
+> StockMarketIndex get_stock_market_index_by_id(identifier)
+
+Get a Stock Market Index by ID
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID)
+
+
+begin
+  result = index_api.get_stock_market_index_by_id(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_stock_market_index_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+
+### Return type
+
+[**StockMarketIndex**](StockMarketIndex.md)
+
+# **get_stock_market_index_data_point_number**
+> Float get_stock_market_index_data_point_number(identifier, tag)
+
+Get Stock Market Index Data Point (Number)
+
+Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "level" # String | An Intrinio data tag ID or code-name
+
+
+begin
+  result = index_api.get_stock_market_index_data_point_number(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_stock_market_index_data_point_number: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**Float**
+
+# **get_stock_market_index_data_point_text**
+> String get_stock_market_index_data_point_text(identifier, tag)
+
+Get Stock Market Index Data Point (Text)
+
+Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "level" # String | An Intrinio data tag ID or code-name
+
+
+begin
+  result = index_api.get_stock_market_index_data_point_text(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_stock_market_index_data_point_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+
+### Return type
+
+**String**
+
+# **get_stock_market_index_historical_data**
+> ApiResponseStockMarketIndexHistoricalData get_stock_market_index_historical_data(identifier, tag, opts)
+
+Get Stock Market Index Historical Data
+
+Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+identifier = "$DJI" # String | An Index Identifier (symbol, Intrinio ID)
+
+tag = "level" # String | An Intrinio data tag ID or code-name
+
+opts = { 
+  type: nil, # String | Filter by type, when applicable
+  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
+  end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
+  sort_order: "desc", # String | Sort by date `asc` or `desc`
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = index_api.get_stock_market_index_historical_data(identifier, tag, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->get_stock_market_index_historical_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag ID or code-name | 
+ **type** | **String**| Filter by type, when applicable | [optional] 
+ **start_date** | **Date**| Get historical data on or after this date | [optional] 
+ **end_date** | **Date**| Get historical data on or before this date | [optional] 
+ **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseStockMarketIndexHistoricalData**](ApiResponseStockMarketIndexHistoricalData.md)
+
+# **search_economic_indices**
+> ApiResponseEconomicIndices search_economic_indices(query)
+
+Search Economic Indices
+
+Searches for indices using the text in `query`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+query = "GDP" # String | Search query
+
+
+begin
+  result = index_api.search_economic_indices(query)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->search_economic_indices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**| Search query | 
+
+### Return type
+
+[**ApiResponseEconomicIndices**](ApiResponseEconomicIndices.md)
+
+# **search_sic_indices**
+> ApiResponseSICIndices search_sic_indices(query)
+
+Search SIC Indices
+
+Searches for indices using the text in `query`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+query = "agriculture" # String | Search query
+
+
+begin
+  result = index_api.search_sic_indices(query)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->search_sic_indices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**| Search query | 
+
+### Return type
+
+[**ApiResponseSICIndices**](ApiResponseSICIndices.md)
+
+# **search_stock_markets_indices**
+> ApiResponseStockMarketIndices search_stock_markets_indices(query)
+
+Search Stock Market Indices
+
+Searches for indices using the text in `query`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+index_api = Intrinio::IndexApi.new
+
+query = "dow" # String | Search query
+
+
+begin
+  result = index_api.search_stock_markets_indices(query)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling IndexApi->search_stock_markets_indices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**| Search query | 
+
+### Return type
+
+[**ApiResponseStockMarketIndices**](ApiResponseStockMarketIndices.md)
+