Module: IB::TrailingStop

Extended by:

OrderPrototype

Defined in:

lib/ib/order_prototypes/stop.rb

Overview

module OrderPrototype

Class Method Summary

• .aliases ⇒ Object
• .alternative_parameters ⇒ Object
• .defaults ⇒ Object
• .requirements ⇒ Object
• .summary ⇒ Object

Methods included from OrderPrototype

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

Class Method Details

.aliases ⇒ Object

# File 'lib/ib/order_prototypes/stop.rb', line 106

def aliases
	super.merge trail_stop_price: :price,
							aux_price: :trailing_amount
end

.alternative_parameters ⇒ Object

# File 'lib/ib/order_prototypes/stop.rb', line 117

def alternative_parameters
	{ aux_price: 'Trailing distance in absolute terms, aliased as :trailing_amount',
trailing_percent: 'Trailing distance in relative terms'}
end

.defaults ⇒ Object

# File 'lib/ib/order_prototypes/stop.rb', line 102

def defaults
	super.merge order_type: :trailing_stop , tif: :day
end

.requirements ⇒ Object

# File 'lib/ib/order_prototypes/stop.rb', line 111

def requirements
	## usualy the trail_stop_price is the market-price minus(plus) the trailing_amount
	super.merge trail_stop_price: 'Price to trigger the action, aliased as :price'

end

.summary ⇒ Object

# File 'lib/ib/order_prototypes/stop.rb', line 122

def summary
	<<-HERE
	A "Sell" trailing stop order sets the stop price at a fixed amount below the market 
	price with an attached "trailing" amount. As the market price rises, the stop price 
	rises by the trail amount, but if the stock price falls, the stop loss price doesn't 
	change, and a market order is submitted when the stop price is hit. This technique 
	is designed to allow an investor to specify a limit on the maximum possible loss, 
	without setting a limit on the maximum possible gain. 

	"Buy" trailing stop orders are the mirror image of sell trailing stop orders, and 
	are most appropriate for use in falling markets.

	Note that Trailing Stop orders can have the trailing amount specified as a percent, 
	or as an absolute amount which is specified in the auxPrice field. 

	HERE
end