Class: IGMarkets::Instrument

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

Overview

Contains details on a tradeable instrument. Returned by Market#instrument.

Defined Under Namespace

Classes: Currency, ExpiryDetails, MarginDepositBand, OpeningHours, RolloverDetails, SlippageFactor

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

#chart_code ⇒ Object

The chart_code attribute.

Returns:



59
 
# File 'lib/ig_markets/instrument.rb', line 59

attribute :chart_code

#contract_size ⇒ Object

The contract_size attribute.

Returns:



60
 
# File 'lib/ig_markets/instrument.rb', line 60

attribute :contract_size

#controlled_risk_allowed ⇒ Boolean

The controlled_risk_allowed attribute.

Returns:



61
 
# File 'lib/ig_markets/instrument.rb', line 61

attribute :controlled_risk_allowed, Boolean

#country ⇒ Object

The country attribute.

Returns:



62
 
# File 'lib/ig_markets/instrument.rb', line 62

attribute :country

#currencies ⇒ Currency

The currencies attribute.

Returns:



63
 
# File 'lib/ig_markets/instrument.rb', line 63

attribute :currencies, Currency

#epic ⇒ String

The epic attribute.

Returns:

  • (String) 


64
 
# File 'lib/ig_markets/instrument.rb', line 64

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

#expiry ⇒ Date

The expiry attribute.

Returns:

  • (Date) 


65
 
# File 'lib/ig_markets/instrument.rb', line 65

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

#expiry_details ⇒ ExpiryDetails

The expiry_details attribute.

Returns:



66
 
# File 'lib/ig_markets/instrument.rb', line 66

attribute :expiry_details, ExpiryDetails

#force_open_allowed ⇒ Boolean

The force_open_allowed attribute.

Returns:



67
 
# File 'lib/ig_markets/instrument.rb', line 67

attribute :force_open_allowed, Boolean

#limited_risk_premium ⇒ LimitedRiskPremium

The limited_risk_premium attribute.

Returns:



68
 
# File 'lib/ig_markets/instrument.rb', line 68

attribute :limited_risk_premium, LimitedRiskPremium

#lot_size ⇒ Float

The lot_size attribute.

Returns:

  • (Float) 


69
 
# File 'lib/ig_markets/instrument.rb', line 69

attribute :lot_size, Float

#margin_deposit_bands ⇒ MarginDepositBand

The margin_deposit_bands attribute.

Returns:



70
 
# File 'lib/ig_markets/instrument.rb', line 70

attribute :margin_deposit_bands, MarginDepositBand

#margin_factor ⇒ Float

The margin_factor attribute.

Returns:

  • (Float) 


71
 
# File 'lib/ig_markets/instrument.rb', line 71

attribute :margin_factor, Float

#margin_factor_unit ⇒ Symbol

The margin_factor_unit attribute.

Returns:

  • (Symbol) 


72
 
# File 'lib/ig_markets/instrument.rb', line 72

attribute :margin_factor_unit, Symbol, allowed_values: %i[percentage points]

#market_id ⇒ Object

The market_id attribute.

Returns:



73
 
# File 'lib/ig_markets/instrument.rb', line 73

attribute :market_id

#name ⇒ Object

The name attribute.

Returns:



74
 
# File 'lib/ig_markets/instrument.rb', line 74

attribute :name

#news_code ⇒ Object

The news_code attribute.

Returns:



75
 
# File 'lib/ig_markets/instrument.rb', line 75

attribute :news_code

#one_pip_means ⇒ Object

The one_pip_means attribute.

Returns:



76
 
# File 'lib/ig_markets/instrument.rb', line 76

attribute :one_pip_means

#opening_hours ⇒ OpeningHours

The opening_hours attribute.

Returns:



77
 
# File 'lib/ig_markets/instrument.rb', line 77

attribute :opening_hours, OpeningHours

#rollover_details ⇒ RolloverDetails

The rollover_details attribute.

Returns:



78
 
# File 'lib/ig_markets/instrument.rb', line 78

attribute :rollover_details, RolloverDetails

#slippage_factor ⇒ SlippageFactor

The slippage_factor attribute.

Returns:



79
 
# File 'lib/ig_markets/instrument.rb', line 79

attribute :slippage_factor, SlippageFactor

#special_info ⇒ Object

The special_info attribute.

Returns:



80
 
# File 'lib/ig_markets/instrument.rb', line 80

attribute :special_info

#sprint_markets_maximum_expiry_time ⇒ Float

The sprint_markets_maximum_expiry_time attribute.

Returns:

  • (Float) 


81
 
# File 'lib/ig_markets/instrument.rb', line 81

attribute :sprint_markets_maximum_expiry_time, Float

#sprint_markets_minimum_expiry_time ⇒ Float

The sprint_markets_minimum_expiry_time attribute.

Returns:

  • (Float) 


82
 
# File 'lib/ig_markets/instrument.rb', line 82

attribute :sprint_markets_minimum_expiry_time, Float

#stops_limits_allowed ⇒ Boolean

The stops_limits_allowed attribute.

Returns:



83
 
# File 'lib/ig_markets/instrument.rb', line 83

attribute :stops_limits_allowed, Boolean

#streaming_prices_available ⇒ Boolean

The streaming_prices_available attribute.

Returns:



84
 
# File 'lib/ig_markets/instrument.rb', line 84

attribute :streaming_prices_available, Boolean

#type ⇒ Symbol

The type attribute.

Returns:

  • (Symbol) 


85
86
87
88
 
# File 'lib/ig_markets/instrument.rb', line 85

attribute :type, Symbol, allowed_values: %i[binary bungee_capped bungee_commodities bungee_currencies
bungee_indices commodities currencies indices opt_commodities
opt_currencies opt_indices opt_rates opt_shares rates sectors
shares sprint_market test_market unknown]

#unit ⇒ Symbol

The unit attribute.

Returns:

  • (Symbol) 


89
 
# File 'lib/ig_markets/instrument.rb', line 89

attribute :unit, Symbol, allowed_values: %i[amount contracts shares]

#value_of_one_pip ⇒ Object

The value_of_one_pip attribute.

Returns:



90
 
# File 'lib/ig_markets/instrument.rb', line 90

attribute :value_of_one_pip