Contents

# Bitstamp Ruby API

Feel free to fork, modify & redistribute under the MIT license.

## Installation

Add this line to your application's Gemfile:

    gem 'bitstamp'
    
## Setup

```ruby
Bitstamp.setup do |config|
  config.key = YOUR_BITSTAMP_USERNAME
  config.secret = YOUR_BITSTAMP_PASSWORD
end
```

If you fail to set your `key` or `secret` a `MissingConfigExecption`
will be raised.

## Bitstamp ticker

The bitstamp ticker. Returns `last`, `high`, `low`, `volume`, `bid` and `ask`

```ruby
Bitstamp.ticker
```

It's also possible to query through the `Bitstamp::Ticker` object with
each individual method.

```ruby
Bitstamp::Ticker.low     # => "109.00"
```

## Fetch your open order

Returns an array with your open orders.

```ruby
Bitstamp.orders.all
```

## Create a sell order

Returns an `Order` object.

```ruby
Bitstamp.orders.sell(amount: 1.0, price: 111)
```

## Create a buy order

Returns an `Order` object.

```ruby
Bitstamp.orders.buy(amount: 1.0, price: 111)
```

*To be continued!**

# Tests

If you'd like to run the tests you need to create a yaml file in the
root of the gem `bit_stamp_details.yml` which holds your authentication
details for Bitstamp.

```yaml
bitstamp:
  id: 'bitstamp id'
  password: 'bitstamp password'
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b
my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
bitstamp-0.2.7	README.md
bitstamp-0.2.6	README.md
bitstamp-0.2.5	README.md
bitstamp-0.2.4	README.md
bitstamp-0.2.3	README.md