From a75784ca02fc43211af489e42e5a146fb80e7a30 Mon Sep 17 00:00:00 2001 From: Kevin Darby Date: Fri, 2 Aug 2019 17:55:46 -0400 Subject: [PATCH] update scratch and prorata algo docs --- .../bts_spark/Trading/OrderTypes/index.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/user/content/bts_spark/Trading/OrderTypes/index.md b/doc/user/content/bts_spark/Trading/OrderTypes/index.md index 1b423a99f..d045a8cf7 100644 --- a/doc/user/content/bts_spark/Trading/OrderTypes/index.md +++ b/doc/user/content/bts_spark/Trading/OrderTypes/index.md @@ -53,3 +53,25 @@ If exposed_qty is set to 0 the splitter will continue to exist in the Order Book ##### Parameters * exposed_qty - The total quantity to expose on the market. * max_order_qty - The maximum size of a single order. + + +## Scratch +The scratch algo is similar to Lean, but instead of watching the opposite inside market, it watches the same side market and pays up when this quantity recedes below the scratch_threshold + +##### Parameters + * scratch_threshold - The quantity on the same side market below which to scratch + * chase_ticks - The number of ticks through the opposite market to pay up + + +## ProRata +The prorata algo is a special case hedging algo for pro-rata markets. Users can specify two hedge types-- normal hedge and overfill hedge, the latter is spawned when you receive more fills than your fill_limit. Further, the algo attempts to scratch when in an overfilled state AND optionally the same side size falls below stay_in_threshold + +##### Parameters + * hedge_ticks - The amount of ticks better hedges are placed on the opposite side market as the fill + * chase_ticks - How many ticks through the opposite market on a scratch + * fill_limit - The limit after which the algo considers further fills to be 'overfills' + * stay_in_threshold - A same side size threshold that enables the algo to 'stay in' even if overfilled + * enable_scratch_on_overfill - When true, overfills are immediately scratched upon the algo exiting + * enable_stay_in - When true, the algo will 'stay in' so long as the same side size is above stay_in_threshold, when false the algo attempts to 'get out' (and potentially scratch overfills) as soon as it reaches overfill status + * hedge - Child order type to send for normal hedges + * overfill_hedge - Child order type to send for overfill hedges