intrinio-sdk 1.0.0 → 1.1.0

data/docs/HistoricalDataApi.md

@@ -4,13 +4,13 @@ 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**](HistoricalDataApi.md#get_historical_data) | **GET** /historical_data/{identifier}/{tag} | Historical Data
 
 
 # **get_historical_data**
 > ApiResponseHistoricalData get_historical_data(identifier, tag, opts)
 
-Get Historical Data
+Historical Data
 
 Returns historical values for the given `tag` and the entity represented by the given `identifier`
 

data/docs/IndexApi.md

@@ -4,21 +4,21 @@ 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
+[**get_all_economic_indices**](IndexApi.md#get_all_economic_indices) | **GET** /indices/economic | All Economic Indices
+[**get_all_sic_indices**](IndexApi.md#get_all_sic_indices) | **GET** /indices/sic | All SIC Indices
+[**get_all_stock_market_indices**](IndexApi.md#get_all_stock_market_indices) | **GET** /indices/stock_market | All Stock Market Indices
+[**get_economic_index_by_id**](IndexApi.md#get_economic_index_by_id) | **GET** /indices/economic/{identifier} | Lookup Economic Index
+[**get_economic_index_data_point_number**](IndexApi.md#get_economic_index_data_point_number) | **GET** /indices/economic/{identifier}/data_point/{tag}/number | Data Point (Number) for an Economic Index
+[**get_economic_index_data_point_text**](IndexApi.md#get_economic_index_data_point_text) | **GET** /indices/economic/{identifier}/data_point/{tag}/text | Data Point (Text) for an Economic Index
+[**get_economic_index_historical_data**](IndexApi.md#get_economic_index_historical_data) | **GET** /indices/economic/{identifier}/historical_data/{tag} | Historical Data for an Economic Index
+[**get_sic_index_by_id**](IndexApi.md#get_sic_index_by_id) | **GET** /indices/sic/{identifier} | Lookup SIC Index
+[**get_sic_index_data_point_number**](IndexApi.md#get_sic_index_data_point_number) | **GET** /indices/sic/{identifier}/data_point/{tag}/number | Data Point (Number) for an SIC Index
+[**get_sic_index_data_point_text**](IndexApi.md#get_sic_index_data_point_text) | **GET** /indices/sic/{identifier}/data_point/{tag}/text | Data Point (Text) for an SIC Index
+[**get_sic_index_historical_data**](IndexApi.md#get_sic_index_historical_data) | **GET** /indices/sic/{identifier}/historical_data/{tag} | Historical Data for an SIC Index
+[**get_stock_market_index_by_id**](IndexApi.md#get_stock_market_index_by_id) | **GET** /indices/stock_market/{identifier} | Lookup Stock Market Index
+[**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 | Data Point (Number) for Stock Market Index
+[**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 | Data Point (Text) for Stock Market Index
+[**get_stock_market_index_historical_data**](IndexApi.md#get_stock_market_index_historical_data) | **GET** /indices/stock_market/{identifier}/historical_data/{tag} | Historical Data for Stock Market Index
 [**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
@@ -27,7 +27,7 @@ Method | HTTP request | Description
 # **get_all_economic_indices**
 > ApiResponseEconomicIndices get_all_economic_indices(opts)
 
-Get All Economic Indices
+All Economic Indices
 
 ### Example
 ```ruby
@@ -66,7 +66,7 @@ Name | Type | Description  | Notes
 # **get_all_sic_indices**
 > ApiResponseSICIndices get_all_sic_indices(opts)
 
-Get All SIC Indices
+All SIC Indices
 
 ### Example
 ```ruby
@@ -105,7 +105,7 @@ Name | Type | Description  | Notes
 # **get_all_stock_market_indices**
 > ApiResponseStockMarketIndices get_all_stock_market_indices(opts)
 
-Get All Stock Market Indices
+All Stock Market Indices
 
 ### Example
 ```ruby
@@ -144,7 +144,7 @@ Name | Type | Description  | Notes
 # **get_economic_index_by_id**
 > EconomicIndex get_economic_index_by_id(identifier)
 
-Get an Economic Index by ID
+Lookup Economic Index
 
 ### Example
 ```ruby
@@ -182,7 +182,7 @@ Name | Type | Description  | Notes
 # **get_economic_index_data_point_number**
 > Float get_economic_index_data_point_number(identifier, tag)
 
-Get Economic Index Data Point (Number)
+Data Point (Number) for an Economic Index
 
 Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
 
@@ -225,7 +225,7 @@ Name | Type | Description  | Notes
 # **get_economic_index_data_point_text**
 > String get_economic_index_data_point_text(identifier, tag)
 
-Get Economic Index Data Point (Text)
+Data Point (Text) for an Economic Index
 
 Returns a text value for the given `tag` for the Economic Index with the given `identifier`
 
@@ -268,7 +268,7 @@ Name | Type | Description  | Notes
 # **get_economic_index_historical_data**
 > ApiResponseEconomicIndexHistoricalData get_economic_index_historical_data(identifier, tag, opts)
 
-Get Economic Index Historical Data
+Historical Data for an Economic Index
 
 Returns historical values for the given `tag` and the Economic Index with the given `identifier`
 
@@ -323,7 +323,7 @@ Name | Type | Description  | Notes
 # **get_sic_index_by_id**
 > SICIndex get_sic_index_by_id(identifier)
 
-Get an SIC Index by ID
+Lookup SIC Index
 
 ### Example
 ```ruby
@@ -361,7 +361,7 @@ Name | Type | Description  | Notes
 # **get_sic_index_data_point_number**
 > Float get_sic_index_data_point_number(identifier, tag)
 
-Get SIC Index Data Point (Number)
+Data Point (Number) for an SIC Index
 
 Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`
 
@@ -404,7 +404,7 @@ Name | Type | Description  | Notes
 # **get_sic_index_data_point_text**
 > String get_sic_index_data_point_text(identifier, tag)
 
-Get SIC Index Data Point (Text)
+Data Point (Text) for an SIC Index
 
 Returns a text value for the given `tag` for the SIC Index with the given `identifier`
 
@@ -447,7 +447,7 @@ Name | Type | Description  | Notes
 # **get_sic_index_historical_data**
 > ApiResponseSICIndexHistoricalData get_sic_index_historical_data(identifier, tag, opts)
 
-Get SIC Index Historical Data
+Historical Data for an SIC Index
 
 Returns historical values for the given `tag` and the SIC Index with the given `identifier`
 
@@ -502,7 +502,7 @@ Name | Type | Description  | Notes
 # **get_stock_market_index_by_id**
 > StockMarketIndex get_stock_market_index_by_id(identifier)
 
-Get a Stock Market Index by ID
+Lookup Stock Market Index
 
 ### Example
 ```ruby
@@ -540,7 +540,7 @@ Name | Type | Description  | Notes
 # **get_stock_market_index_data_point_number**
 > Float get_stock_market_index_data_point_number(identifier, tag)
 
-Get Stock Market Index Data Point (Number)
+Data Point (Number) for Stock Market Index
 
 Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`
 
@@ -583,7 +583,7 @@ Name | Type | Description  | Notes
 # **get_stock_market_index_data_point_text**
 > String get_stock_market_index_data_point_text(identifier, tag)
 
-Get Stock Market Index Data Point (Text)
+Data Point (Text) for Stock Market Index
 
 Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`
 
@@ -626,7 +626,7 @@ Name | Type | Description  | Notes
 # **get_stock_market_index_historical_data**
 > ApiResponseStockMarketIndexHistoricalData get_stock_market_index_historical_data(identifier, tag, opts)
 
-Get Stock Market Index Historical Data
+Historical Data for Stock Market Index
 
 Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`
 

data/docs/RealtimeStockPrice.md

@@ -0,0 +1,21 @@
+# Intrinio::RealtimeStockPrice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_price** | **Float** | The price of the last trade. | [optional] 
+**last_time** | **DateTime** | The date and time when the last trade occurred. | [optional] 
+**bid_price** | **Float** | The price of the top bid order. | [optional] 
+**bid_size** | **Float** | The size of the top bid order. | [optional] 
+**ask_price** | **Float** | The price of the top ask order. | [optional] 
+**ask_size** | **Float** | The size of the top ask order. | [optional] 
+**open_price** | **Float** | The price at the open of the trading day. | [optional] 
+**high_price** | **Float** | The high price for the trading day. | [optional] 
+**low_price** | **Float** | The low price for the trading day. | [optional] 
+**exchange_volume** | **Float** | The number of shares exchanged during the trading day on the exchange. | [optional] 
+**market_volume** | **Float** | The number of shares exchanged during the trading day for the whole market. | [optional] 
+**updated_on** | **DateTime** | The date and time when the data was last updated. | [optional] 
+**source** | **String** | Source of the realtime quote. | [optional] 
+**security** | [**RealtimeStockPriceSecurity**](RealtimeStockPriceSecurity.md) |  | [optional] 
+
+

data/docs/RealtimeStockPriceSecurity.md

@@ -0,0 +1,12 @@
+# Intrinio::RealtimeStockPriceSecurity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for Security | [optional] 
+**ticker** | **String** | The common/local ticker of the Security | [optional] 
+**exchange_ticker** | **String** | The exchange-level ticker | [optional] 
+**figi** | **String** | The OpenFIGI identifier | [optional] 
+**composite_figi** | **String** | The country-composite OpenFIGI identifier | [optional] 
+
+

data/docs/SecurityApi.md

@@ -4,13 +4,16 @@ All URIs are relative to *https://api-v2.intrinio.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_all_securities**](SecurityApi.md#get_all_securities) | **GET** /securities | Get All Securiites
-[**get_security_by_id**](SecurityApi.md#get_security_by_id) | **GET** /securities/{identifier} | Get a Security by ID
-[**get_security_data_point_number**](SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Get Security Data Point (Number)
-[**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Get Security Data Point (Text)
-[**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Get Security Historical Data
-[**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Get Stock Price Adjustments for Security
-[**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Get Stock Prices for Security
+[**get_all_securities**](SecurityApi.md#get_all_securities) | **GET** /securities | All Securities
+[**get_security_by_id**](SecurityApi.md#get_security_by_id) | **GET** /securities/{identifier} | Lookup Security
+[**get_security_data_point_number**](SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Data Point (Number) for Security
+[**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
+[**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
+[**get_security_latest_dividend_record**](SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Lastest Dividend Record for Security
+[**get_security_latest_earnings_record**](SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Lastest Earnings Record for Security
+[**get_security_realtime_price**](SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
+[**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
+[**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
 [**screen_securities**](SecurityApi.md#screen_securities) | **POST** /securities/screen | Screen Securities
 [**search_securities**](SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities
 
@@ -18,7 +21,7 @@ Method | HTTP request | Description
 # **get_all_securities**
 > ApiResponseSecurities get_all_securities(opts)
 
-Get All Securiites
+All Securities
 
 ### Example
 ```ruby
@@ -57,7 +60,9 @@ Name | Type | Description  | Notes
 # **get_security_by_id**
 > Security get_security_by_id(identifier)
 
-Get a Security by ID
+Lookup Security
+
+Returns the Security with the given `identifier`
 
 ### Example
 ```ruby
@@ -95,7 +100,7 @@ Name | Type | Description  | Notes
 # **get_security_data_point_number**
 > Float get_security_data_point_number(identifier, tag)
 
-Get Security Data Point (Number)
+Data Point (Number) for Security
 
 Returns a numeric value for the given `tag` for the Security with the given `identifier`
 
@@ -138,7 +143,7 @@ Name | Type | Description  | Notes
 # **get_security_data_point_text**
 > String get_security_data_point_text(identifier, tag)
 
-Get Security Data Point (Text)
+Data Point (Text) for Security
 
 Returns a text value for the given `tag` for the Security with the given `identifier`
 
@@ -181,7 +186,7 @@ Name | Type | Description  | Notes
 # **get_security_historical_data**
 > ApiResponseSecurityHistoricalData get_security_historical_data(identifier, tag, opts)
 
-Get Security Historical Data
+Historical Data for Security
 
 Returns historical values for the given `tag` and the Security with the given `identifier`
 
@@ -202,6 +207,7 @@ identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP,
 tag = "volume" # String | An Intrinio data tag ID or code-name
 
 opts = { 
+  frequency: "daily", # String | Return historical data in the given frequency
   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 date on or before this date
@@ -223,6 +229,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
  **tag** | **String**| An Intrinio data tag ID or code-name | 
+ **frequency** | **String**| Return historical data in the given frequency | [optional] [default to daily]
  **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] 
@@ -233,12 +240,136 @@ Name | Type | Description  | Notes
 
 [**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md)
 
+# **get_security_latest_dividend_record**
+> DividendRecord get_security_latest_dividend_record(identifier)
+
+Lastest Dividend Record for Security
+
+Returns the latest available dividend information for the Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+
+begin
+  result = security_api.get_security_latest_dividend_record(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_latest_dividend_record: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+
+### Return type
+
+[**DividendRecord**](DividendRecord.md)
+
+# **get_security_latest_earnings_record**
+> EarningsRecord get_security_latest_earnings_record(identifier)
+
+Lastest Earnings Record for Security
+
+Returns latest available earnings information for the Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+
+begin
+  result = security_api.get_security_latest_earnings_record(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_latest_earnings_record: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+
+### Return type
+
+[**EarningsRecord**](EarningsRecord.md)
+
+# **get_security_realtime_price**
+> RealtimeStockPrice get_security_realtime_price(identifier, opts)
+
+Realtime Stock Price for Security
+
+Return the realtime stock price for the Security 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
+
+security_api = Intrinio::SecurityApi.new
+
+identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+
+opts = { 
+  source: nil # String | Return the realtime price from the specified data source
+}
+
+begin
+  result = security_api.get_security_realtime_price(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling SecurityApi->get_security_realtime_price: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | 
+ **source** | **String**| Return the realtime price from the specified data source | [optional] 
+
+### Return type
+
+[**RealtimeStockPrice**](RealtimeStockPrice.md)
+
 # **get_security_stock_price_adjustments**
 > ApiResponseSecurityStockPriceAdjustments get_security_stock_price_adjustments(identifier, opts)
 
-Get Stock Price Adjustments for Security
+Stock Price Adjustments by Security
 
-Return stock price adjustments for the Security with the given `identifier`
+Returns stock price adjustments for the Security with the given `identifier`
 
 ### Example
 ```ruby
@@ -284,9 +415,9 @@ Name | Type | Description  | Notes
 # **get_security_stock_prices**
 > ApiResponseSecurityStockPrices get_security_stock_prices(identifier, opts)
 
-Get Stock Prices for Security
+Stock Prices by Security
 
-Return stock prices for the Security with the given `identifier`
+Return end-of-day stock prices for the Security with the given `identifier`
 
 ### Example
 ```ruby
@@ -336,7 +467,7 @@ Name | Type | Description  | Notes
 
 Screen Securities
 
-Screen securities using complex logic
+Screen Securities using complex logic
 
 ### Example
 ```ruby