Ruby wrapper for the Mt. Gox Trade API
Mt. Gox allows you to trade US Dollars (USD) for Bitcoins (BTC) or Bitcoins for US Dollars.
gem install mtgox
To ensure the code you're installing hasn't been tampered with, it's recommended that you verify the signature. To do this, you need to add my public key as a trusted certificate (you only need to do this once):
gem cert --add <(curl -Ls https://gist.github.com/sferik/4701180/raw/public_cert.pem)
Then, install the gem with the high security trust policy:
gem install mtgox -P HighSecurity
After installing the gem, you can get the current price for 1 BTC in USD by
btc in your bash shell:
$ btc 50.00
require 'rubygems' require 'mtgox' # Fetch the latest price for 1 BTC in USD puts .ticker.sell # Fetch open asks puts .asks # Fetch open bids puts .bids # Fetch the last 48 hours worth of trades (takes a minute) puts .trades # Certain methods require authentication . do |config| config.key = YOUR_MTGOX_KEY config.secret = YOUR_MTGOX_SECRET end # Fetch your current balance puts .balance # Place a limit order to buy one bitcoin for $0.011 .buy! 1.0, 0.011 # Place a limit order to sell one bitcoin for $100 .sell! 1.0, 100.0 # Cancel order #1234567890 .cancel 1234567890 # Withdraw 1 BTC from your account .withdraw! 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"
In the spirit of free software, everyone is encouraged to help improve this project.
Here are some ways you can contribute:
- by using alpha, beta, and prerelease versions
- by reporting bugs
- by suggesting new features
- by writing or editing documentation
- by writing specifications
- by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
- by refactoring code
- by closing issues
- by reviewing patches
Supported Ruby Versions
This library aims to support and is tested against the following Ruby implementations:
- Ruby 1.9.2
- Ruby 1.9.3
- Ruby 2.0.0
If something doesn't work on one of these interpreters, it's a bug.
This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the versions listed above.
If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.
Copyright (c) 2011-2013 Erik Michaels-Ober. See LICENSE for details.