class Intrinio::ETFAnalytics

Provides analytics for the Exchange Traded Fund (ETF) including volume, market cap, 52 week high, and 52 week low

Attributes

average_daily_volume_one_month[RW]

The average quantity of shares traded per day for the last month

average_daily_volume_six_month[RW]

The average quantity of shares traded per day for the last six months

average_daily_volume_three_month[RW]

The average quantity of shares traded per day for the last three months

etf[RW]
fifty_two_week_high[RW]

Highest trading price for the security in the preceding 52 weeks

fifty_two_week_low[RW]

Lowest trading price for the security in the preceding 52 weeks

market_cap[RW]

The market capitalization for the Exchange Traded Fund (ETF)

shares_outstanding[RW]

The number of shares outstanding for the Exchange Traded Fund (ETF)

volume_traded[RW]

The total quantity of shares traded on the latest trading day

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_analytics.rb, line 46
def self.attribute_map
  {
    :'fifty_two_week_high' => :'fifty_two_week_high',
    :'fifty_two_week_low' => :'fifty_two_week_low',
    :'volume_traded' => :'volume_traded',
    :'average_daily_volume_one_month' => :'average_daily_volume_one_month',
    :'average_daily_volume_three_month' => :'average_daily_volume_three_month',
    :'average_daily_volume_six_month' => :'average_daily_volume_six_month',
    :'market_cap' => :'market_cap',
    :'shares_outstanding' => :'shares_outstanding',
    :'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_analytics.rb, line 77
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?(:'fifty_two_week_high')
    self.fifty_two_week_high = attributes[:'fifty_two_week_high']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'shares_outstanding')
    self.shares_outstanding = attributes[:'shares_outstanding']
  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_analytics.rb, line 61
def self.swagger_types
  {
    :'fifty_two_week_high' => :'Float',
    :'fifty_two_week_low' => :'Float',
    :'volume_traded' => :'Float',
    :'average_daily_volume_one_month' => :'Float',
    :'average_daily_volume_three_month' => :'Float',
    :'average_daily_volume_six_month' => :'Float',
    :'market_cap' => :'Float',
    :'shares_outstanding' => :'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_analytics.rb, line 136
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      fifty_two_week_high == o.fifty_two_week_high &&
      fifty_two_week_low == o.fifty_two_week_low &&
      volume_traded == o.volume_traded &&
      average_daily_volume_one_month == o.average_daily_volume_one_month &&
      average_daily_volume_three_month == o.average_daily_volume_three_month &&
      average_daily_volume_six_month == o.average_daily_volume_six_month &&
      market_cap == o.market_cap &&
      shares_outstanding == o.shares_outstanding &&
      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_analytics.rb, line 186
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_analytics.rb, line 252
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_analytics.rb, line 165
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_analytics.rb, line 152
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_analytics.rb, line 158
def hash
  [fifty_two_week_high, fifty_two_week_low, volume_traded, average_daily_volume_one_month, average_daily_volume_three_month, average_daily_volume_six_month, market_cap, shares_outstanding, 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_analytics.rb, line 123
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_analytics.rb, line 232
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_analytics.rb, line 238
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_analytics.rb, line 226
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_analytics.rb, line 130
def valid?
  return true
end