trader.python customized by genBTC (trades on mtgox, bitfloor, btce,bitstamp). (hard coded for USD)
Some instructions are included in the source code(as docstrings, and by typing "help command")


##Features
Secure Authentication via password using 256-bit AES Encryption of your API-key and API-secret. (see Usage->Login with API-key/secret)
Buy and sell bitcoins. (manually)
Limit Orders & Market orders.  (TODO: Market order on bitfloor)
Automatic Dynamic Streaming Updates via the websocket(Socket.IO)
##Commands (" " is the command name, but in the program you have to use lowercase)
"Buy/Sell" Simple - X amount of BTC   (or in USD - put usd on the command)
"Buy/Sell" Spread - X amount of BTC between price A and price B of equally sized specified # of chunks (use with the word 'random' to randomize this a bit)
"Orders" - List your orders (TODO: upgrade to API 2)
"Cancel" - Cancel a single order (or a range (ie order #1-#20)) - sorted by price and numbered for convenience. no need to use order_id UUID.
"Cancelall" - Cancel ALL orders at once.
"Balance" - Display account balance (of BTC and USD) and USD value of BTC+USD
"Ticker" - Display ticker (sell,buy,last,vol,vwap,high,low,avg)	"the time frame for high, low, vol, avg, vwap ... is sliding 24 hours"-mtgox.
"Updown" - Log the ticker to a file; Rising/Falling Beep Tones Sequences on boundary threshhold change. (also can check logs later)
"Spread" - Display the bid/ask spread 
"Lag" - Show the current Mt.Gox Lag (trading lag)
"Book"- Print the order books out to howmany length you want (Display depth) (current order book of bids/asks) = printorderbook()
	- Automatically updated with the freshest possible date by websocket(Socket.IO)

###Depth Functions
"Obip- Calculate the "order book implied price", by finding the weighted average price of coins <width> BTC up and down from the spread.
"Asks" - Calculate the amount of bitcoins for sale at or under <pricetarget>.
"Bids" - Calculate the amount of bitcoin demanded at or over <pricetarget> 

###Depth Subfunctions ("depth ____")
"depth match" Match any order to the opposite site of the order book (ie: if buying find a seller or vice versa) - market order = depthmatch()
"depth match" Given the amount of BTC and price range, check to see if it can be filled as a market order = depthmatch()
"depth price" calculate the total price of the order and the average weighted price of each bitcoin = depthprice()
"depth range" calculate and print the total BTC between price A and B = depthsumrange()

###Fee Submenu ("Fees")
"Getfee" - Find out your current fee rate (Mt.Gox's commission)
"Calc" - Calculate how much fees will cost on X amount
"Balance" - Calculate how much fees will cost if you sold off your entire BTC Balance

###History 
Prints out your entire trading history of BTC transactions or USD (including deposits)	= "btchistory" or "usdhistory"
Download the entire trading history of mtgox for the past 24 hours. = "tradehist24"
Analyze the trading history (High/low/vwap/total/amounts/times) = "readtradehist24"

###Automatic Bot
"Sellwhileaway" - Repeatedly checks your balance and sells X amount at Price A (in case you have to leave the house and you are waiting on bitcoins to confirm)
"Liquidbot" - a bot on bitfloor to add liquidity to the market by surfing the spread To take advantage of bitfloor's 0.1% prodiver bonus therefor won't incur any trading fees 


# Includes frameworks (libs) for Mt.Gox, Bitfloor, BTC-E, Bitstamp
# All scripts located in bin/
# API Framework located in lib/
# Simple Example files in example/


Old Description:
FEATURES:
+) Diversify your position into "chunks" of a specified size between price A and B. WORKS GREAT!  #spread trade function including Chunk Trade spread logic & Confirmation#
	( todo: check market conditions, use VWAP to pick, select desired patience level or 	instant gratification)
+) Print the order books out to X length
+) For Market Orders
#Checks exact price (total and per bitcoin) @ Market prices
#   by checking opposite Order Book depth for a given size and price range (lower to upper)
#   and alerts you if cannot be filled immediately, and lets you place a limit order instead
+) Bitcoin Functions:
#calculate and print the total BTC between price A and B
#match any order to the opposite site of the order book (ie: if buying find a seller) - market 	order given the amount of BTC and price range check to see if it can be filled as a 		market order calculate the total price of the order and the average weighted price of 	each bitcoin 


TO BEGIN:
---------------
Windows binaries are included! (for encrypt_api_key, bitfloor_client, and mtgox_client)
Python Instructions (and Windows instructions) are located at the bottom of this README

Create a new API key on each website. If using Bitfloor, use the API password you assigned on the website. It will be required to use your API key.

encrypt_apikey.py:  	You need to generate encrypted keys beforehand with this command
			*Sometimes the generation does not work (just re-run this script -				it can take up to 3 times until it is verified)*

	Use bitfloor as the site name for Bitfloor
	Use mtgox as the site name for Mt. Gox	
	Use btc-e as the site name for BTC-E
	Use bitstamp as the site name for Bitstamp
	Where it says "Enter an encryption password: (This is the password required to 	execute trades)"
		-For bitfloor this is your passphrase that you entered on the website.
		-For mtgox you Create your own password, just be sure to remember it.
		-For btce you Create your own password, just be sure to remember it.
		-For bitstamp, there is no API Key or Secret. Use your user ID in place of 			"API Key" and Password in place of "API Secret" . You should provide an 		entirely different password to access the encrypted password. (to add a layer 		of security)


INSTRUCTIONS:
--------------------

Call any script by opening a command window (cmd.exe) to the directory:
	python mtgox_client.py

bin/
-encrypt_api_key - REQUIRED to use this suite, generates an encrypted API key file in keys/ with the site name (see above)
-bitfloor_client.py - Advanced Trading on bitfloor!
-mtgox_client.py - Advanced Trading on mtgox!

-mtgox_simple.py - CLI prompt for simple trading on mt.gox (simple, Buy/Sell, Amount, Price on mtgox)
-mtgox_socketiobeta.py - A BETA socketio client (relies on bin/goxapi.py from prof7bit) Connects to the websockets, outputs the streaming data (ticker/trade/depth/lag)
	-Reads from bin/goxtool.ini and logs to bin/goxtool.ini . CURRENTLY SET TO ONLY SCROLL PRINT OUT THE TRADES (the rest can be useless for my human eyes)
	-(Lines 808/809 disabled the other two, Line 814 commented out channel_subscribe(), channel_subscribe has some commented out lines)
-mtgox_websockets.py - A SAMPLE program (no error handling), that scroll prints 3 websocket channels (Ticker,trade,depth)

-bitfloor_cancel_all - 3 lines of code to cancel every order on bitfloor (very simple, passes the cancel order function to the framework lib/bitfloor.py)
-bitfloor_check_orders - print out current orders on bitfloor (simple, just prints out open orders)
-bitfloor_mirror_mtgox - mirror the mt.gox order book over to bitfloor (NOT WORKING FULLY)
-bitfloor_rand_latency - Test the ordering and cancellation latency on bitfloor (fairly non-useful since bitfloor latency is usually very low (~3 seconds))
-bitfloor_single - CLI prompt for simple trade execution on bitfloor (simple, Buy/Sell, Amount, Price on bitfloor) 

-btce_show_info - uses the framework of lib/btce.py to make several queries , like price ticker, open orders, order book, transaction history, etc
-btcerates - uses the btce framework to display a chart of exchange rates between all the currency pairs

-tradehistory.py - Was used as a self sufficient program at once, now is called by mtgox_client (this is the trade history analyzer that the "readtradehist24" command runs)

-bcfeed_sync (taken from ga-bitbot) on github - Downloads a 160MB text file from bitcoincharts of every trade that ever happened in mtgox history, then rewrites it into a 1 minute spaced CSV file thats about 20MB. Have not utilized the data from this directly. data/download_mtgoxUSD.csv=160MB data/bcfeed_mtgoxUSD_1min.csv=18MB
-bcbookie (taken from ga-bitbot) on github - NOT USED directly.
-goxcli (taken from Trasp/GoxCLI) on github - NOT USED directly. -goxcli.xml datafile for goxcli - NOT USED


example/
-readbitfloorcsv - Fee reports. 1) Download the CSV of your account history statement.(havent automated this part) 2) This program will go through the file, turn it into a properly formatted list of dictionaries, Scan it for all the fees, and print out the Fee Report. sample at http://pastebin.ca/2344564


lib/
-unlock_api_key.py - Decrypts the encrypted API keys that we make from keys/ 
-mtgoxhmac.py - Actual Mt.Gox Framework that should be used to make API calls (Uses combination of API2, API1, and API0 to get the work done. Can be modified easily)
-bitfloor.py - Bitfloor Framework with all API calls
-args.py - was needed for bitfloor plaintext keyfile which has been 90% phased out in favor of encrypted API keys
-btce.py - BTC-E Framework with all api calls (some HTTP error checking)
-book.py -  # will parse any json book in standard form

-common.py - Common trading functionality was merged in here for bitfloor_client.py and mtgox_client.py
-depthparser.py - imported a portion of goxcli into this file for use in mtgox. 
-json_ascii.py - # json decode strings as ascii instead of unicode
-liquidbot.py  		>	Both of these are taken from https://github.com/chrisacheson/liquidbot  (working on adding my own liquidbot to bitfloor)
-liquidbot_mtgox.py	>	Self-sufficient but not utilized in this suite (YET) he has a few good ideas
-mtgox2.py - an alternate Mt.gox framework
-goxapi (taken from prof7bit's goxtool) on github - NOT USED directly. 
-websocket.py (websocket-client-0.10.0) included so this package is not required.
-bitstamp.py

data/
config.json  - stores the hostname and port of the bitfloor API interface. thats it.
nonce_state_btce - required for the btce framework to generate a nonce(Saving this to a file is useful, since if the nonce messes up you have to recreate the API key)
mtgox_entiretrades.txt - written when you call tradehist24 (downloads the 24 hour trading history of mtgox)

keys/
{exchange}_key.txt and {exchange}_salt.txt   = this is what is written by encrypt_apikey and what is used to unlock your API keys to access the trading console


+) Programming Functions: (Common.py)
#turn a whole list or tuple into a float
#turn a whole list or tuple into a decimal
#get the mean of an entire list or tuple
#pretty print and pretty write a dict

PYTHON ON WINDOWS INFORMATION
-------------------------------
To use on windows some environment variables may be needed:
(trader.python) is the directory I put this entire project in.

echo PYTHONPATH=%PYTHONPATH%;C:\python27\;C:\python27\libs\;C:\python27\trader.python\lib\
echo PATH=%PATH%;C:\python27\
You will also need a bunch of py modules mostlikely:
###-crypto
-pyreadline
-readline
-requests (1.1.0)
-cjson
AND PROBABLY MORE,
To enable command line tab completion inside the scripts :
copy "C:\Python27\Lib\site-packages\pyreadline\configuration\pyreadlineconfig.ini" %HOMEPATH%
(tab completion was phased out in favor of command history (on windows))

(NOT implemented)
Websocket(SocketIO) for streaming updates.
Abort commands with SIGINT (ctrl-c on *nix) without exiting, f Mt. Gox is being slow (soon)
(doesn't exit when NOT busy but will exit if in the middle of a single transaction like a buy)
Withdraw bitcoins (available on bitstamp only)
Sequence multiple commands using semicolons
Tab completion of commands
Calculate profitable short/long prices from an initial price
Asynchronus HTTP Implementation to pipeline web requests (using twisted.web)
Stop Loss Bot.
Modifying strategy.
optional trade Wait time (default to instant gratification)