Quote from: Sampey on November 09, 2013, 03:05:24 PM

GUIDE - HOW TO USE C.A.T.

BTC Login BTC

http://i.imgur.com/ZcK0Xf1.png http://i.imgur.com/qFimJ4S.png

First time you start C.A.T. you will get an Empty Login GUI
- Insert your private and your public key and press Enter
- C.A.T. will verify if your public key is the key of your personal copy
- C.A.T. will communicate with public key + private key to Cryptsy to get Server Time

If everything goes well you will get "Key Accepted Message"

- C.A.T. will save in the program Directory your Public/Private Key in a File named Key.XML and next time you log on C.A.T. the private/public key will be in the textbox.
- C.A.T. will suggest you the LogDirectory

Root is the director Where C.A.T. is Running+"\LOGS"
Inside LOGS there's GAIN Logs Directory
Inside LOGS there's ERROR Logs Directory

- If you get an error during login, probably is an error from server, don't worry and retry.

BTC Main Panel - Dashboard BTC

http://i.imgur.com/NNgNTk9.png

This is the Main C.A.T. Panel.
From the Dashboard you can load/call all the functions you need.
From the Toolbar -> Option Item you can :
- Save To XML Format all your open Markets Algorithm Parameters
- Load From XML Saved Algo Parameters (this operation can be done without any open markets)
- Close All C.A.T. Current Orders (only orders created by C.A.T. during the current run)
- Close Al Orders (Also orders only on Cryptsy or of a previous C.A.T. Running)
From the Toolbar -> View Item you can sort all open markets in lexicographic order

BTC Markets List BTC

http://i.imgur.com/OVtQDNi.png

You can choose to load the markets from Cryptsy : All Markets/only BTC Markets/only LTC Markets/only XPM Markets
If you check the box "With Statistic Calculation" C.A.T. will calculate some additional statistics over the orders/trades (this operation is longer than the normal market load process)

These are the statistics calculated :
- % Difference is the difference between High/Low Trades of the last 24Hours
- Sell Order/Buy Order are the numbers of currently orders
- Sell Trade/Buy Trade 24H is the numbers of trades in the last 24Hours

You can sort this table in Ascending/Descending Order by clicking on the Column Header
Double Click On a Row will Open a new Tab for the selected Market in "My Markets" Panel.

BTC My Balances BTC

http://i.imgur.com/PYoVnxs.png

If you want to check your balances press the button "Load Balances"
Positive Balances are highlighted in green.
You can sort the table by Column.

Estimated Portfolio Values is calculated this way :
BTC Amount + Sum(Of All BTC Market Alt Curr * lastMarketPrice)+Sum(Of All Only-LTC Market Alt Curr * lastMarketPrice)+Sum(Of All Only-XPM Market Alt Curr * lastMarketPrice)

The algorithm works also on "Held For Orders" Balances

BTC My Open Markets BTC

http://i.imgur.com/AL4aWwN.png

For Each Open Market you will get a Tab Like This.

- Market
If you want to have a look at the current market status without go on Cryptsy or if you want to have all trades divided by "Buy/Sell", the only thing you must do is press the "Refresh Status Button" and wait some seconds.
These are the info displayed : Market current Orders/Your current Orders/Last Trades (Divided Buy/Sell)/Your Last Trades (Divided Buy/Sell)

- Ping-Pong
It's where you create your Ping Pong Algorithm

- In The TabbedPane you can get Info About :
General Statistic (sum of current status values and sum of all values from start time)
CurrentPing/CurrentPong/Trade/Orders/Errors/Sell-Buy/Orders To Restore (when Cryptsy return error)
List Of Ping-Pong Completed (Gain)
General Log and Error Log

Action you can perform from the dropdown list (You Must press the EXECUTE button) :
- Stop The Ping Pong Process
- Stop/Restart The Creation of new Ping Orders (current orders over the market will remain active)
- Close All Orders over the current market
- Close All Ping Orders over the current market

Status Label Meanings :
- Wait (Green) : Algo Is Sleeping
- Lookup (Yellow) : Algo Is Checking For Trades/OrderCreation/OrderRecreation etc...
- Red (Zombie) : There is nothing to do, no Buy/Sell Pool Values, No Ping, No Pong, No Trades
- Stop (Black) : Algo Is Not Running

BTC Ping Pong Algo Creator BTC

http://i.imgur.com/qAerC0i.png

This is where you create/update the Ping-Pong Algo.

1 - CHOOSE ALGO TYPE

AGGRESSIVE MODE
You must set only Min % Guaranteed Gain, C.A.T. will try always to made a successfull Ping-Pong Algo
Aggressive Mode is Equals to Normal Mode Without Any Parameter Set

STATIC MODE
Choose a fixed price for Buy/Sell and C.A.T. will always Buy/Sell at these prices, without any adjustment.

NORMAL MODE
- Min % Guaranteed Gain. Is the minimal % of GAIN you want guaranteed from C.A.T. after a Buy-Sell/Sell-Buy operation. If this percentage is not guaranteed, C.A.T. will wait.
- Skip Orders With Total < Than. With this Option Active C.A.T. during his Algorithm will not consider orders with total amount lower than the parameter value.
- Don't create ping with total < Than. After a successfull Ping-Pong the total amount of this order will be put in the "Cauldron" and from the "Cauldron" will be created new sell/buy orders. With this option activated you will limit the creation on "little orders". If total in Cauldron will be < than this parameter, C.A.T. will wait for more money in cauldron.
- Never Sell Under/Never Buy Over with this option activated you will limit the creaton of orders with price too low or too high.
- Sell All If Price Goes Under (Works only for Sell Orders) with this option activated C.A.T. will sell your order if the market price is too low. The sell price will be current the best buy price.
- Sell All If % With Ref Price Is : (Works only for Sell+Pong Orders) Each PONG orders have a reference Price : the sell/buy price of the Original Pong Orders. C.A.T. during the algo calculate the % difference between the reference price and the current best Buy/Sell Orders. With this option activated you decide to sell a Pong Order if the % calculated is too negative. A Suggestion is to use value lower than -5%
- Stop Ping Creation If Sell Value Is > : You can decide to Stop The ping Order Creation if the Current Best Sell Value if too high, C.A.T. will restart Ping Order Creation if the Best Sell Values return lower than your parameter
- Stop Ping Creation If Buy Value Is < : You can decide to Stop The ping Order Creation if the Current Best Buy Value if too logw, C.A.T. will restart Ping Order Creation when the Best Buy Value return higher than your parameter
- Never Buy/Sell Directly with this option you will never buy/sell directly and you orders will have 0.00000001 difference from the best Buy/Sell orders.

2 - OTHER GENERAL OPTIONS

- Never Recalculate User Ping Orders : With this option Checked, C.A.T. will not retry to calculate orders inserted from the GUI by the user. Price of these orders will remain static.
- Run Algorithm For XX Minutes and then return all to primary/secondary currency : With this option Checked C.A.T. will normally run for the numbers of minutes set by user. After that amount of minutes C.A.T. will stop create Buy/Sell Ping Orders and will stop create PONG Orders of Buy/Sell Tipe (depending by your return currency choose)
All pending trades, buy pool and internal structure will remain frozen until user de-check this option.

3 - CALCULATOR

Press the CHECK Button in the CALCULATOR if you want to :
- Your Primary/Secondary Currency Balances
- Know the % Difference between the Lowest Sell Price & The Higher Buy Price
- A Suggestion about the price to start a Sell/Buy Orders (accordingly to the algo parameter you have set)

4 - GENERATE PING-PONG

GENERATE PING-PONG Algo With the first orders.
- Choose Type+Price+Quantity and press ADD PING ORDER (repeat for each order you want to create)
- Press the ADD NEW PING ORDERS button and C.A.T will start to Work.

DURING PING-PONG RUNNING
- You can Update All Your Parameter (Update Ping-Pong Parameter Button)
- You can add New Ping Orders. (Add New Ping Orders Button)

BTC Statistics BTC

http://i.imgur.com/CREZOV4.png

This is a General Statistic Panel. Each Markets Have One.
If you want to read the sum of all the Single Market Statistics, you can load the General Statistic Panel from the Dashboard

BTC General Log Gain BTC

http://i.imgur.com/HbHaaNT.png

In the general log gain you can see all the Gain obtained by a Ping-Pong, divided by market (BTC,LTC,XPM)
You can Export each log in Excel Format.

BTC Analyzer BTC

Market Analyzer is a tool created for compare market currencies values taken at different times.
And also to give you an hand to choose "massive" buy/sell and sell/buy when currencies values are at your advantage.

http://i.imgur.com/ff7sBaM.jpg

- First things to do is Load Current Market Values (you can choose all values, or only BTC,LTC,XPM)
- If you are going to sell/buy, set in the table : Action + Price + Quantity
- Save the Snapshot (xml format)

When you want to make a compare you must load 2 Market Snapshot, and then decide (select the snapshots from the combobox in the botton of Analyzer Panel) which market is the market FROM and which is the market TO. Then press COMPARE Button

http://i.imgur.com/r3U92Bz.jpg

Each value from the Snapshot FROM will be compare against the same value in Snapshot TO.
If Value is higher you will see in GREEN Color
If Value is lower you will see in RED Color
If you have set a BUY/SELL operation in the Snapshot FROM, you will also see a estimated value of how much can you gain/lose if you sell/buy now your previous buy/sell orders.

BTC Console Error BTC

http://i.imgur.com/FeVcJKz.png

Is the console where all System Errors Are Listed many of the are only warnings because C.A.T. is able to recover these errors.

HTTP ERROR Connection timed out: connect RETRY IN 10 Seconds
Your adsl line is Down/Cryptsy doesn't response? No problem, C.A.T will retry.

Call Retry Json Exception Unterminated string at xxxxxx...............
It's a JSON result bad formatted. It rarely happens, but the call will be retried.

Call Aborted! Json Result Error during createorder Call Is Aborted After 25 retry
It happens when the orders creation, after 25 Retry is failed. Usually is because there are no money in wallet. C.A.T. will try to recreate an order with lower quantity at the same price.

HTTP ERROR Server returned HTTP response code: 502 for URL: https://www.cryptsy.com/api
Cryptsy Error. Call Will Be Retried.

XPM/BTC (Or Any Other Market) Error Lookup Market Better Restart Market
This is usually an internal Error. Is Very Rare but i can do some code improvements to find and resolve.

how does the ping pong algo work? how can it guarantee return? forecasting market or finding arbitrage b/w exchanges?
interested in this, but want to make sure the algo itself and implementation is sound. thanks