class Intrinio::ETFStats

Daily stats for the Exchange Traded Fund (ETF) including net asset value, beta vs spy, returns, and volatility

Attributes

beta_vs_spy[RW]

Volatility this ETF is versus the SPY ETF

calendar_year_1_return_split_and_dividend[RW]

One year ago calendar year return including dividends

calendar_year_1_return_split_only[RW]

One year ago calendar year return excluding dividends

calendar_year_2_return_split_and_dividend[RW]

Two years ago calendar year return including dividends

calendar_year_2_return_split_only[RW]

Two years ago calendar year return excluding dividends

calendar_year_3_return_split_and_dividend[RW]

Three years ago calendar year return including dividends

calendar_year_3_return_split_only[RW]

Three years ago calendar year return excluding dividends

calendar_year_4_return_split_and_dividend[RW]

Four years ago calendar year return including dividends

calendar_year_4_return_split_only[RW]

Four years ago calendar year return excluding dividends

calendar_year_5_return_split_and_dividend[RW]

Five years ago calendar year return including dividends

calendar_year_5_return_split_only[RW]

Five years ago calendar year return excluding dividends

calendar_year_to_date_return_split_and_dividend[RW]

Calendar year to date (YTD) return including dividends

calendar_year_to_date_return_split_only[RW]

Calendar year to date (YTD) return excluding dividends

date[RW]
etf[RW]
inception_annualized_return_split_and_dividend[RW]

Annualized return including dividends since inception

inception_annualized_return_split_only[RW]

Annualized return excluding dividends since inception

net_asset_value[RW]

The net asset value (NAV = Total Assets - Total Liabilities)

trailing_five_year_annualized_return_split_and_dividend[RW]

Trailing five year return including dividends

trailing_five_year_annualized_return_split_only[RW]

Trailing five year return excluding dividends

trailing_five_year_volatility_annualized[RW]

Annualized standard deviation of daily price returns over trailing 1260 trading days

trailing_one_month_return_split_and_dividend[RW]

Trailing one month return including dividends

trailing_one_month_return_split_only[RW]

Trailing one month return excluding dividends

trailing_one_year_return_split_and_dividend[RW]

Trailing one year return including dividends

trailing_one_year_return_split_only[RW]

Trailing one year return excluding dividends

trailing_one_year_volatility_annualized[RW]

Annualized standard deviation of daily price returns over trailing 252 trading days

trailing_ten_year_annualized_return_split_and_dividend[RW]

Trailing ten year return including dividends

trailing_ten_year_annualized_return_split_only[RW]

Trailing ten year return excluding dividends

trailing_three_year_annualized_return_split_and_dividend[RW]

Trailing three year return including dividends

trailing_three_year_annualized_return_split_only[RW]

Trailing three year return excluding dividends

trailing_three_year_volatility_annualized[RW]

Annualized standard deviation of daily price returns over trailing 756 trading days

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/intrinio-sdk/models/etf_stats.rb, line 111
def self.attribute_map
  {
    :'date' => :'date',
    :'net_asset_value' => :'net_asset_value',
    :'beta_vs_spy' => :'beta_vs_spy',
    :'trailing_one_month_return_split_and_dividend' => :'trailing_one_month_return_split_and_dividend',
    :'trailing_one_month_return_split_only' => :'trailing_one_month_return_split_only',
    :'trailing_one_year_return_split_and_dividend' => :'trailing_one_year_return_split_and_dividend',
    :'trailing_one_year_return_split_only' => :'trailing_one_year_return_split_only',
    :'trailing_one_year_volatility_annualized' => :'trailing_one_year_volatility_annualized',
    :'trailing_three_year_annualized_return_split_and_dividend' => :'trailing_three_year_annualized_return_split_and_dividend',
    :'trailing_three_year_annualized_return_split_only' => :'trailing_three_year_annualized_return_split_only',
    :'trailing_three_year_volatility_annualized' => :'trailing_three_year_volatility_annualized',
    :'trailing_five_year_annualized_return_split_and_dividend' => :'trailing_five_year_annualized_return_split_and_dividend',
    :'trailing_five_year_annualized_return_split_only' => :'trailing_five_year_annualized_return_split_only',
    :'trailing_five_year_volatility_annualized' => :'trailing_five_year_volatility_annualized',
    :'trailing_ten_year_annualized_return_split_and_dividend' => :'trailing_ten_year_annualized_return_split_and_dividend',
    :'trailing_ten_year_annualized_return_split_only' => :'trailing_ten_year_annualized_return_split_only',
    :'inception_annualized_return_split_and_dividend' => :'inception_annualized_return_split_and_dividend',
    :'inception_annualized_return_split_only' => :'inception_annualized_return_split_only',
    :'calendar_year_5_return_split_and_dividend' => :'calendar_year_5_return_split_and_dividend',
    :'calendar_year_5_return_split_only' => :'calendar_year_5_return_split_only',
    :'calendar_year_4_return_split_and_dividend' => :'calendar_year_4_return_split_and_dividend',
    :'calendar_year_4_return_split_only' => :'calendar_year_4_return_split_only',
    :'calendar_year_3_return_split_and_dividend' => :'calendar_year_3_return_split_and_dividend',
    :'calendar_year_3_return_split_only' => :'calendar_year_3_return_split_only',
    :'calendar_year_2_return_split_and_dividend' => :'calendar_year_2_return_split_and_dividend',
    :'calendar_year_2_return_split_only' => :'calendar_year_2_return_split_only',
    :'calendar_year_1_return_split_and_dividend' => :'calendar_year_1_return_split_and_dividend',
    :'calendar_year_1_return_split_only' => :'calendar_year_1_return_split_only',
    :'calendar_year_to_date_return_split_and_dividend' => :'calendar_year_to_date_return_split_and_dividend',
    :'calendar_year_to_date_return_split_only' => :'calendar_year_to_date_return_split_only',
    :'etf' => :'etf'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/intrinio-sdk/models/etf_stats.rb, line 186
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.has_key?(:'net_asset_value')
    self.net_asset_value = attributes[:'net_asset_value']
  end

  if attributes.has_key?(:'beta_vs_spy')
    self.beta_vs_spy = attributes[:'beta_vs_spy']
  end

  if attributes.has_key?(:'trailing_one_month_return_split_and_dividend')
    self.trailing_one_month_return_split_and_dividend = attributes[:'trailing_one_month_return_split_and_dividend']
  end

  if attributes.has_key?(:'trailing_one_month_return_split_only')
    self.trailing_one_month_return_split_only = attributes[:'trailing_one_month_return_split_only']
  end

  if attributes.has_key?(:'trailing_one_year_return_split_and_dividend')
    self.trailing_one_year_return_split_and_dividend = attributes[:'trailing_one_year_return_split_and_dividend']
  end

  if attributes.has_key?(:'trailing_one_year_return_split_only')
    self.trailing_one_year_return_split_only = attributes[:'trailing_one_year_return_split_only']
  end

  if attributes.has_key?(:'trailing_one_year_volatility_annualized')
    self.trailing_one_year_volatility_annualized = attributes[:'trailing_one_year_volatility_annualized']
  end

  if attributes.has_key?(:'trailing_three_year_annualized_return_split_and_dividend')
    self.trailing_three_year_annualized_return_split_and_dividend = attributes[:'trailing_three_year_annualized_return_split_and_dividend']
  end

  if attributes.has_key?(:'trailing_three_year_annualized_return_split_only')
    self.trailing_three_year_annualized_return_split_only = attributes[:'trailing_three_year_annualized_return_split_only']
  end

  if attributes.has_key?(:'trailing_three_year_volatility_annualized')
    self.trailing_three_year_volatility_annualized = attributes[:'trailing_three_year_volatility_annualized']
  end

  if attributes.has_key?(:'trailing_five_year_annualized_return_split_and_dividend')
    self.trailing_five_year_annualized_return_split_and_dividend = attributes[:'trailing_five_year_annualized_return_split_and_dividend']
  end

  if attributes.has_key?(:'trailing_five_year_annualized_return_split_only')
    self.trailing_five_year_annualized_return_split_only = attributes[:'trailing_five_year_annualized_return_split_only']
  end

  if attributes.has_key?(:'trailing_five_year_volatility_annualized')
    self.trailing_five_year_volatility_annualized = attributes[:'trailing_five_year_volatility_annualized']
  end

  if attributes.has_key?(:'trailing_ten_year_annualized_return_split_and_dividend')
    self.trailing_ten_year_annualized_return_split_and_dividend = attributes[:'trailing_ten_year_annualized_return_split_and_dividend']
  end

  if attributes.has_key?(:'trailing_ten_year_annualized_return_split_only')
    self.trailing_ten_year_annualized_return_split_only = attributes[:'trailing_ten_year_annualized_return_split_only']
  end

  if attributes.has_key?(:'inception_annualized_return_split_and_dividend')
    self.inception_annualized_return_split_and_dividend = attributes[:'inception_annualized_return_split_and_dividend']
  end

  if attributes.has_key?(:'inception_annualized_return_split_only')
    self.inception_annualized_return_split_only = attributes[:'inception_annualized_return_split_only']
  end

  if attributes.has_key?(:'calendar_year_5_return_split_and_dividend')
    self.calendar_year_5_return_split_and_dividend = attributes[:'calendar_year_5_return_split_and_dividend']
  end

  if attributes.has_key?(:'calendar_year_5_return_split_only')
    self.calendar_year_5_return_split_only = attributes[:'calendar_year_5_return_split_only']
  end

  if attributes.has_key?(:'calendar_year_4_return_split_and_dividend')
    self.calendar_year_4_return_split_and_dividend = attributes[:'calendar_year_4_return_split_and_dividend']
  end

  if attributes.has_key?(:'calendar_year_4_return_split_only')
    self.calendar_year_4_return_split_only = attributes[:'calendar_year_4_return_split_only']
  end

  if attributes.has_key?(:'calendar_year_3_return_split_and_dividend')
    self.calendar_year_3_return_split_and_dividend = attributes[:'calendar_year_3_return_split_and_dividend']
  end

  if attributes.has_key?(:'calendar_year_3_return_split_only')
    self.calendar_year_3_return_split_only = attributes[:'calendar_year_3_return_split_only']
  end

  if attributes.has_key?(:'calendar_year_2_return_split_and_dividend')
    self.calendar_year_2_return_split_and_dividend = attributes[:'calendar_year_2_return_split_and_dividend']
  end

  if attributes.has_key?(:'calendar_year_2_return_split_only')
    self.calendar_year_2_return_split_only = attributes[:'calendar_year_2_return_split_only']
  end

  if attributes.has_key?(:'calendar_year_1_return_split_and_dividend')
    self.calendar_year_1_return_split_and_dividend = attributes[:'calendar_year_1_return_split_and_dividend']
  end

  if attributes.has_key?(:'calendar_year_1_return_split_only')
    self.calendar_year_1_return_split_only = attributes[:'calendar_year_1_return_split_only']
  end

  if attributes.has_key?(:'calendar_year_to_date_return_split_and_dividend')
    self.calendar_year_to_date_return_split_and_dividend = attributes[:'calendar_year_to_date_return_split_and_dividend']
  end

  if attributes.has_key?(:'calendar_year_to_date_return_split_only')
    self.calendar_year_to_date_return_split_only = attributes[:'calendar_year_to_date_return_split_only']
  end

  if attributes.has_key?(:'etf')
    self.etf = attributes[:'etf']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/intrinio-sdk/models/etf_stats.rb, line 148
def self.swagger_types
  {
    :'date' => :'Date',
    :'net_asset_value' => :'Float',
    :'beta_vs_spy' => :'Float',
    :'trailing_one_month_return_split_and_dividend' => :'Float',
    :'trailing_one_month_return_split_only' => :'Float',
    :'trailing_one_year_return_split_and_dividend' => :'Float',
    :'trailing_one_year_return_split_only' => :'Float',
    :'trailing_one_year_volatility_annualized' => :'Float',
    :'trailing_three_year_annualized_return_split_and_dividend' => :'Float',
    :'trailing_three_year_annualized_return_split_only' => :'Float',
    :'trailing_three_year_volatility_annualized' => :'Float',
    :'trailing_five_year_annualized_return_split_and_dividend' => :'Float',
    :'trailing_five_year_annualized_return_split_only' => :'Float',
    :'trailing_five_year_volatility_annualized' => :'Float',
    :'trailing_ten_year_annualized_return_split_and_dividend' => :'Float',
    :'trailing_ten_year_annualized_return_split_only' => :'Float',
    :'inception_annualized_return_split_and_dividend' => :'Float',
    :'inception_annualized_return_split_only' => :'Float',
    :'calendar_year_5_return_split_and_dividend' => :'Float',
    :'calendar_year_5_return_split_only' => :'Float',
    :'calendar_year_4_return_split_and_dividend' => :'Float',
    :'calendar_year_4_return_split_only' => :'Float',
    :'calendar_year_3_return_split_and_dividend' => :'Float',
    :'calendar_year_3_return_split_only' => :'Float',
    :'calendar_year_2_return_split_and_dividend' => :'Float',
    :'calendar_year_2_return_split_only' => :'Float',
    :'calendar_year_1_return_split_and_dividend' => :'Float',
    :'calendar_year_1_return_split_only' => :'Float',
    :'calendar_year_to_date_return_split_and_dividend' => :'Float',
    :'calendar_year_to_date_return_split_only' => :'Float',
    :'etf' => :'ETFSummary'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/intrinio-sdk/models/etf_stats.rb, line 333
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      net_asset_value == o.net_asset_value &&
      beta_vs_spy == o.beta_vs_spy &&
      trailing_one_month_return_split_and_dividend == o.trailing_one_month_return_split_and_dividend &&
      trailing_one_month_return_split_only == o.trailing_one_month_return_split_only &&
      trailing_one_year_return_split_and_dividend == o.trailing_one_year_return_split_and_dividend &&
      trailing_one_year_return_split_only == o.trailing_one_year_return_split_only &&
      trailing_one_year_volatility_annualized == o.trailing_one_year_volatility_annualized &&
      trailing_three_year_annualized_return_split_and_dividend == o.trailing_three_year_annualized_return_split_and_dividend &&
      trailing_three_year_annualized_return_split_only == o.trailing_three_year_annualized_return_split_only &&
      trailing_three_year_volatility_annualized == o.trailing_three_year_volatility_annualized &&
      trailing_five_year_annualized_return_split_and_dividend == o.trailing_five_year_annualized_return_split_and_dividend &&
      trailing_five_year_annualized_return_split_only == o.trailing_five_year_annualized_return_split_only &&
      trailing_five_year_volatility_annualized == o.trailing_five_year_volatility_annualized &&
      trailing_ten_year_annualized_return_split_and_dividend == o.trailing_ten_year_annualized_return_split_and_dividend &&
      trailing_ten_year_annualized_return_split_only == o.trailing_ten_year_annualized_return_split_only &&
      inception_annualized_return_split_and_dividend == o.inception_annualized_return_split_and_dividend &&
      inception_annualized_return_split_only == o.inception_annualized_return_split_only &&
      calendar_year_5_return_split_and_dividend == o.calendar_year_5_return_split_and_dividend &&
      calendar_year_5_return_split_only == o.calendar_year_5_return_split_only &&
      calendar_year_4_return_split_and_dividend == o.calendar_year_4_return_split_and_dividend &&
      calendar_year_4_return_split_only == o.calendar_year_4_return_split_only &&
      calendar_year_3_return_split_and_dividend == o.calendar_year_3_return_split_and_dividend &&
      calendar_year_3_return_split_only == o.calendar_year_3_return_split_only &&
      calendar_year_2_return_split_and_dividend == o.calendar_year_2_return_split_and_dividend &&
      calendar_year_2_return_split_only == o.calendar_year_2_return_split_only &&
      calendar_year_1_return_split_and_dividend == o.calendar_year_1_return_split_and_dividend &&
      calendar_year_1_return_split_only == o.calendar_year_1_return_split_only &&
      calendar_year_to_date_return_split_and_dividend == o.calendar_year_to_date_return_split_and_dividend &&
      calendar_year_to_date_return_split_only == o.calendar_year_to_date_return_split_only &&
      etf == o.etf
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/intrinio-sdk/models/etf_stats.rb, line 405
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Intrinio.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/intrinio-sdk/models/etf_stats.rb, line 471
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/intrinio-sdk/models/etf_stats.rb, line 384
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/intrinio-sdk/models/etf_stats.rb, line 371
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/intrinio-sdk/models/etf_stats.rb, line 377
def hash
  [date, net_asset_value, beta_vs_spy, trailing_one_month_return_split_and_dividend, trailing_one_month_return_split_only, trailing_one_year_return_split_and_dividend, trailing_one_year_return_split_only, trailing_one_year_volatility_annualized, trailing_three_year_annualized_return_split_and_dividend, trailing_three_year_annualized_return_split_only, trailing_three_year_volatility_annualized, trailing_five_year_annualized_return_split_and_dividend, trailing_five_year_annualized_return_split_only, trailing_five_year_volatility_annualized, trailing_ten_year_annualized_return_split_and_dividend, trailing_ten_year_annualized_return_split_only, inception_annualized_return_split_and_dividend, inception_annualized_return_split_only, calendar_year_5_return_split_and_dividend, calendar_year_5_return_split_only, calendar_year_4_return_split_and_dividend, calendar_year_4_return_split_only, calendar_year_3_return_split_and_dividend, calendar_year_3_return_split_only, calendar_year_2_return_split_and_dividend, calendar_year_2_return_split_only, calendar_year_1_return_split_and_dividend, calendar_year_1_return_split_only, calendar_year_to_date_return_split_and_dividend, calendar_year_to_date_return_split_only, etf].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/intrinio-sdk/models/etf_stats.rb, line 320
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/intrinio-sdk/models/etf_stats.rb, line 451
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/intrinio-sdk/models/etf_stats.rb, line 457
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/intrinio-sdk/models/etf_stats.rb, line 445
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/intrinio-sdk/models/etf_stats.rb, line 327
def valid?
  return true
end