Class: Intrinio::CryptoSnapshot

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/models/crypto_snapshot.rb

Overview

A snapshot is a point in time look at the given Crypto Currency Pair on the given Crypto Currency Exchange. The snapshot includes information from the last 24 hours such as bid price, bid size, ask price, ask size, notional change in price, percent change in price, volume, open price, high price, low price, and details of the last trade (price, time, size, and side).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CryptoSnapshot

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 108

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?(:'last_updated')
    self.last_updated = attributes[:'last_updated']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#ask ⇒ Object

The ask for the Crypto Currency Pair on the exchange.



28
29
30
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 28

def ask
  @ask
end

#ask_size ⇒ Object

The size of the ask for the Crypto Currency Pair on the exchange.



31
32
33
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 31

def ask_size
  @ask_size
end

#bid ⇒ Object

The bid for the Crypto Currency Pair on the exchange.



22
23
24
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 22

def bid
  @bid
end

#bid_size ⇒ Object

The size of the bid for the Crypto Currency Pair on the exchange.



25
26
27
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 25

def bid_size
  @bid_size
end

#change ⇒ Object

The notional change in price over the last 24 hours.



34
35
36
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 34

def change
  @change
end

#change_percent ⇒ Object

The percent change in price over the last 24 hours.



37
38
39
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 37

def change_percent
  @change_percent
end

#high ⇒ Object

The highest price of the currency on the exchange for the last 24 hours.



46
47
48
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 46

def high
  @high
end

#last_trade_price ⇒ Object

The price of the last trade for the Crypto Currency Pair on the exchange.



58
59
60
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 58

def last_trade_price
  @last_trade_price
end

#last_trade_side ⇒ Object

The side of the last trade, either buy or sell.



52
53
54
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 52

def last_trade_side
  @last_trade_side
end

#last_trade_size ⇒ Object

The size of the last trade for the Crypto Currency Pair on the exchange.



61
62
63
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 61

def last_trade_size
  @last_trade_size
end

#last_trade_time ⇒ Object

UTC timestamp of the last trade for the Crypto Currency Pair on the exchange.



55
56
57
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 55

def last_trade_time
  @last_trade_time
end

#last_updated ⇒ Object

UTC timestamp of when the snapshot was last updated.



19
20
21
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 19

def last_updated
  @last_updated
end

#low ⇒ Object

The lowest price of the currency on the exchange for the last 24 hours.



49
50
51
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 49

def low
  @low
end

#open ⇒ Object

The opening price of the currency on the exchange.



43
44
45
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 43

def open
  @open
end

#volume ⇒ Object

The volume of the Crypto Currency Pair on the exchange.



40
41
42
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 40

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 65

def self.attribute_map
  {
    :'last_updated' => :'last_updated',
    :'bid' => :'bid',
    :'bid_size' => :'bid_size',
    :'ask' => :'ask',
    :'ask_size' => :'ask_size',
    :'change' => :'change',
    :'change_percent' => :'change_percent',
    :'volume' => :'volume',
    :'open' => :'open',
    :'high' => :'high',
    :'low' => :'low',
    :'last_trade_side' => :'last_trade_side',
    :'last_trade_time' => :'last_trade_time',
    :'last_trade_price' => :'last_trade_price',
    :'last_trade_size' => :'last_trade_size'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 86

def self.swagger_types
  {
    :'last_updated' => :'String',
    :'bid' => :'Float',
    :'bid_size' => :'Float',
    :'ask' => :'Float',
    :'ask_size' => :'Float',
    :'change' => :'Float',
    :'change_percent' => :'Float',
    :'volume' => :'Float',
    :'open' => :'Float',
    :'high' => :'Float',
    :'low' => :'Float',
    :'last_trade_side' => :'String',
    :'last_trade_time' => :'String',
    :'last_trade_price' => :'Float',
    :'last_trade_size' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      last_updated == o.last_updated &&
      bid == o.bid &&
      bid_size == o.bid_size &&
      ask == o.ask &&
      ask_size == o.ask_size &&
      change == o.change &&
      change_percent == o.change_percent &&
      volume == o.volume &&
      open == o.open &&
      high == o.high &&
      low == o.low &&
      last_trade_side == o.last_trade_side &&
      last_trade_time == o.last_trade_time &&
      last_trade_price == o.last_trade_price &&
      last_trade_size == o.last_trade_size
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 247

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 313

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 226

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


213
214
215
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 219

def hash
  [last_updated, bid, bid_size, ask, ask_size, change, change_percent, volume, open, high, low, last_trade_side, last_trade_time, last_trade_price, last_trade_size].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



178
179
180
181
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 178

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



293
294
295
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 293

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 299

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



287
288
289
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 287

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



185
186
187
 
# File 'lib/intrinio-sdk/models/crypto_snapshot.rb', line 185

def valid?
  return true
end