intrinio-sdk 2.1.0 → 2.2.0

data/docs/CryptoAsk.md

@@ -0,0 +1,9 @@
+# Intrinio::CryptoAsk
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | **Float** | The ask price of the book entry. | [optional] 
+**size** | **Float** | The size for the ask price of the book entry. | [optional] 
+
+

data/docs/CryptoBid.md

@@ -0,0 +1,9 @@
+# Intrinio::CryptoBid
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | **Float** | The bid price of the book entry. | [optional] 
+**size** | **Float** | The size for the bid price of the book entry. | [optional] 
+
+

data/docs/CryptoBookEntry.md

@@ -0,0 +1,9 @@
+# Intrinio::CryptoBookEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | **Float** | The price of the book entry. | [optional] 
+**size** | **Float** | The size for the price of the book entry. | [optional] 
+
+

data/docs/CryptoCurrency.md

@@ -0,0 +1,12 @@
+# Intrinio::CryptoCurrency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The common name of the crypto currency. | [optional] 
+**code** | **String** | A code representing the crypto currency. | [optional] 
+**symbol** | **String** | The symbol of the Crypto Currency. | [optional] 
+**first_price_date** | **String** | The earliest date that daily historical pricing is available for. | [optional] 
+**last_price_date** | **String** | The most recent date that daily historical pricing is available for. | [optional] 
+
+

data/docs/CryptoExchange.md

@@ -0,0 +1,13 @@
+# Intrinio::CryptoExchange
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The Crypto Exchange name. | [optional] 
+**code** | **String** | The Crypto Exchange code. | [optional] 
+**book_depth_available** | **BOOLEAN** | A boolean, representing whether book depth data is provided by this exchange or not. | [optional] 
+**history_available** | **BOOLEAN** | A boolean, representing whether historical data is provided by this exchange or not. | [optional] 
+**snapshot_available** | **BOOLEAN** | A boolean, representing whether snpashot data is provided by this exchange or not. | [optional] 
+**trades_available** | **BOOLEAN** | A boolean, representing whether trade data is provided by this exchange or not. | [optional] 
+
+

data/docs/CryptoExchangeSummary.md

@@ -0,0 +1,9 @@
+# Intrinio::CryptoExchangeSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The Crypto Exchange name. | [optional] 
+**code** | **String** | The Crypto Exchange code. | [optional] 
+
+

data/docs/CryptoPair.md

@@ -0,0 +1,15 @@
+# Intrinio::CryptoPair
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The Crypto Currency Pair name. | [optional] 
+**code** | **String** | The Crypto Currency Pair code. | [optional] 
+**first_price_date** | **String** | The earliest date that daily historical pricing is available for. | [optional] 
+**last_price_date** | **String** | The most recent date that daily historical pricing is available for. | [optional] 
+**book_depth_available** | **BOOLEAN** | A boolean, representing whether this pair has book depth data available or not. | [optional] 
+**history_available** | **BOOLEAN** | A boolean, representing whether this pair has historical price data available or not. | [optional] 
+**snapshot_available** | **BOOLEAN** | A boolean, representing whether this pair has snapshot data available or not. | [optional] 
+**trades_available** | **BOOLEAN** | A boolean, representing whether this pair has trade data available or not. | [optional] 
+
+

data/docs/CryptoPairSummary.md

@@ -0,0 +1,9 @@
+# Intrinio::CryptoPairSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The Crypto Currency Pair name. | [optional] 
+**code** | **String** | The Crypto Currency Pair code. | [optional] 
+
+

data/docs/CryptoPrice.md

@@ -0,0 +1,13 @@
+# Intrinio::CryptoPrice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time** | **String** | The date and time of the beginning of the timeframe (in UTC). The open prices would be at this time, while close prices would be at this time plus the timeframe. | [optional] 
+**open** | **Float** | The opening price of the timeframe. | [optional] 
+**high** | **Float** | The high price of the timeframe. | [optional] 
+**low** | **Float** | The low price of the timeframe. | [optional] 
+**close** | **Float** | The closing price of the timeframe. | [optional] 
+**volume** | **Float** | The volume during the timeframe. | [optional] 
+
+

data/docs/CryptoSnapshot.md

@@ -0,0 +1,22 @@
+# Intrinio::CryptoSnapshot
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_updated** | **String** | UTC timestamp of when the snapshot was last updated. | [optional] 
+**bid** | **Float** | The bid for the Crypto Currency Pair on the exchange. | [optional] 
+**bid_size** | **Float** | The size of the bid for the Crypto Currency Pair on the exchange. | [optional] 
+**ask** | **Float** | The ask for the Crypto Currency Pair on the exchange. | [optional] 
+**ask_size** | **Float** | The size of the ask for the Crypto Currency Pair on the exchange. | [optional] 
+**change** | **Float** | The notional change in price over the last 24 hours. | [optional] 
+**change_percent** | **Float** | The percent change in price over the last 24 hours. | [optional] 
+**volume** | **Float** | The volume of the Crypto Currency Pair on the exchange. | [optional] 
+**open** | **Float** | The opening price of the currency on the exchange. | [optional] 
+**high** | **Float** | The highest price of the currency on the exchange for the last 24 hours. | [optional] 
+**low** | **Float** | The lowest price of the currency on the exchange for the last 24 hours. | [optional] 
+**last_trade_side** | **String** | The side of the last trade, either buy or sell. | [optional] 
+**last_trade_time** | **String** | UTC timestamp of the last trade for the Crypto Currency Pair on the exchange. | [optional] 
+**last_trade_price** | **Float** | The price of the last trade for the Crypto Currency Pair on the exchange. | [optional] 
+**last_trade_size** | **Float** | The size of the last trade for the Crypto Currency Pair on the exchange. | [optional] 
+
+

data/docs/CryptoStat.md

@@ -0,0 +1,15 @@
+# Intrinio::CryptoStat
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The common name of the crypto currency. | [optional] 
+**code** | **String** | A code representing the crypto currency. | [optional] 
+**symbol** | **String** | The symbol of the Crypto Currency. | [optional] 
+**market_cap_usd** | **Float** | The market cap of the Crypto Currency in USD. | [optional] 
+**available_supply** | **Float** | The available supply of the Crypto Currency. | [optional] 
+**total_supply** | **Float** | The total supply of the Crypto Currency. | [optional] 
+**max_supply** | **Float** | The maxmium supply of coins available to mine. | [optional] 
+**last_updated** | **String** | UTC timestamp of when the data was last updated. | [optional] 
+
+

data/docs/DataPointApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 Data Point (Number)
 
-Returns a numeric value for the given `tag` and the entity with the given `identifier`
+$$v2_data_point_number_description$$
 
 ### Example
 ```ruby
@@ -27,9 +27,9 @@ end
 
 dataPoint_api = Intrinio::DataPointApi.new
 
-identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
+identifier = "$$v2_data_point_identifier_default$$" # String | $$v2_data_point_identifier_description$$
 
-tag = "marketcap" # String | An Intrinio data tag ID or code-name
+tag = "$$v2_data_point_item_number_default$$" # String | $$v2_data_point_item_description$$
 
 
 begin
@@ -44,8 +44,8 @@ end
 
 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 | 
+ **identifier** | **String**| $$v2_data_point_identifier_description$$ | 
+ **tag** | **String**| $$v2_data_point_item_description$$ | 
 
 ### Return type
 
@@ -56,7 +56,7 @@ Name | Type | Description  | Notes
 
 Data Point (Text)
 
-Returns a text value for the given `tag` and the entity with the given `identifier`
+$$v2_data_point_text_description$$
 
 ### Example
 ```ruby
@@ -70,9 +70,9 @@ end
 
 dataPoint_api = Intrinio::DataPointApi.new
 
-identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
+identifier = "$$v2_data_point_identifier_default$$" # String | $$v2_data_point_identifier_description$$
 
-tag = "marketcap" # String | An Intrinio data tag ID or code-name
+tag = "$$v2_data_point_item_text_default$$" # String | $$v2_data_point_item_description$$
 
 
 begin
@@ -87,8 +87,8 @@ end
 
 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 | 
+ **identifier** | **String**| $$v2_data_point_identifier_description$$ | 
+ **tag** | **String**| $$v2_data_point_item_description$$ | 
 
 ### Return type
 

data/docs/DetrendedPriceOscillatorTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::DetrendedPriceOscillatorTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**dpo** | **Float** | The Detrended Price Oscillator calculation value | [optional] 
+
+

data/docs/DonchianChannelTechnicalValue.md

@@ -0,0 +1,10 @@
+# Intrinio::DonchianChannelTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**lower_bound** | **Float** | The lower bound value of the Donchian Channel calculation | [optional] 
+**upper_bound** | **Float** | The upper bound value of the Donchian Channel calculation | [optional] 
+
+

data/docs/EaseOfMovementTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::EaseOfMovementTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**eom** | **Float** | The Ease of Movement calculation value | [optional] 
+
+

data/docs/ForceIndexTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::ForceIndexTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**fi** | **Float** | The Force Index calculation value | [optional] 
+
+

data/docs/FundamentalsApi.md

@@ -69,7 +69,7 @@ end
 
 fundamentals_api = Intrinio::FundamentalsApi.new
 
-id = "fun_ge9LlE" # String | The Intrinio ID for the Fundamental
+id = "AAPL-income_statement-2018-Q1" # String | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
 
 
 begin
@@ -84,7 +84,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| The Intrinio ID for the Fundamental | 
+ **id** | **String**| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | 
 
 ### Return type
 
@@ -109,7 +109,7 @@ end
 
 fundamentals_api = Intrinio::FundamentalsApi.new
 
-id = "fun_ge9LlE" # String | The Intrinio ID for the Fundamental
+id = "AAPL-income_statement-2018-Q1" # String | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
 
 
 begin
@@ -124,7 +124,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| The Intrinio ID for the Fundamental | 
+ **id** | **String**| The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | 
 
 ### Return type
 

data/docs/HistoricalDataApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 Historical Data
 
-Returns historical values for the given `tag` and the entity represented by the given `identifier`
+$$v2_historical_data_description$$
 
 ### Example
 ```ruby
@@ -26,11 +26,12 @@ 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)
+identifier = "$$v2_historical_data_identifier_default$$" # String | $$v2_historical_data_identifier_description$$
 
-tag = "marketcap" # String | An Intrinio data tag ID or code-name
+tag = "$$v2_historical_data_item_default$$" # String | $$v2_historical_data_item_description$$
 
 opts = { 
+  frequency: "daily", # String | Return historical data in the given frequency
   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
@@ -51,8 +52,9 @@ end
 
 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 | 
+ **identifier** | **String**| $$v2_historical_data_identifier_description$$ | 
+ **tag** | **String**| $$v2_historical_data_item_description$$ | 
+ **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] 

data/docs/IchimokuKinkoHyoTechnicalValue.md

@@ -0,0 +1,13 @@
+# Intrinio::IchimokuKinkoHyoTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**chikou_span** | **Float** | The Chikou Span (Lagging Span) value of the Ichimoku Kinko Hyo calculation | [optional] 
+**kijun_sen** | **Float** | The Kijun-sen (Base Line) value of the Ichimoku Kinko Hyo calculation | [optional] 
+**senkou_span_a** | **Float** | The Senkou Span A (Leading Span A) value of the Ichimoku Kinko Hyo calculation | [optional] 
+**senkou_span_b** | **Float** | The Senkou Span B (Leading Span B) value of the Ichimoku Kinko Hyo calculation | [optional] 
+**tenkan_sen** | **Float** | The Tenskan-sen (Conversion Line) value of the Ichimoku Kinko Hyo calculation | [optional] 
+
+

data/docs/KeltnerChannelTechnicalValue.md

@@ -0,0 +1,11 @@
+# Intrinio::KeltnerChannelTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**lower_band** | **Float** | The lower band value of the Keltner Channel calculation | [optional] 
+**middle_band** | **Float** | The middle band value of the Keltner Channel calculation | [optional] 
+**upper_band** | **Float** | The upper band value of the Keltner Channel calculation | [optional] 
+
+

data/docs/KnowSureThingTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::KnowSureThingTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**kst** | **Float** | The Know Sure Thing calculation value | [optional] 
+
+

data/docs/MassIndexTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::MassIndexTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**mi** | **Float** | The Mass Index calculation value | [optional] 
+
+

data/docs/MoneyFlowIndexTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::MoneyFlowIndexTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**mfi** | **Float** | The Money Flow Index calculation value | [optional] 
+
+

data/docs/MovingAverageConvergenceDivergenceTechnicalValue.md

@@ -0,0 +1,11 @@
+# Intrinio::MovingAverageConvergenceDivergenceTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**macd_histogram** | **Float** | The histogram value of the Moving Average Convergence Divergence calculation | [optional] 
+**macd_line** | **Float** | The line value of the Moving Average Convergence Divergence calculation | [optional] 
+**signal_line** | **Float** | The signal line value of the Moving Average Convergence Divergence calculation | [optional] 
+
+

data/docs/NegativeVolumeIndexTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::NegativeVolumeIndexTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**nvi** | **Float** | The Negative Volume Index calculation value | [optional] 
+
+

data/docs/OnBalanceVolumeMeanTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::OnBalanceVolumeMeanTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**obv_mean** | **Float** | The On-balance Volume Mean calculation value | [optional] 
+
+

data/docs/OnBalanceVolumeTechnicalValue.md

@@ -0,0 +1,9 @@
+# Intrinio::OnBalanceVolumeTechnicalValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **DateTime** | The date_time of the observation | [optional] 
+**obv** | **Float** | The On-balance Volume calculation value | [optional] 
+
+

data/docs/Option.md

@@ -0,0 +1,13 @@
+# Intrinio::Option
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID for the Option. | [optional] 
+**code** | **String** | The Intrinio Code for the Option. | [optional] 
+**ticker** | **String** | The ticker symbol of the Security for the Option. | [optional] 
+**expiration** | **String** | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised. | [optional] 
+**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. | [optional] 
+**type** | **String** | The type of Option (put or call). A put option is an option contract giving the owner the right, but not the obligation, to sell a specified amount of an underlying asset at a specified price before the option's expiration date. A call option gives the holder the right to buy an underlying asset at a specified price, before the option's expiration date. | [optional] 
+
+