GitXplorerGitXplorer
s

mtgox

public
83 stars
56 forks
2 issues

Commits

List of commits on branch master.
Unverified
031308d64fabbcdb0a745a866818fa9235830c51

Don't package test files with gem [ci skip]

ssferik committed 10 years ago
Unverified
23769721efb4c1485405d5976529757134dee382

Update rubocop dependency to >= 0.25

ssferik committed 10 years ago
Unverified
27b18879404b4013c2f69421bd8757764d3d1d2f

Flip secret bit to enable Docker builds

ssferik committed 10 years ago
Unverified
0a4813c7420a92a8222524660167501b66ef2551

Require Ruby 1.9.3 or higher

ssferik committed 10 years ago
Unverified
c6f10ce567907558a9b783b1c0fca54055a3bc66

Update rubocop dependency to >= 0.23

ssferik committed 10 years ago
Unverified
45ffbb23247ae39bcf7ceab123148ab25553f517

Nope

ssferik committed 10 years ago

README

The README file for this repository.

Ruby wrapper for the Mt. Gox Trade API

Gem Version Build Status Dependency Status Code Climate Coverage Status

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

Installation

gem install mtgox

Executable

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

$ btc
50.00

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

# Place a market order to sell one bitcoin
MtGox.sell! 1.0, :market

# Cancel order #1234567890
MtGox.cancel 1234567890

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

# Switch to sending 'tonce' rather than 'nonce'
MtGox.nonce_type = :tonce

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
  • Ruby 2.1.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

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