Class: Intrinio::RealtimeStockPrice

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

Overview

The realtime stock price of a security.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RealtimeStockPrice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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_price')
    self.last_price = attributes[:'last_price']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#ask_price ⇒ Object

The price of the top ask order.



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

def ask_price
  @ask_price
end

#ask_size ⇒ Object

The size of the top ask order.



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

def ask_size
  @ask_size
end

#bid_price ⇒ Object

The price of the top bid order.



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

def bid_price
  @bid_price
end

#bid_size ⇒ Object

The size of the top bid order.



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

def bid_size
  @bid_size
end

#close_price ⇒ Object

The price at the close of the trading day. (IEX only)



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

def close_price
  @close_price
end

#exchange_volume ⇒ Object

The number of shares exchanged during the trading day on the exchange.



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

def exchange_volume
  @exchange_volume
end

#high_price ⇒ Object

The high price for the trading day.



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

def high_price
  @high_price
end

#is_darkpool ⇒ Object

Whether or not the current trade is from a darkpool or not.



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

def is_darkpool
  @is_darkpool
end

#last_price ⇒ Object

The price of the last trade.



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

def last_price
  @last_price
end

#last_size ⇒ Object

The size of the last trade.



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

def last_size
  @last_size
end

#last_time ⇒ Object

The date and time when the last trade occurred.



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

def last_time
  @last_time
end

#listing_venue ⇒ Object

The listing venue where the trade took place. Available only where source is SIP. Listing Venue Modifiers include: Q – Nasdaq | N – NYSE | A – NYSE American | P – NYSE Arca | u – Other OTC Markets | V – Investors Exchange LLC



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

def listing_venue
  @listing_venue
end

#low_price ⇒ Object

The low price for the trading day.



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

def low_price
  @low_price
end

#market_center_code ⇒ Object

The market center character code.



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

def market_center_code
  @market_center_code
end

#market_volume ⇒ Object

The number of shares exchanged during the trading day for the whole market.



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

def market_volume
  @market_volume
end

#open_price ⇒ Object

The price at the open of the trading day.



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

def open_price
  @open_price
end

#quote_conditions ⇒ Object

When applicable, indicates any quote condition modifiers associated with the trade. Quote Condition Modifiers include: R – Regular | A – Slow on Ask | – Slow on Bid | C – Closing | D – News Dissemination | F – Slow on ASK (LRP or Gap Quote) | E – Slow on Bid (LRP or Gap Quote) | G – Trading Range Indication | H – Slow on Bid and Ask | I – Order Imbalance | J – Due to Related - News Dissemination | K – Due to Related - News Pending | O – Open | L – Closed | M – Volatility Trading Pause | N – Non-Firm Quote | O – Opening | P – News Pending | S – Due to Related | T – Resume | U – Slow on Bid and Ask (LRP or Gap Quote) | V – In View of Common | W – Slow on Bid and Ask (LRP or Gap Quote) | X – Equipment Changeover | Y – Sub-Penny Trading | Z – No Open / No Resume | F – Fast Trading | U – Slow on Bid and Ask (Non-Firm) | One-Sided – One-Sided | X – Order Influx | 0 – Special Opening Quote | Halted – Halted | Benchmark – Benchmark | Implied – Implied | Exchange Best – Exchange Best | 1 – Market Wide Circuit Breaker Level 1 | 2 – Market Wide Circuit Breaker Level 2 | 3 – Market Wide Circuit Breaker Level 3 | Rotation – Rotation | Auto Exec Eligible – Auto Exec Eligible | Bid Side Firm – Bid Side Firm | Ask Side Firm – Ask Side Firm | 4 – On Demand Intraday Auction | I – Indicative Value (OPRA) | 45 – Additional Information Required (CTS) | 46 – Regulatory Concern (CTS) | 47 – Merger Effective | 49 – Corporate Action (CTS) | 50 – New Security Offering (CTS) | 51 – Intraday Indicative Value Unavailable (CTS)



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

def quote_conditions
  @quote_conditions
end

#sales_conditions ⇒ Object

When applicable, indicates any sales condition modifiers associated with the trade. Sales Condition Modifers include: @ – Regular Sale | A – Acquisition | B – Bunched Trade | C – Cash Sale | D – Distribution | E – Placeholder | F – Intermarket Sweep | G – Bunched Sold Trade | H – Priced Variation Trade | I – Odd Lot Trade | K – Rule 155 Trade (AMEX) | L – Sold Last | M – Market Center Official Close | N – Next Day | O – Opening Prints | P – Prior Reference Price | Q – Market Center Official Open | R – Seller | S – Split Trade | T – Form T | U – Extended Trading Hours (Sold Out of Sequence) | V – Contingent Trade | W – Average Price Trade | X – Cross/Periodic Auction Trade | Y – Yellow Flag Regular Trade | Z – Sold (Out of Sequence) | 1 – Stopped Stock (Regular Trade) | 4 – Derivatively Priced | 5 – Re-Opening Prints | 6 – Closing Prints | 7 – Qualified Contingent Trade (QCT) | 8 – Placeholder for 611 Exempt | 9 – Corrected Consolidated Close (Per Listing Market)



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

def sales_conditions
  @sales_conditions
end

#security ⇒ Object

Returns the value of attribute security.



78
79
80
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 78

def security
  @security
end

#source ⇒ Object

The source of the data.



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

def source
  @source
end

#updated_on ⇒ Object

The date and time when the data was last updated.



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

def updated_on
  @updated_on
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'last_price' => :'last_price',
    :'last_time' => :'last_time',
    :'last_size' => :'last_size',
    :'bid_price' => :'bid_price',
    :'bid_size' => :'bid_size',
    :'ask_price' => :'ask_price',
    :'ask_size' => :'ask_size',
    :'open_price' => :'open_price',
    :'close_price' => :'close_price',
    :'high_price' => :'high_price',
    :'low_price' => :'low_price',
    :'exchange_volume' => :'exchange_volume',
    :'market_volume' => :'market_volume',
    :'updated_on' => :'updated_on',
    :'source' => :'source',
    :'listing_venue' => :'listing_venue',
    :'sales_conditions' => :'sales_conditions',
    :'quote_conditions' => :'quote_conditions',
    :'market_center_code' => :'market_center_code',
    :'is_darkpool' => :'is_darkpool',
    :'security' => :'security'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'last_price' => :'Float',
    :'last_time' => :'DateTime',
    :'last_size' => :'Float',
    :'bid_price' => :'Float',
    :'bid_size' => :'Float',
    :'ask_price' => :'Float',
    :'ask_size' => :'Float',
    :'open_price' => :'Float',
    :'close_price' => :'Float',
    :'high_price' => :'Float',
    :'low_price' => :'Float',
    :'exchange_volume' => :'Float',
    :'market_volume' => :'Float',
    :'updated_on' => :'DateTime',
    :'source' => :'String',
    :'listing_venue' => :'String',
    :'sales_conditions' => :'String',
    :'quote_conditions' => :'String',
    :'market_center_code' => :'String',
    :'is_darkpool' => :'BOOLEAN',
    :'security' => :'RealtimeStockPriceSecurity'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      last_price == o.last_price &&
      last_time == o.last_time &&
      last_size == o.last_size &&
      bid_price == o.bid_price &&
      bid_size == o.bid_size &&
      ask_price == o.ask_price &&
      ask_size == o.ask_size &&
      open_price == o.open_price &&
      close_price == o.close_price &&
      high_price == o.high_price &&
      low_price == o.low_price &&
      exchange_volume == o.exchange_volume &&
      market_volume == o.market_volume &&
      updated_on == o.updated_on &&
      source == o.source &&
      listing_venue == o.listing_venue &&
      sales_conditions == o.sales_conditions &&
      quote_conditions == o.quote_conditions &&
      market_center_code == o.market_center_code &&
      is_darkpool == o.is_darkpool &&
      security == o.security
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



306
307
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
340
341
342
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 306

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 372

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 285

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


272
273
274
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 278

def hash
  [last_price, last_time, last_size, bid_price, bid_size, ask_price, ask_size, open_price, close_price, high_price, low_price, exchange_volume, market_volume, updated_on, source, listing_venue, sales_conditions, quote_conditions, market_center_code, is_darkpool, security].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



231
232
233
234
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 231

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



352
353
354
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 352

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



358
359
360
361
362
363
364
365
366
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 358

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



346
347
348
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 346

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



238
239
240
 
# File 'lib/intrinio-sdk/models/realtime_stock_price.rb', line 238

def valid?
  return true
end