Module: IB::Pegged2Primary

Extended by:

OrderPrototype

Defined in:

lib/ib/order_prototypes/pegged.rb

Class Method Summary

• .aliases ⇒ Object
• .defaults ⇒ Object
• .optional ⇒ 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/pegged.rb', line 10

def aliases
  super.merge  limit_price: :price_cap, aux_price: :offset_amount
end

.defaults ⇒ Object

# File 'lib/ib/order_prototypes/pegged.rb', line 6

def defaults
    super.merge order_type: 'REL' , tif: :day
end

.optional ⇒ Object

# File 'lib/ib/order_prototypes/pegged.rb', line 19

def optional
   super
end

.requirements ⇒ Object

# File 'lib/ib/order_prototypes/pegged.rb', line 14

def requirements
  super.merge aux_price: 'also aliased as :offset_amount',
limit_price: 'aliased as :price_cap'
end

.summary ⇒ Object

# File 'lib/ib/order_prototypes/pegged.rb', line 23

def summary
  "  Relative (a.k.a. Pegged-to-Primary) orders provide a means for traders\n  to seek a more aggressive price than the National Best Bid and Offer\n  (NBBO). By acting as liquidity providers, and placing more aggressive\n  bids and offers than the current best bids and offers, traders increase\n  their odds of filling their order. Quotes are automatically adjusted as\n  the markets move, to remain aggressive. For a buy order, your bid is\n  pegged to the NBB by a more aggressive offset, and if the NBB moves up,\n  your bid will also move up. If the NBB moves down, there will be no\n  adjustment because your bid will become even more aggressive and\n  execute. For sales, your offer is pegged to the NBO by a more\n  aggressive offset, and if the NBO moves down, your offer will also move\n  down. If the NBO moves up, there will be no adjustment because your\n  offer will become more aggressive and execute. In addition to the\n  offset, you can define an absolute cap, which works like a limit price,\n  and will prevent your order from being executed above or below a\n  specified level. \n  Supported Products:  Stocks, Options and Futures\n  ------ \n  not available on paper trading \n  HERE\nend\n"