Sha256: f093980a913fe824cc6bf04b12abe36c533a3e2a502b86744557c29aca3876fe

Contents?: true

Size: 1.41 KB

Versions: 6

Compression:

Stored size: 1.41 KB

Contents

# PaxfulClient

An API wrapper for Paxful.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'paxful_client'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install paxful_client

## Usage

```ruby
client = PaxfulClient.new(host: "host", key: "key", secret: "secret")

# Get balance
response = client.get_balance
wallet = response.wallet
wallet.balance

# Get completed trades (page = 1 by default)
response = client.get_completed_trades

# Get completed trades by page
response = client.get_completed_trades(page: page)

# Get response
order_book = response.order_book
order_book.trades
```

## Development

```
cp spec/config.yml{.sample,}
rspec
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/MarkFChavez/paxful_client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/MarkFChavez/paxful_client-ruby/blob/master/CODE_OF_CONDUCT.md).


## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the PaxfulClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/MarkFChavez/paxful_client-ruby/blob/master/CODE_OF_CONDUCT.md).

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
paxful_client-1.5.1 README.md
paxful_client-1.5.0 README.md
paxful_client-1.4.0 README.md
paxful_client-1.3.0 README.md
paxful_client-1.2.0 README.md
paxful_client-1.1.0 README.md