Module: IB::SimpleStop

Extended by:
OrderPrototype
Defined in:
lib/ib/order_prototypes/stop.rb

Class Method Summary collapse

Methods included from OrderPrototype

aliases, alternative_parameters, defaults, optional, order, parameters, requirements

Class Method Details

.aliases ⇒ Object 



11
12
13
 
# File 'lib/ib/order_prototypes/stop.rb', line 11

def aliases
	super.merge  aux_price: :price 
end

.defaults ⇒ Object 



7
8
9
 
# File 'lib/ib/order_prototypes/stop.rb', line 7

def defaults
	  super.merge order_type: :stop 
end

.requirements ⇒ Object 



15
16
17
 
# File 'lib/ib/order_prototypes/stop.rb', line 15

def requirements
	super.merge aux_price: 'Price where the action is triggert. Aliased as :price'
end

.summary ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/ib/order_prototypes/stop.rb', line 20

def summary
	<<-HERE
	A Stop order is an instruction to submit a buy or sell market order if and when the 
	user-specified stop trigger price is attained or penetrated. A Stop order is not guaranteed 
	a specific execution price and may execute significantly away from its stop price. 
	
	A Sell Stop order is always placed below the current market price and is typically used 
	to limit a loss or protect a profit on a long stock position. 
	
	A Buy Stop order is always placed above the current market price. It is typically used 
	to limit a loss or help protect a profit on a short sale. 
	HERE
end