okcoin-ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fde5fbf15d7d1456c2e71b7c082d50027e61b2d
-  data.tar.gz: e3df5c33d806fe76fe3bb2342160e14f28d83dfb
+  metadata.gz: 830387957a835f4427a3c83b5b9a51b540147328
+  data.tar.gz: 7716a827c6d2fa7d61ac8ad47cd9a9a1028d6cb4
 SHA512:
-  metadata.gz: acf2b40dbf2faf83ebabd4aaf3a67735e19087dff98323373288b5fb0248b8dc2dd0c5dcb0443b256a87863c1f30fcf972f42f2ef4c9f3a6949de8225d724155
-  data.tar.gz: e1439a1322dbc48dbc6395a779186aa6f6f55c28525f76c5156a90a62de929d7894230f422ba7e0cf722ea837dd0ebb865c9174ca6329ab591e436182937f365
+  metadata.gz: 07fbdae8dfb02cea01f431ce8f115cda92e5a445abb847eaa166ef5790f8fdf139d80cac712f5691d7fccd7ed9927580950171db6b41ce4d9d3f4c9b84982f5f
+  data.tar.gz: cccbd09133e4ccc261f76bb6abf459db736062540b5aa0050574b57414606c61cf48df42fcd869bee316aebb54d70d2eeb97579296f61a98b6d5a147e3bbf6fb

data/README.md

@@ -1,5 +1,11 @@
 # Okcoin API Ruby Wrapper
-Supports REST and Websocket protocols
+Unofficial ruby library for Okcoin Bitcoin Exchange
+
+If you feel it's helpful and would like to donate, send coins to
+
+```
+BTC 15y2a3FKLW89qoDniDMRwsdhrZeHJA1Det
+```
 
 ## Installation
 
@@ -17,15 +23,45 @@ And then execute:
 ## Usage
 
 ### 1. REST Example
-```
+Initialize client
+```ruby
 okcoin = Okcoin::Rest.new api_key: ENV['OKCOIN_APIKEY'], secret_key: ENV['OKCOIN_SECRET']
-puts okcoin.userinfo
-puts okcoin.orderbook(pair: "btcusd", items_no: 50)
 ```
 
-### 2. WebSocket Example
+Make requests
 
+Spot Price
+```ruby
+okcoin.spot_ticker(pair: "btc_usd")
+okcoin.spot_orderbook(pair: "btc_usd", items_no: 50, merge: 0)
+okcoin.spot_trades(pair: "btc_usd", since: nil)
+okcoin.spot_kandlestick(pair: "btc_usd", type: "30min", size: 50, since: nil)
+okcoin.spot_swaps_orderbook(pair: "btc_usd")
+```
+
+Spot Trade
+```ruby
+okcoin.spot_userinfo
+okcoin.spot_trade(pair: "btc_usd", type: "buy", price:240, amount:1)
 ```
+
+Futures Price
+```ruby
+okcoin.futures_orderbook(pair: "btc_usd", contract: "this_week", items_no: 50)
+```
+
+Futures Trade
+```ruby
+okcoin.futures_userinfo
+okcoin.futures_trade(pair: "btc_usd", amount: 1, type: 1, contract_type: "this_week", match_price: 1, price: nil, lever_rate: 10)
+okcoin.futures_cancel(pair: "btc_usd", contract_type: "this_week", order_id: 12345)
+okcoin.futures_order_info(order_id: 12345, symbol: "btc_usd", contract_type: "this_week", status: nil, current_page: nil, page_length: nil)
+okcoin.futures_position(pair: "btc_usd", contract_type: "this_week")
+```
+
+### 2. WebSocket Example
+
+```ruby
   okcoin = Okcoin::WS.new api_key: ENV['OKCOIN_APIKEY'], secret_key: ENV['OKCOIN_SECRET']
   okcoin.userinfo
   okcoin.pingpong

data/lib/okcoin/rest.rb

@@ -9,28 +9,63 @@ class Okcoin
     end
 
     public
+      # Spot Price API
+      def spot_ticker(pair: "btc_usd")
+        query = { "symbol" => pair }
+        get_request(url: "/v1/ticker.do", query: query)
+      end
 
-      def orderbook(pair:, items_no: 50)
-        query = { "ok" => 1, "symbol" => pair, "size" => items_no }
-        get_request(url: "/depth.do", query: query)
+      def spot_orderbook(pair: "btc_usd", items_no: 50, merge: 0)
+        query = { "symbol" => pair, "size" => items_no, "merge" => merge }
+        get_request(url: "/v1/depth.do", query: query)
       end
 
-      def futures_userinfo
+      def spot_trades(pair: "btc_usd", since: nil)
+        query = { "symbol" => pair, "since" => since }
+        get_request(url: "/v1/trades.do", query: query)
+      end
+
+      def spot_kandlestick(pair: "btc_usd", type: "30min", size: 50, since: nil)
+        query = { "symbol" => pair, "type" => type, "size" => size, "since" => since }
+        get_request(url: "/v1/kline.do", query: query)
+      end
+
+      def spot_swaps_orderbook(pair: "btc_usd")
+        query = { "symbol" => pair }
+        get_request(url: "/v1/lend_depth.do", query: query)
+      end
+
+      # Spot Trading API
+
+      def spot_userinfo
         post_data = initial_post_data
-        post_request post_data: post_data, action: "/v1/future_userinfo.do"
+        post_request post_data: post_data, action: "/v1/userinfo.do"
       end
 
-      def equity
+      def spot_trade(pair:, type:, price:, amount:)
         post_data = initial_post_data
-        post_request(post_data: post_data, action: "/v1/future_userinfo.do")["info"]["btc"]["account_rights"]
+        
+        post_data["symbol"] = pair
+        post_data["type"] = type
+        post_data["amount"] = amount
+        post_data["price"] = price
+
+        post_request post_data: post_data, action: "/v1/trade.do"
       end
 
+      # Futures Price API
       def futures_orderbook(pair:, contract:, items_no: 50)
         query = { "symbol" => pair, "contractType" => contract, "size" => items_no }
         get_request(url: "/future_depth.do", query: query)
       end
 
-      def trade_futures(pair:, amount:, type:, contract_type:, match_price:, price: nil, lever_rate: 10)
+      # Futures Trading API
+      def futures_userinfo
+        post_data = initial_post_data
+        post_request post_data: post_data, action: "/v1/future_userinfo.do"
+      end
+
+      def futures_trade(pair:, amount:, type:, contract_type:, match_price:, price: nil, lever_rate: 10)
         post_data = initial_post_data
         
         post_data["symbol"] = pair
@@ -45,7 +80,7 @@ class Okcoin
         post_request post_data: post_data, action: "/v1/future_trade.do"
       end
 
-      def future_cancel(pair:, contract_type:, order_id:)
+      def futures_cancel(pair:, contract_type:, order_id:)
         post_data = initial_post_data
 
         post_data["symbol"] = pair
@@ -55,13 +90,16 @@ class Okcoin
         post_request post_data: post_data, action: "/v1/future_cancel.do"
       end
 
-      def futures_orders_info(order_id:, symbol:, contract_type:)
+      def futures_order_info(order_id:, symbol:, contract_type:, status: nil, current_page: nil, page_length: nil)
         post_data = initial_post_data
         post_data["symbol"] = symbol
         post_data["contract_type"] = contract_type
         post_data["order_id"] = order_id
+        post_data["status"] = status
+        post_data["current_page"] = current_page
+        post_data["page_length"] = page_length
 
-        post_request post_data: post_data, action: "/v1/future_orders_info.do"
+        post_request post_data: post_data, action: "/v1/future_order_info.do"
       end
 
       def futures_position(pair:, contract_type:)
@@ -71,12 +109,6 @@ class Okcoin
         post_request post_data: post_data, action: "/v1/future_position.do"
       end
 
-
-      def userinfo
-        post_data = initial_post_data
-        post_request post_data: post_data, action: "/v1/userinfo.do"
-      end
-
     private 
 
       def handle_timeouts

data/lib/okcoin/version.rb

@@ -1,3 +1,3 @@
 class Okcoin
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okcoin-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ilya Cherevkov