No commit activity in last 3 years
No release in over 3 years
A lightweight ruby client for the meXBT Transfer API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.6
>= 0
>= 0
>= 0

Runtime

 Project Readme

Mexbt Transfer API Ruby client

This is a lightweight ruby client for the meXBT Transfer API. It doesn't try and do anything clever with the JSON response from the API, it simply returns it as-is.

Install

If using bundler simply this to your Gemfile:

gem 'mexbt-transfer-api'

And run bundle install of course.

Ruby version

You need to be using Ruby 2.1 or higher.

Setting up a client

api = Mexbt::TransferApi.new("your-api-key", "your-api-secret", your_client_id)

If you want to work against another endpoint, you can configure that like:

api = Mexbt::TransferApi.new("your-api-key", "your-api-secret", your_client_id, endpoint: "https://transfer-staging.mexbt.com/v1")

Checking api is up and you can authenticate ok

api.ping()

Creating orders

api.create_order(in_currency: 'btc', out_currency: 'mxn', out_via: 'atm', out_amount: 100, webhook: 'http://your.domain/hook')

Fetching an order

api.get_order(1)