Class: IGMarkets::Streaming::PositionUpdate

Inherits:
Model
  • Object
show all
Defined in:
lib/ig_markets/streaming/position_update.rb

Overview

Contains details on a position update received via the streaming API. Used by Subscription#on_data.

Instance Attribute Summary

Attributes inherited from Model

#attributes

Instance Method Summary collapse

Methods inherited from Model

#==, allowed_values, attribute, attribute_type, attribute_value_allowed?, defined_attribute_names, deprecated_attribute, #initialize, #initialize_copy, #inspect, #to_h, valid_attribute?

Constructor Details

This class inherits a constructor from IGMarkets::Model

Instance Method Details

#account_id ⇒ Object

The account_id attribute.

Returns:



5
 
# File 'lib/ig_markets/streaming/position_update.rb', line 5

attribute :account_id

#channel ⇒ Object

The channel attribute.

Returns:



6
 
# File 'lib/ig_markets/streaming/position_update.rb', line 6

attribute :channel

#currency ⇒ Object

The currency attribute.

Returns:



7
 
# File 'lib/ig_markets/streaming/position_update.rb', line 7

attribute :currency

#deal_id ⇒ Object

The deal_id attribute.

Returns:



8
 
# File 'lib/ig_markets/streaming/position_update.rb', line 8

attribute :deal_id

#deal_id_origin ⇒ Object

The deal_id_origin attribute.

Returns:



9
 
# File 'lib/ig_markets/streaming/position_update.rb', line 9

attribute :deal_id_origin

#deal_reference ⇒ Object

The deal_reference attribute.

Returns:



10
 
# File 'lib/ig_markets/streaming/position_update.rb', line 10

attribute :deal_reference

#deal_status ⇒ Symbol

The deal_status attribute.

Returns:

  • (Symbol) 


11
 
# File 'lib/ig_markets/streaming/position_update.rb', line 11

attribute :deal_status, Symbol, allowed_values: %i[accepted rejected]

#direction ⇒ Symbol

The direction attribute.

Returns:

  • (Symbol) 


12
 
# File 'lib/ig_markets/streaming/position_update.rb', line 12

attribute :direction, Symbol, allowed_values: %i[buy sell]

#epic ⇒ String

The epic attribute.

Returns:

  • (String) 


13
 
# File 'lib/ig_markets/streaming/position_update.rb', line 13

attribute :epic, String, regex: Regex::EPIC

#expiry ⇒ Date

The expiry attribute.

Returns:

  • (Date) 


14
 
# File 'lib/ig_markets/streaming/position_update.rb', line 14

attribute :expiry, Date, nil_if: %w[- DFB], format: ['%d-%b-%y', '%b-%y']

#guaranteed_stop ⇒ Boolean

The guaranteed_stop attribute.

Returns:



15
 
# File 'lib/ig_markets/streaming/position_update.rb', line 15

attribute :guaranteed_stop, Boolean

#level ⇒ Float

The level attribute.

Returns:

  • (Float) 


16
 
# File 'lib/ig_markets/streaming/position_update.rb', line 16

attribute :level, Float

#limit_level ⇒ Float

The limit_level attribute.

Returns:

  • (Float) 


17
 
# File 'lib/ig_markets/streaming/position_update.rb', line 17

attribute :limit_level, Float

#size ⇒ Float

The size attribute.

Returns:

  • (Float) 


18
 
# File 'lib/ig_markets/streaming/position_update.rb', line 18

attribute :size, Float

#status ⇒ Symbol

The status attribute.

Returns:

  • (Symbol) 


19
 
# File 'lib/ig_markets/streaming/position_update.rb', line 19

attribute :status, Symbol, allowed_values: %i[deleted open updated]

#stop_level ⇒ Float

The stop_level attribute.

Returns:

  • (Float) 


20
 
# File 'lib/ig_markets/streaming/position_update.rb', line 20

attribute :stop_level, Float

#timestamp ⇒ Time

The timestamp attribute.

Returns:

  • (Time) 


21
 
# File 'lib/ig_markets/streaming/position_update.rb', line 21

attribute :timestamp, Time, format: ['%FT%T.%L', '%FT%T']