Class: Intrinio::OptionPriceEod

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

Overview

An option price contains price information for a specific options contract.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OptionPriceEod

Initializes the object

Parameters:

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

    Model attributes in the form of hash



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
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
284
285
286
287
288
289
290
291
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 173

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#ask_high ⇒ Object

The highest ask over the span of the period



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

def ask_high
  @ask_high
end

#ask_low ⇒ Object

The lowest ask over the span of the period



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

def ask_low
  @ask_low
end

#bid_high ⇒ Object

The highest bid over the span of the period



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

def bid_high
  @bid_high
end

#bid_low ⇒ Object

The lowest bid over the span of the period



64
65
66
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 64

def bid_low
  @bid_low
end

#close ⇒ Object

The closing price of the options contract.



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

def close
  @close
end

#close_ask ⇒ Object

The closing ask price of the options contract.



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

def close_ask
  @close_ask
end

#close_ask_size ⇒ Object

The size of the last ask before close.



97
98
99
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 97

def close_ask_size
  @close_ask_size
end

#close_ask_time ⇒ Object

The time of the last ask before close.



94
95
96
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 94

def close_ask_time
  @close_ask_time
end

#close_bid ⇒ Object

The closing bid price of the options contract.



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

def close_bid
  @close_bid
end

#close_bid_size ⇒ Object

The size of the last bid before close.



91
92
93
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 91

def close_bid_size
  @close_bid_size
end

#close_bid_time ⇒ Object

The time of the last bid before close.



88
89
90
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 88

def close_bid_time
  @close_bid_time
end

#close_size ⇒ Object

The size of the last trade before close.



85
86
87
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 85

def close_size
  @close_size
end

#close_time ⇒ Object

The time of the last trade before close.



82
83
84
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 82

def close_time
  @close_time
end

#date ⇒ Object

The date of the price, in the format YYYY-MM-DD



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

def date
  @date
end

#delta ⇒ Object

Delta represents the rate of change between the option’s price and a $1 change in the underlying asset’s price.



70
71
72
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 70

def delta
  @delta
end

#exercise_style ⇒ Object

The exercise style.



100
101
102
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 100

def exercise_style
  @exercise_style
end

#gamma ⇒ Object

Gamma represents the rate of change between an option’s delta and the underlying asset’s price.



73
74
75
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 73

def gamma
  @gamma
end

#high ⇒ Object

The highest price over the span of the period



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

def high
  @high
end

#implied_volatility ⇒ Object

The implied volatility of the contract calculated using the Black-Scholes Model.



67
68
69
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 67

def implied_volatility
  @implied_volatility
end

#low ⇒ Object

The highest price over the span of the period



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

def low
  @low
end

#mark ⇒ Object

The mid price between the latest bid and ask spread



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

def mark
  @mark
end

#open ⇒ Object

The price at the beginning of the period



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

def open
  @open
end

#open_ask ⇒ Object

The ask at the beginning of the period



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

def open_ask
  @open_ask
end

#open_bid ⇒ Object

The bid at the beginning of the period



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

def open_bid
  @open_bid
end

#open_interest ⇒ Object

The total number of this options contract that are still open.



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

def open_interest
  @open_interest
end

#theta ⇒ Object

Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option’s time decay.



76
77
78
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 76

def theta
  @theta
end

#vega ⇒ Object

Vega represents the rate of change between an option’s value and the underlying asset’s implied volatility.



79
80
81
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 79

def vega
  @vega
end

#volume ⇒ Object

The cumulative volume of this options contract that traded that day.



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

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
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
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 104

def self.attribute_map
  {
    :'date' => :'date',
    :'close' => :'close',
    :'close_bid' => :'close_bid',
    :'close_ask' => :'close_ask',
    :'volume' => :'volume',
    :'open' => :'open',
    :'open_ask' => :'open_ask',
    :'open_bid' => :'open_bid',
    :'open_interest' => :'open_interest',
    :'high' => :'high',
    :'low' => :'low',
    :'mark' => :'mark',
    :'ask_high' => :'ask_high',
    :'ask_low' => :'ask_low',
    :'bid_high' => :'bid_high',
    :'bid_low' => :'bid_low',
    :'implied_volatility' => :'implied_volatility',
    :'delta' => :'delta',
    :'gamma' => :'gamma',
    :'theta' => :'theta',
    :'vega' => :'vega',
    :'close_time' => :'close_time',
    :'close_size' => :'close_size',
    :'close_bid_time' => :'close_bid_time',
    :'close_bid_size' => :'close_bid_size',
    :'close_ask_time' => :'close_ask_time',
    :'close_ask_size' => :'close_ask_size',
    :'exercise_style' => :'exercise_style'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 138

def self.swagger_types
  {
    :'date' => :'String',
    :'close' => :'Float',
    :'close_bid' => :'Float',
    :'close_ask' => :'Float',
    :'volume' => :'Integer',
    :'open' => :'Float',
    :'open_ask' => :'Float',
    :'open_bid' => :'Float',
    :'open_interest' => :'Integer',
    :'high' => :'Float',
    :'low' => :'Float',
    :'mark' => :'Float',
    :'ask_high' => :'Float',
    :'ask_low' => :'Float',
    :'bid_high' => :'Float',
    :'bid_low' => :'Float',
    :'implied_volatility' => :'Float',
    :'delta' => :'Float',
    :'gamma' => :'Float',
    :'theta' => :'Float',
    :'vega' => :'Float',
    :'close_time' => :'DateTime',
    :'close_size' => :'Integer',
    :'close_bid_time' => :'DateTime',
    :'close_bid_size' => :'Integer',
    :'close_ask_time' => :'DateTime',
    :'close_ask_size' => :'Integer',
    :'exercise_style' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      close == o.close &&
      close_bid == o.close_bid &&
      close_ask == o.close_ask &&
      volume == o.volume &&
      open == o.open &&
      open_ask == o.open_ask &&
      open_bid == o.open_bid &&
      open_interest == o.open_interest &&
      high == o.high &&
      low == o.low &&
      mark == o.mark &&
      ask_high == o.ask_high &&
      ask_low == o.ask_low &&
      bid_high == o.bid_high &&
      bid_low == o.bid_low &&
      implied_volatility == o.implied_volatility &&
      delta == o.delta &&
      gamma == o.gamma &&
      theta == o.theta &&
      vega == o.vega &&
      close_time == o.close_time &&
      close_size == o.close_size &&
      close_bid_time == o.close_bid_time &&
      close_bid_size == o.close_bid_size &&
      close_ask_time == o.close_ask_time &&
      close_ask_size == o.close_ask_size &&
      exercise_style == o.exercise_style
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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 377

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



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 443

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 356

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


343
344
345
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 343

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



349
350
351
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 349

def hash
  [date, close, close_bid, close_ask, volume, open, open_ask, open_bid, open_interest, high, low, mark, ask_high, ask_low, bid_high, bid_low, implied_volatility, delta, gamma, theta, vega, close_time, close_size, close_bid_time, close_bid_size, close_ask_time, close_ask_size, exercise_style].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



295
296
297
298
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 295

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



423
424
425
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 423

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



429
430
431
432
433
434
435
436
437
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 429

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



417
418
419
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 417

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



302
303
304
 
# File 'lib/intrinio-sdk/models/option_price_eod.rb', line 302

def valid?
  return true
end