hitbtc 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 288b1ba6e06ecc47a81cdf1f0914447c092063db
+  data.tar.gz: 40fc742b57d7501897a123a2a2f5c6e08fb511a4
+SHA512:
+  metadata.gz: 749a1ef4ad43b2d88ec7a006c5b4bf40f972ff7d6de4da8b1b0adc51d8d9abfff927f1e00b78f048fc600dfacfdf6d6f3af84bc1ad46ddac7da618d9f870f314
+  data.tar.gz: 8cbdeef9e634273e7a2a7b0a20eb4f81c44b5e2bd10c457b2a35a2976dde01fbda37dedb4ce53b80429b1af41de03f205d40541684f01037e043e2c87b76b60c

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+*.gem
+key.yml

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hitbtc.gemspec
+gemspec
+gem 'httparty'
+gem 'hashie'

data/README.md

@@ -0,0 +1,249 @@
+## Summary
+
+This document provides the complete reference for [hitbtc](https://hitbtc.com) API in the wrapper.
+
+
+The following symbols are traded on hitbtc exchange.
+
+| Symbol	| Lot size | Price step
+| --- | --- | --- |
+| BTCUSD |	0.01 BTC |	0.01 |
+| BTCEUR |	0.01 BTC |	0.01 |
+| LTCBTC | 0.1 LTC |	0.00001 |
+| LTCUSD | 0.1 LTC |	0.001 |
+| LTCEUR | 0.1 LTC |	0.001 |
+| EURUSD | 1 EUR |	0.0001 |
+
+Size representation:
+* Size values in streaming messages are represented in lots.
+* Size values in RESTful market data are represented in money (e.g. in coins or in USD). 
+* Size values in RESTful trade are represented in lots (e.g. 1 means 0.01 BTC for BTCUSD)
+
+### Pending Future Updates
+
+- Solid trade execution functionality
+- payment api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hitbtc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hitbtc
+
+## Usage
+
+Create a Kraken client:
+
+```ruby
+API_KEY = '3bH+M/nLp......'
+API_SECRET = 'wQG+7Lr9b.....'
+
+hitbtc = Hitbtc::Client.new(API_KEY, API_SECRET)
+
+time = hitbtc.server_time
+time #=> 1393056191
+```
+### Public Data Methods
+
+#### Server Time
+```ruby
+time = hitbtc.server_time
+
+```
+#### Symbol info
+
+ ```ruby
+ symbol = hitbtc.symbols("BTCEUR")
+ symbols = hitbtc.symbols(["BTCEUR", "BTCUSD"])
+ all_symbols = hitbtc.symbols
+ ```
+
+#### Ticker
+
+```ruby
+ticker_data = hitbtc.ticker('BTCEUR')
+```
+
+* 24h means last 24h + last incomplete minute
+* high - highest trade price / 24 h
+* low - lowest trade price / 24 h
+* volume - volume / 24h
+
+#### Order Book
+
+```ruby
+order_book = hitbtc.order_book('BTCEUR')
+order_book = hitbtc.order_book('BTCEUR', {format_amount_unit: "lot"})
+```
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| format_price | optional, "string" (default) or "number" | |
+| format_amount | optional, "string" (default) or "number" | |
+| format_amount_unit | optional, "currency" (default) or "lot" | |
+
+
+#### Trades
+
+```ruby
+trades = hitbtc.trades "BTCEUR" (default from 1 day ago, by timestamp, index 0, max_result 1000)
+trades = hitbtc.trades 'BTCEUR', (Time.now - 1.day).to_i, "ts", 0, 1000)
+trades = hitbtc.trades 'BTCEUR', (Time.now - 1.day).to_i, "ts", 0, 1000, {format_amount_unit: "lot"})
+```
+
+Parameters:
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| from | required, int, trade_id or timestamp | returns trades with trade_id > specified trade_id <br> returns trades with timestamp >= specified timestamp |
+| till | optional, int, trade_id or timestamp | returns trades with trade_id < specified trade_id <br> returns trades with timestamp < specified timestamp |
+| by | required, filter and sort by `trade_id` or `ts` (timestamp) | |
+| sort | optional, `asc` (default) or `desc` | |
+| start_index | required, int | zero-based |
+| max_results | required, int, max value = 1000 | |
+| format_item | optional, "array" (default) or "object" |  |
+| format_price | optional, "string" (default) or "number" | |
+| format_amount | optional, "string" (default) or "number" | |
+| format_amount_unit | optional, "currency" (default) or "lot" | |
+| format_tid | optional, "string" or "number" (default) | |
+| format_timestamp | optional, "millisecond" (default) or "second" | |
+| format_wrap | optional, "true" (default) or "false" | |
+
+
+### Private Data Methods
+
+#### Error codes
+
+RESTful Trading API can return the following errors:
+
+| HTTP code | Text | Description |
+| --- | --- | --- |
+| 403 | Invalid apikey | API key doesn't exist or API key is currently used on another endpoint (max last 15 min) |
+| 403 | Nonce has been used | nonce is not monotonous |
+| 403 | Nonce is not valid | too big number or not a number |
+| 403 | Wrong signature | |
+
+#### Execution reports
+
+The API uses `ExecutionReport` as an object that represents change of order status.
+
+The following fields are used in this object:
+
+| Field	| Description | Type / Enum | Required |
+| --- | --- | --- | --- |
+| orderId | Order ID on the Exchange | string | required |
+| clientOrderId | clientOrderId sent in NewOrder message | string | required |
+| execReportType | execution report type | `new` <br> `canceled` <br> `rejected` <br> `expired` <br> `trade` <br> `status` | required |
+| orderStatus | order status | `new` <br> `partiallyFilled` <br> `filled` <br> `canceled` <br> `rejected` <br> `expired` | required |
+| orderRejectReason | Relevant only for the orders in rejected state | `unknownSymbol` <br> `exchangeClosed` <br>`orderExceedsLimit` <br> `unknownOrder` <br> `duplicateOrder` <br> `unsupportedOrder` <br> `unknownAccount` <br> `other`| for rejects |
+| symbol | | string, e.g. `BTCUSD` | required |
+| side | | `buy` or `sell` | required |
+| timestamp | UTC timestamp in milliseconds | | |
+| price | | decimal | |
+| quantity | | integer | required |
+| type | | only `limit` orders are currently supported | required |
+| timeInForce | time in force | `GTC` - Good-Til-Canceled <br>`IOK` - Immediate-Or-Cancel<br>`FOK` - Fill-Or-Kill<br>`DAY` - day orders< | required |
+| tradeId | Trade ID on the exchange | | for trades |
+| lastQuantity | | integer | for trades |
+| lastPrice | | decimal | for trades |
+| leavesQuantity | | integer |  |
+| cumQuantity | | integer | |
+| averagePrice | | decimal, will be 0 if 'cumQuantity'=0 | |
+
+
+#### Balance
+
+```ruby
+all_balance = hitbtc.balance
+one_balance = hitbtc.balance("BTC")
+many_balances = hitbtc.balance(["BTC", "EUR"])
+```
+
+#### List of active orders
+
+```ruby
+all_active_orders = hitbtc.active_orders
+symbol_specific_orders = hitbtc.active_orders({symbols: "BTCEUR"})
+symbols_specific_orders = hitbtc.active_orders({symbols: "BTCEUR,BTCUSD"})
+```
+
+Parameters: 
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| symbols | string, comma-delimeted list of symbols, optional, default - all symbols | |
+
+
+#### Create Order
+
+price should be specified even for market execution (haven't tested on a real order yet)
+
+```ruby
+hitbtc.create_order({symbol: "BTCEUR", side: "buy", quantity: 1, type: "market", timeInForce: "GTC", price: 320.000})
+```
+
+Parameters: 
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| symbol | string, required | e.g. `BTCUSD` |
+| side | `buy` or `sell`, required | |
+| price | decimal, required | order price, required for limit orders |
+| quantity | int | order quantity in lots |
+| type | `limit` or `market` | order type |
+| timeInForce | `GTC` - Good-Til-Canceled <br>`IOK` - Immediate-Or-Cancel<br>`FOK` - Fill-Or-Kill<br>`DAY` - day | use `GTC` by default |
+
+
+
+#### Cancel Order
+
+You only need your order id  (haven't been tested on real order yet)
+
+```ruby
+hitbtc.cancel_order("1398804347")
+```
+
+#### Trades History
+
+```ruby
+default = hitbtc.trade_history
+custom = hitbtc.trade_history({by: "ts", start_index: 0, max_results: 10, symbols: "BTCEUR,BTCUSD"})
+```
+
+Parameters: 
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `by` | `trade_id` or `ts` (timestamp) | |
+| `start_index` | int, optional, default(0) | zero-based index |
+| `max_results` | int, required, <=1000 | |
+| `symbols` | string, comma-delimited | |
+| `sort` | `asc` (default) or `desc` | |
+| `from` | optional | start `trade_id` or `ts`, see `by` |
+| `till` | optional | end `trade_id` or `ts`, see `by` |
+
+
+#### Recent Orders
+
+```ruby
+default = hitbtc.recent_orders
+custom = hitbtc.trade_history({start_index: 0, max_results: 10, symbols: "BTCEUR,BTCUSD", statuses: "new,filled"})
+```
+
+Parameters: 
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `start_index` | int, optional, default(0) | zero-based index |
+| `max_results` | int, required, <=1000 | |
+| `symbols` | string, comma-delimited | |
+| `statuses` | string, comma-delimited, `new`, `partiallyFilled`, `filled`, `canceled`, `expired`, `rejected` | |
+

data/hitbtc.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hitbtc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hitbtc"
+  spec.version       = HitbtcRuby::VERSION
+  spec.authors       = ["Julien Hobeika"]
+  spec.email         = ["julien.hobeika@gmail.com"]
+  spec.description   = %q{"Wrapper for hitbtc Exchange API"}
+  spec.summary       = %q{"Wrapper for hitbtc Exchange API"}
+  spec.homepage      = "https://github.com/jhk753/hitbtc_ruby"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "hashie"
+  spec.add_dependency "addressable"
+end

data/key.yml.example

@@ -0,0 +1,2 @@
+key: apikey
+secret: apisecret

data/lib/hitbtc.rb

@@ -0,0 +1,2 @@
+require "hitbtc/version"
+require "hitbtc/client"

data/lib/hitbtc/client.rb

@@ -0,0 +1,240 @@
+require 'httparty'
+require 'hashie'
+require 'Base64'
+require 'addressable/uri'
+
+
+module Hitbtc
+  class Client
+    include HTTParty
+
+    def initialize(api_key=nil, api_secret=nil, options={})
+      @api_key      = api_key || YAML.load_file("key.yml")["key"]
+      @api_secret   = api_secret || YAML.load_file("key.yml")["secret"]
+      @api_version  = options[:version] ||= '1'
+      @base_uri     = options[:base_uri] ||= 'api.hitbtc.com'
+    end
+
+    ###########################
+    ###### Public Data ########
+    ###########################
+
+    def server_time
+      mash = get_public 'time'
+      mash.try(:timestamp)
+    end
+
+    def symbols(opts={}) #can specify array of string symbols
+      mash = get_public 'symbols'
+      m = mash.try(:symbols)
+      if (opts.length == 1 || opts.class == String) && m != mash
+        m.select{|h| opts.include?(h.symbol)}.first
+      elsif !opts.empty? && m != mash
+        m.select{|h| opts.include?(h.symbol)}
+      else
+        m
+      end
+    end
+
+    def ticker symbol
+      checked_symbol = check_symbol(symbol)
+      get_public(checked_symbol+"/ticker")
+    end
+
+    def order_book symbol, opts={}
+      checked_symbol = check_symbol(symbol)
+      #opts optional
+      #format_price: "string" (default) or "number"
+      #format_amount: "string" (default) or "number"
+      #format_amount_unit: "currency" (default) or "lot"
+      get_public(checked_symbol+"/orderbook", opts)
+    end
+
+    def trades symbol, from = (Time.now - 1.day).to_i, by = "ts", start_index = 0, max_results = 1000, opts={}
+      checked_symbol = check_symbol(symbol)
+      #Parameter                    Type                            Description
+      #from	required                int = trade_id or timestamp	    returns trades with trade_id > specified trade_id or returns trades with timestamp >= specified timestamp
+      #till	optional                int = trade_id or timestamp	    returns trades with trade_id < specified trade_id or returns trades with timestamp < specified timestamp
+      #by	required                  filter and sort by trade_id or ts (timestamp)
+      #sort	optional                asc (default) or desc
+      #start_index required         int	zero-based
+      #max_results required         int, max value = 1000
+      #format_item optional         "array" (default) or "object"
+      #format_price	optional        "string" (default) or "number"
+      #format_amount optional       "string" (default) or "number"
+      #format_amount_unit optional  "currency" (default) or "lot"
+      #format_tid	optional          "string" or "number" (default)
+      #format_timestamp	optional    "millisecond" (default) or "second"
+      #format_wrap optional         "true" (default) or "false"
+      if by != "trade_id" && by != "ts"
+        raise "3rd parameter by, should be 'trade_id' or 'ts'"
+      end
+      opts[:from] = from
+      opts[:start_index] = start_index
+      opts[:max_results] = max_results
+      opts[:by] = by
+      mash= get_public(checked_symbol+'/trades', opts)
+      mash.try(:trades)
+    end
+
+    def get_public(method, opts={})
+      url = 'http://'+ @base_uri + '/api/' + @api_version + '/public/' + method
+      r = self.class.get(url, query: opts)
+      Hashie::Mash.new(JSON.parse(r.body))
+    end
+
+    ######################
+    ##### Private Data ###
+    ######################
+
+    def balance opts={} #array of string currency
+      mash = get_private 'balance'
+      m = mash.try(:balance)
+      if opts.class == String
+        o = []
+        o << opts
+        opts = o
+      end
+      if m != mash && opts.length > 0
+        r= m.select{|c| opts.include?(c.currency_code)}
+        (r.length==1 ? r.first : r)
+      else
+        m
+      end
+    end
+
+    def active_orders opts={} #symbols: string comma-delimeted list of symbols, optional, default - all symbols
+      #example {:symbols=> "BTCEUR,BTCUSD"}
+      mash = get_private 'orders/active', opts
+      mash.try(:orders)
+    end
+
+    def cancel_order client_order_id
+      orders = active_orders
+      order = orders.select{|o| o.orderId == client_order_id}.try(:first)
+      if order.nil?
+        "We didn't find the order for the specified ID"
+      else
+        opts = {}
+        opts[:clientOrderId] = order.orderId
+        opts[:cancelRequestClientOrderId] = Time.now.to_i.to_s
+        opts[:symbol] = order.symbol
+        opts[:side] = order.side
+        opts[:price] = order.orderPrice
+        opts[:quantity] = order.orderQuantity
+        opts[:type] = order.limit
+        opts[:timeInForce] = order.timeInForce
+
+        get_private 'cancel_order', opts
+      end
+    end
+
+    def trade_history opts={by:"ts", start_index: 0, max_results: 10}
+      mash= get_private 'trades', opts
+      mash.try(:trades)
+    end
+
+    def recent_orders opts={max_results: 10, start_index: 0, statuses: "new,partiallyFilled,filled,canceled,expired,rejected"}
+      mash = get_private 'orders/recent', opts
+      mash.try(:orders)
+    end
+
+    #### Private User Trading (Still experimental!) ####
+    def create_order opts={}
+      opts[:clientOrderId] = Time.now.to_i.to_s
+      post_private 'new_order', opts
+    end
+    ######################
+    ##### Payment Data ###
+    ######################
+
+    # to be written
+
+    #######################
+    #### Generate Signed ##
+    ##### Post Request ####
+    #######################
+
+    private
+
+    def post_private(method, opts={})
+      post_data = encode_options(opts)
+      uri = "/api/"+ @api_version + "/trading/" + method +"?" + "apikey=" + @api_key + "&nonce=" + nonce
+      url = "https://" + @base_uri + uri
+      signature = generate_signature(uri, post_data)
+      headers = {'X-Signature' => signature}
+      r = self.class.post(url, {headers: headers, body: post_data}).parsed_response
+      Hashie::Mash.new(r)
+    end
+
+    def get_private(method, opts={})
+      opts = complete_opts(opts)
+      uri = "/api/"+ @api_version + "/trading/" + method +"?" + encode_options(opts)
+      url = "https://" + @base_uri + uri
+      signature = generate_signature(uri, "")
+      headers = {'X-Signature' => signature}
+
+
+
+      r = self.class.get(url, {headers: headers})
+      mash = Hashie::Mash.new(JSON.parse(r.body))
+    end
+
+    def complete_opts opts
+      opts[:apikey] = @api_key
+      opts[:nonce] = nonce
+      opts
+    end
+
+    def nonce
+      Time.now.to_i.to_s
+    end
+
+    def encode_options(opts)
+      uri = Addressable::URI.new
+      uri.query_values = opts
+      uri.query
+    end
+
+    def generate_signature(uri, post_data)
+      message = generate_message(uri, post_data)
+      generate_hmac(@api_secret, message)
+    end
+
+    def generate_message(uri, data)
+        uri + data
+    end
+
+    def generate_hmac(key, message)
+      OpenSSL::HMAC.hexdigest('SHA512', key, message).downcase
+    end
+
+    def check_symbol symbol
+      if symbol.length != 6 || symbol.class != String
+        raise "You didn't enter a correct symbol, check symbols method to see list and enter symbol as a string"
+      end
+      symbol.upcase
+    end
+
+    def random_string
+
+    end
+
+    ##################################
+    ##### Realtime with web socket ###
+    ##################################
+
+    # to be written
+
+  end
+end
+
+class Hashie::Mash
+    def try key
+       if self.key?(key.to_s)
+         self[key]
+       else
+         self
+       end
+    end
+end

data/lib/hitbtc/version.rb

@@ -0,0 +1,3 @@
+module HitbtcRuby
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: hitbtc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Julien Hobeika
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: '"Wrapper for hitbtc Exchange API"'
+email:
+- julien.hobeika@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- hitbtc.gemspec
+- key.yml.example
+- lib/hitbtc.rb
+- lib/hitbtc/client.rb
+- lib/hitbtc/version.rb
+homepage: https://github.com/jhk753/hitbtc_ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: '"Wrapper for hitbtc Exchange API"'
+test_files: []