okex 0.2.6 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 012c9b50e5c4dd3fb5522d0eef07764feb177c23a2aee07e1a847399fb7b7d68
-  data.tar.gz: 43f87e76c36c65bf9b81122392b36af8bee0f5125617b28ff2a6e2ae6a36196a
+  metadata.gz: 30adc1b436dc4b0e5d299b64567da2e425c83d8b631c8e73d5c5cf116e3d45aa
+  data.tar.gz: 756dd71409995a737c20a5acf06b9c4478b1e91735ef1ab34345a8b3aef9051f
 SHA512:
-  metadata.gz: 84533cb2cc12b733a01c29a3f76274e1b179573fa0ad21e2588c87b04e76e9afdca18979c22056b4fa4c75fbec578e7fbb319e198721bedb9150e39e4f819f2a
-  data.tar.gz: 839673d67fed38b99dce0b5d5f31df562e56d9617c5e7c87cad1772136b616c60d457d6d9397427372bb0b6fd4168c9b035a8d74fb50b972c9bfc68e48defbce
+  metadata.gz: aae50477ae52399c19a0f14944a97e8d08182e196e34c436ebbb03c344807acf144e433834ce5894e4d0b36e7e9dba9f396d67ff40ae01c0741427d9e3442c47
+  data.tar.gz: 307e1223e5e804412cb7d4ec770edebcee1ba25b65bd46e38b5bd92fc6a95729a22cd39dec8eae1034d91b748482ea834107d8f3a766178f97bafc8155fc56a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    okex (0.2.5)
+    okex (0.3.1)
       faraday (~> 1.5)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     byebug (11.1.3)
     diff-lcs (1.4.4)
-    faraday (1.5.0)
+    faraday (1.5.1)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -24,7 +24,7 @@ GEM
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
     faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
+    faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     multipart-post (2.1.1)
     rake (10.5.0)
@@ -41,7 +41,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,6 @@
 # okex
 
-This is the V3 API ruby lib for okex.com
+This is the V5 API ruby lib for okex.com
 
 ## Installation
 
@@ -20,6 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
+Set `OKEX_DEBUG` environment flag to 1 to print debug messages.
 
 ## Development
 

data/lib/okex.rb

@@ -2,11 +2,14 @@ require "okex/version"
 require "okex/api_v3"
 require "okex/api_v5"
 require "okex/client"
-require "okex/coin"
+require "okex/coin/bitcoin"
+require "okex/coin/usdt"
 require "okex/order"
-require "okex/account_order"
-require "okex/trade_order"
 require "okex/host"
+require "okex/max_size"
+require "okex/api_error"
+require "okex/balance"
+
 
 
 module OKEX

data/lib/okex/api_error.rb

@@ -0,0 +1,13 @@
+module OKEX
+  class ApiError < StandardError
+    def initialize(code, data, msg)
+      @code = code
+      @data = data
+      @msg = msg
+    end
+
+    def to_s
+      "code=#{@code}, data=#{@data}, msg=#{@msg}"
+    end
+  end
+end

data/lib/okex/api_v5.rb

@@ -8,24 +8,42 @@ class OKEX::ApiV5
     client.get(host, "/api/v5/public/instruments?instType=SWAP")
   end
 
-  def account_orders
-    resp = client.get(host, "/api/v5/account/positions")
-    
-    if resp['success']
-      return resp['data'].map {|params| OKEX::AccountOrder.new(params)}
+  def orders(inst_id=nil)
+    url = "/api/v5/account/positions"
+    if inst_id.present?
+      url += "?instId=#{inst_id}"
     end
 
-    []
+    data = client.get(host, url)
+
+    data.map {|params| OKEX::Order.new(params)}
   end
 
-  def trade_orders(instrument_id)
-    resp = client.get(host, "/api/v5/trade/order?instId=#{instrument_id}")
-    
-    if resp['code'].to_i == 0 && resp['data'].size > 0
-      return resp['data'].map {|params| OKEX::TradeOrder.new(params)}
-    end
+  def balance(ccy, round)
+    data = client.get(host, "/api/v5/account/balance?ccy=#{ccy}")
+
+    details = data[0]['details'][0]
+
+    OKEX::Balance.new(
+      details['ccy'],
+      dig_round(details, 'cashBal', round),
+      dig_round(details, 'avalEq', round),
+      dig_round(details, 'frozenBal', round),
+      dig_round(details, 'upl', round)
+    )
+  end
 
-    []
+  def long_swap(instid, amount)
+    params = {
+      "instId": instid,
+      "tdMode": "cross",
+      "side": "buy",
+      "posSide": "long",
+      "ordType": "market",
+      "sz": amount.to_s,
+    }
+
+    client.post(host, "/api/v5/trade/order", params)
   end
 
   def short_swap(instid, amount)
@@ -35,12 +53,28 @@ class OKEX::ApiV5
       "side": "sell",
       "posSide": "short",
       "ordType": "market",
-      "sz": "1"
+      "sz": amount.to_s,
     }
 
     client.post(host, "/api/v5/trade/order", params)
   end
 
+  # # 开多带止损
+  # def long_swap_stop(instid, amount, stop_price)
+  #   params = {
+  #     "instId": instid,
+  #     "tdMode": "cross",
+  #     "side": "buy",
+  #     "posSide": "long",
+  #     "ordType": "conditional",
+  #     "sz": amount.to_s,
+  #     "slTriggerPx": stop_price.to_s,
+  #     "slOrdPx": "-1", # 执行市价止损
+  #   }
+
+  #   client.post(host, "/api/v5/trade/order-algo", params)
+  # end
+
   def close_long(instrument_id)
     close_position(instrument_id, "long")
   end
@@ -49,6 +83,25 @@ class OKEX::ApiV5
     close_position(instrument_id, "short")
   end
 
+  def max_size(instrument_id)
+    data = client.get(host, "/api/v5/account/max-size?instId=#{instrument_id}&tdMode=cross")
+    
+    ret = OKEX::MaxSize.new(-1, -1)
+
+    el = data[0]
+    if el.present? && el['maxBuy'].to_i > 0 && el['maxSell'].to_i > 0
+      ret = OKEX::MaxSize.new(el['maxBuy'].to_i, el['maxSell'].to_i)
+    end
+
+    ret
+  end
+
+  def current_leverage(inst_id)
+    data = client.get(host, "/api/v5/account/leverage-info?instId=#{inst_id}&mgnMode=cross")
+
+    data[0]['lever'].to_i
+  end
+
   private
 
   attr_reader :client, :host
@@ -62,4 +115,8 @@ class OKEX::ApiV5
 
     client.post(host, "/api/v5/trade/close-position", params)
   end
+
+  def dig_round(obj, key, round)
+    obj[key].to_f.round(round)
+  end
 end

data/lib/okex/balance.rb

@@ -0,0 +1,2 @@
+class OKEX::Balance < Struct.new(:currency, :total, :available, :frozen, :upl)
+end

data/lib/okex/client.rb

@@ -12,19 +12,27 @@ module OKEX
     end
 
     def get(host, path)
+      url = host + path
       ts = timestamp
       sig = sign(ts, "GET", path)
+      _h = headers(ts, sig)
 
-      _resp(Faraday.get(host + path, nil, headers(ts, sig)))
+      puts "---> GET: url=#{url}, headers=#{_h}" if ENV['OKEX_DEBUG'].to_i > 0
+
+      _resp(Faraday.get(url, nil, _h))
     end
 
     def post(host, path, payload)
       payload_json = gen_payload(payload)
 
+      url = host + path
       ts = timestamp
       sig = sign(ts, "POST", path + payload_json)
+      _h = headers(ts, sig)
+
+      puts "---> POST: url=#{url}, payload=#{payload_json}, headers=#{_h}" if ENV['OKEX_DEBUG'].to_i > 0
 
-      _resp(Faraday.post(host + path, payload_json, headers(ts, sig)))
+      _resp(Faraday.post(url, payload_json, _h))
     end
 
     private
@@ -64,10 +72,10 @@ module OKEX
       
       code = result['code'].to_i
       if code == 0 && result['msg'].empty?
-        return {'success' => true, 'data' => result['data']}
-      else
-        return {'success' => false, 'code' => code, 'msg' => result['msg']}
+        return result['data']
       end
+
+      raise OKEX::ApiError.new(code, result['data'], result['msg'])
     end
   end
 end

data/lib/okex/coin/usdt.rb

@@ -0,0 +1,11 @@
+module OKEX
+  module Coin
+    class USDT
+      CODE = "USDT".freeze
+
+      def self.code
+        CODE
+      end
+    end
+  end
+end

data/lib/okex/max_size.rb

@@ -0,0 +1,2 @@
+class OKEX::MaxSize < Struct.new(:buy, :sell)
+end

data/lib/okex/order.rb

@@ -7,7 +7,8 @@ module OKEX
       @params = params
     end
 
-    def instrument_id
+    # 合约名称，例如 BTC-USDT-SWAP
+    def inst_id
       dig("instId")
     end
     
@@ -71,6 +72,16 @@ module OKEX
       dig("pos").to_i
     end
 
+    # 是否正在持仓
+    def open?
+      pos > 0
+    end
+
+    # 已经平仓
+    def closed?
+      pos == 0
+    end
+
     private
 
     def dig(key)

data/lib/okex/version.rb

@@ -1,3 +1,3 @@
 module OKEX
-  VERSION = "0.2.6"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okex
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.2
 platform: ruby
 authors:
 - David Zhang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,15 +99,17 @@ files:
 - bin/console
 - bin/setup
 - lib/okex.rb
-- lib/okex/account_order.rb
+- lib/okex/api_error.rb
 - lib/okex/api_v3.rb
 - lib/okex/api_v5.rb
+- lib/okex/balance.rb
 - lib/okex/client.rb
 - lib/okex/coin.rb
 - lib/okex/coin/bitcoin.rb
+- lib/okex/coin/usdt.rb
 - lib/okex/host.rb
+- lib/okex/max_size.rb
 - lib/okex/order.rb
-- lib/okex/trade_order.rb
 - lib/okex/version.rb
 - okex.gemspec
 homepage: https://github.com/daqing/okex

data/lib/okex/account_order.rb

@@ -1,4 +0,0 @@
-module OKEX
-  class AccountOrder < Order
-  end
-end

data/lib/okex/trade_order.rb

@@ -1,24 +0,0 @@
-module OKEX
-  class TradeOrder < Order
-
-    # 预估强平价
-    def est_liq_price
-      dig("liqPx").to_f
-    end
-
-    # 最新成交价
-    def last_price
-      dig("fillPx").to_f
-    end
-
-    # 未实现收益
-    def upl
-      dig("pnl").to_f
-    end
-
-    # 持仓张数
-    def pos
-      dig("sz").to_i
-    end
-  end
-end