intrinio-sdk 5.6.1 → 5.9.0

data/docs/InsiderTransaction.md

@@ -0,0 +1,44 @@
+
+
+[//]: # (CLASS:Intrinio::InsiderTransaction)
+
+[//]: # (KIND:object)
+
+### Intrinio::InsiderTransaction
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**director** | BOOLEAN | (true/false) A boolean indicating whether or not the owner is a director in the company  
+**officer** | BOOLEAN | (true/false) A boolean indicating whether or not the owner is a officer in the company  
+**ten_percent_owner** | BOOLEAN | (true/false) A boolean indicating whether or not the owner has a ten percent or greater interest in the company  
+**other_relation** | BOOLEAN | (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** | String | The officer title of the owner in the company  
+**derivative_transaction** | BOOLEAN | (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** | String | The ticker symbol for the company’s common stock  
+**security_title** | String | The name of the derivative security transacted  
+**conversion_exercise_price** | Float | The conversion or exercise price of the derivative security transacted  
+**transaction_type_code** | String | A symbol representing the transaction type; P = Purchase | S = Sale | A  = Award | M = Conversion to Common | C = Conversion | X = Exercise of Derivative More Transaction Codes  
+**acquisition_disposition_code** | String | A symbol representing whether or not the derivative securities are Acquired or Disposed; A = Acquisition | D = Disposition  
+**amount_of_shares** | Float | The number of derivative securities involved in the subject transaction  
+**underlying_security_title** | String | The name of the underlying non-derivative security related to this derivative transaction  
+**underlying_shares** | Float | The number of non-derivative shares involved in the subject transaction  
+**transaction_price** | Float | The price of the derivative securities  
+**total_shares_owned** | Float | The total number of derivative securities owned following the subject transaction  
+**ownership_type_code** | String | A symbol representing the ownership of the securities transacted; D = Direct Ownership | I = Indirect Ownership  
+**company** | [**CompanySummary**](CompanySummary.md) | The company associated with the filing  
+**owner** | [**OwnerSummary**](OwnerSummary.md) | The owner associated with the filing  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OwnerSummary)
+
+
+

data/docs/InsiderTransactionFiling.md

@@ -0,0 +1,32 @@
+
+
+[//]: # (CLASS:Intrinio::InsiderTransactionFiling)
+
+[//]: # (KIND:object)
+
+### Intrinio::InsiderTransactionFiling
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**filing_url** | String | The URL of the filing with the SEC  
+**transactions** | [**Array<InsiderTransaction>**](InsiderTransaction.md) | The insider transactions associated with the filing  
+**company** | [**CompanySummary**](CompanySummary.md) | The company associated with the filing  
+**owner** | [**OwnerSummary**](OwnerSummary.md) | The owner associated with the filing  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::InsiderTransaction)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OwnerSummary)
+
+
+

data/docs/InsiderTransactionFilingsApi.md

@@ -0,0 +1,95 @@
+# Intrinio::InsiderTransactionFilingsApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_all_insider_transaction_filings**](InsiderTransactionFilingsApi.md#get_all_insider_transaction_filings) | **GET** /insider_transaction_filings | All Insider Transactions Filings
+
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::InsiderTransactionFilingsApi)
+
+[//]: # (METHOD:get_all_insider_transaction_filings)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOwnerInsiderTransactionFilings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOwnerInsiderTransactionFilings.md)
+
+[//]: # (OPERATION:get_all_insider_transaction_filings_v2)
+
+[//]: # (ENDPOINT:/insider_transaction_filings)
+
+[//]: # (DOCUMENT_LINK:InsiderTransactionFilingsApi.md#get_all_insider_transaction_filings)
+
+## **get_all_insider_transaction_filings**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_insider_transaction_filings_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOwnerInsiderTransactionFilings get_all_insider_transaction_filings(opts)
+
+#### All Insider Transactions Filings
+
+
+Returns all insider transactions filings fitting the optional supplied start and end date.
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
+end
+
+insiderTransactionFilings_api = Intrinio::InsiderTransactionFilingsApi.new
+
+opts = {
+  start_date: Date.parse("2015-01-01"),
+  end_date: nil,
+  page_size: 100,
+  next_page: nil
+}
+
+result = insiderTransactionFilings_api.get_all_insider_transaction_filings(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start_date** | Date| Filed on or after the given date | [optional]   
+ **end_date** | Date| Filed before or after the given date | [optional]   
+ **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOwnerInsiderTransactionFilings**](ApiResponseOwnerInsiderTransactionFilings.md)
+
+[//]: # (END_OPERATION)
+

data/docs/InstitutionalHolding.md

@@ -0,0 +1,34 @@
+
+
+[//]: # (CLASS:Intrinio::InstitutionalHolding)
+
+[//]: # (KIND:object)
+
+### Intrinio::InstitutionalHolding
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**cusip** | String | The CUSIP number for the security report by the Institutional Owner  
+**ticker** | String | The ticker symbol for the security  
+**security_name** | String | The name of the security  
+**security_type** | String | The type of the security  
+**title_of_class** | String | The class of stock held  
+**stock_exchange** | String | The stock exchange where the security is traded  
+**filing_date** | Date | The date when the filing was submitted to the SEC by the company  
+**value** | Float | The market value in amount of dollars of the holding in the listed security  
+**amount** | Float | The number of shares held in the listed security  
+**type** | String | Shares  
+**investment_discretion** | String | Segregate the holdings of securities of a class according to the nature of the investment discretion held by the Manager.  
+**other_manager** | String | A code for other managerial authority of the securities listed  
+**sole_voting_authority** | Float | The number of shares where the insitutional holder has sole voting authority  
+**shared_voting_authority** | Float | The number of shares where the insitutional holder has shared voting authority  
+**no_voting_authority** | Float | The number of shares where the insitutional holder has no voting authority  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/InstitutionalOwnership.md

@@ -0,0 +1,29 @@
+
+
+[//]: # (CLASS:Intrinio::InstitutionalOwnership)
+
+[//]: # (KIND:object)
+
+### Intrinio::InstitutionalOwnership
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**owner_cik** | String | The Central Index Key issued by the SEC, which is the unique identifier all owner filings  
+**owner_name** | String | The name of the institutional owner  
+**value** | Float | The market value in amount of dollars of the holding in the listed security  
+**amount** | Float | The number of shares held in the listed security  
+**sole_voting_authority** | Float | The number of shares where the insitutional holder has sole voting authority  
+**shared_voting_authority** | Float | The number of shares where the insitutional holder has shared voting authority  
+**no_voting_authority** | Float | The number of shares where the insitutional holder has no voting authority  
+**previous_amount** | Float | The prior quarter number of shares held by the owner  
+**amount_change** | Float | The change in number of shares held from the prior quarter  
+**amount_percent_change** | Float | The percentage change in the number of shares held from the prior quarter  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/MunicipalityApi.md

@@ -39,6 +39,7 @@ Method | HTTP request | Description
 #### All Municipalities
 
 
+Returns all Municipalities. When parameters are specified, returns matching municipalities.
 
 [//]: # (END_OVERVIEW)
 
@@ -54,32 +55,29 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 municipality_api = Intrinio::MunicipalityApi.new
 
-opts = { 
-  has_financials: true, # BOOLEAN | Return municipalities with financials
-  government_name: nil, # String | Return municipalities with a government name matching the given query
-  government_type: nil, # String | Return municipalities with the given government type
-  area_name: nil, # String | Return municipalities with an area name matching the given query
-  area_type: nil, # String | Return municipalities with the given area type
-  city: nil, # String | Return municipalities in the given city
-  state: nil, # String | Return municipalities in the given state
-  zipcode: nil, # Float | Return municipalities in the given zipcode
-  population_greater_than: nil, # Float | Return municipalities with a population greater than the given number
-  population_less_than: nil, # Float | Return municipalities with a population less than the given number
-  enrollment_greater_than: nil, # Float | Return municipalities with an enrollment greater than the given number
-  enrollment_less_than: nil, # Float | Return municipalities with an enrollment less than the given number
-  next_page: nil # String | Gets the next page of data from a previous API call
+opts = {
+  has_financials: nil,
+  government_name: nil,
+  government_type: nil,
+  area_name: nil,
+  area_type: nil,
+  city: nil,
+  state: nil,
+  zipcode: nil,
+  population_greater_than: nil,
+  population_less_than: nil,
+  enrollment_greater_than: nil,
+  enrollment_less_than: nil,
+  next_page: nil
 }
 
-begin
-  result = municipality_api.get_all_municipalities(opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling MunicipalityApi->get_all_municipalities: #{e}"
-end
+result = municipality_api.get_all_municipalities(opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -161,19 +159,14 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 municipality_api = Intrinio::MunicipalityApi.new
+id = "mun_Xn7x4z"
 
-id = "mun_Xn7x4z" # String | An Intrinio ID of a Municipality
-
-
-begin
-  result = municipality_api.get_municipality_by_id(id)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling MunicipalityApi->get_municipality_by_id: #{e}"
-end
+result = municipality_api.get_municipality_by_id(id)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)
@@ -243,22 +236,18 @@ require 'pp'
 # Setup authorization
 Intrinio.configure do |config|
   config.api_key['api_key'] = 'YOUR_API_KEY'
+  config.allow_retries = true
 end
 
 municipality_api = Intrinio::MunicipalityApi.new
+id = "mun_Xn7x4z"
 
-id = "mun_Xn7x4z" # String | An Intrinio ID of a Municipality
-
-opts = { 
-  fiscal_year: 2017 # Float | Return financials for the given fiscal year
+opts = {
+  fiscal_year: 2017
 }
 
-begin
-  result = municipality_api.get_municipality_financials(id, opts)
-  pp result
-rescue Intrinio::ApiError => e
-  puts "Exception when calling MunicipalityApi->get_municipality_financials: #{e}"
-end
+result = municipality_api.get_municipality_financials(id, opts)
+pp result
 ```
 
 [//]: # (END_CODE_EXAMPLE)

data/docs/OptionChainRealtime.md

@@ -0,0 +1,31 @@
+
+
+[//]: # (CLASS:Intrinio::OptionChainRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionChainRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**option** | [**OptionRealtime**](OptionRealtime.md) |   
+**price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   
+**stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionRealtime)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionPriceRealtime)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionStatsRealtime)
+
+
+

data/docs/OptionFactorsRealtime.md

@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:Intrinio::OptionFactorsRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionFactorsRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**market_price** | Float | The market price of the options contract  
+**underlying_price** | Float | The market price of the underlying asset  
+**strike_price** | Float | The strike price of the options contract  
+**days_to_expiration** | Float | The number of days to expiration  
+**risk_free_interest_rate** | Float | The current risk-free interest rate, as measured by the 3-month Treasury Bill rate  
+**dividend_yield** | Float | The divident yield of the underlying asset (if applicable)  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionPriceRealtime.md

@@ -0,0 +1,31 @@
+
+
+[//]: # (CLASS:Intrinio::OptionPriceRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionPriceRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**last** | Float | The price of the last trade  
+**last_size** | Integer | The size of the last trade  
+**last_timestamp** | DateTime | The time of the last trade  
+**volume** | Integer | The cumulative volume of this options contract that traded that day.  
+**ask** | Float | The price of the top ask order  
+**ask_size** | Integer | The size of the top ask order  
+**ask_timestamp** | DateTime | The timestamp of the top ask order  
+**bid** | Float | The price of the top bid order  
+**bid_size** | Integer | The size of the top bid order  
+**bid_timestamp** | DateTime | The time of the top bid order  
+**open_interest** | Integer | The total number of this options contract that are still open.  
+**exercise_style** | String | The exercise style of the option.  (\"A\" = \"American\", \"E\" = \"European\")  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionRealtime.md

@@ -0,0 +1,24 @@
+
+
+[//]: # (CLASS:Intrinio::OptionRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**code** | String | The Intrinio Code for the Option.  
+**ticker** | String | The ticker symbol of the Security for the Option.  
+**expiration** | Date | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
+**strike** | Float | The strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative’s underlying asset.  In a call option, the strike price is the price at which the option holder can purchase the underlying security.  For a put option, the strike price is the price at which the option holder can sell the underlying security.  
+**type** | String | The type of Option (put or call).  
+
+[//]: # (END_DEFINITION)
+
+
+