Skip to content

piousbox/mtgox

 
 

Repository files navigation

Ruby wrapper for the Mt. Gox Trade API Build Status Dependency Status

Mt. Gox allows you to trade US Dollars (USD) for Bitcoins (BTC) or Bitcoins for US Dollars.

Installation

gem install mtgox

Alias

After installing the gem, you can get the current price for 1 BTC in USD by typing btc in your bash shell simply by setting the following alias:

alias btc='ruby -r rubygems -r mtgox -e "puts MtGox.ticker.sell"'

Documentation

http://rdoc.info/gems/mtgox

Usage Examples

require 'rubygems'
require 'mtgox'

# Fetch the latest price for 1 BTC in USD
puts MtGox.ticker.sell

# Fetch open asks
puts MtGox.asks

# Fetch open bids
puts MtGox.bids

# Fetch the last 48 hours worth of trades (takes a minute)
puts MtGox.trades

# Certain methods require authentication
MtGox.configure do |config|
  config.key = YOUR_MTGOX_KEY
  config.secret = YOUR_MTGOX_SECRET
end

# Fetch your current balance
puts MtGox.balance

# Place a limit order to buy one bitcoin for $0.011
MtGox.buy! 1.0, 0.011

# Place a limit order to sell one bitcoin for $100
MtGox.sell! 1.0, 100.0

# Cancel order #1234567890
MtGox.cancel 1234567890

# Withdraw 1 BTC from your account
MtGox.withdraw! 1.0, "1KxSo9bGBfPVFEtWNLpnUK1bfLNNT4q31L"

Contributing

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

If something doesn't work on one of these interpreters, it should be considered 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 personally 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

Copyright (c) 2011 Erik Michaels-Ober. See LICENSE for details.

About

Ruby wrapper for the Mt. Gox Trade API

Resources

License

Stars

Watchers

Forks

Packages

No packages published