gemini-rb 0.0.1

data/lib/gemini/v1/positions.rb

@@ -0,0 +1,27 @@
+module Gemini
+  module V1::PositionsClient
+
+    # View your active positions.
+    #
+    # @return [Array]
+    # @example:
+    #   client.positions
+    def positions
+      authenticated_post("positions").body
+    end
+
+    # A position can be claimed if:
+    #
+    # It is a long position: The amount in the last unit of the position pair that you have in your trading wallet AND/OR the realized profit of the position is greater or equal to the purchase amount of the position (base price * position amount) and the funds which need to be returned. For example, for a long BTCUSD position, you can claim the position if the amount of USD you have in the trading wallet is greater than the base price * the position amount and the funds used.
+    #
+    # It is a short position: The amount in the first unit of the position pair that you have in your trading wallet is greater or equal to the amount of the position and the margin funding used.
+    # @param position_id [int] The position ID given by `/positions`
+    # @param amount [decimal] The partial amount you wish to claim
+    # @return [Hash]
+    # @example:
+    #    client.claim_position(100,10)
+    def claim_position(position_id, amount)
+      authenticated_post("position/claim", params: {position_id: position_id, amount: amount}).body
+    end
+  end
+end

data/lib/gemini/v1/stats.rb

@@ -0,0 +1,15 @@
+module Gemini
+  module V1::StatsClient
+
+    # Various statistics about the requested pair.
+    #
+    # @param symbol [string] Symbol of the pair you want info about. Default 'btcusd'
+    # @return [Array]
+    # @example:
+    #   client.stats('btcusd')
+    def stats(symbol = "btcusd")
+      get("stats/#{symbol}").body
+    end
+
+  end
+end

data/lib/gemini/v1/symbols.rb

@@ -0,0 +1,22 @@
+module Gemini
+  module V1::SymbolsClient
+
+    # Get a list of valid symbol IDs.
+    #
+    # @return [Array]
+    # @example:
+    # client.symbols
+    def symbols
+      get("symbols").body
+    end
+
+    # Get detailed list of symbols
+    #
+    # @return [Array]
+    # @example:
+    # client.symbols_details
+    def symbols_details
+      get("symbols_details").body
+    end
+  end
+end

data/lib/gemini/v1/ticker.rb

@@ -0,0 +1,27 @@
+module Gemini
+  module V1::TickerClient
+
+    # Gives innermost bid and asks and information on the most recent trade, as well as high, low and volume of the last 24 hours.
+    #
+    # @param symbol [string] The name of hthe symbol
+    # @return [Hash]
+    # @example:
+    #   client.ticker
+    def ticker(symbol = "btcusd")
+      get("pubticker/#{symbol}").body
+    end
+
+    # Call the specified block passing tickers, it uses websocket
+    #
+    # @param pair [string]
+    # @param block [Block] The code to be executed when a new ticker is sent by the server
+    # @example:
+    #   client.listen_ticker do |tick|
+    #     puts tick.inspect
+    #   end
+    def listen_ticker(pair="BTCUSD", &block)
+      raise BlockMissingError unless block_given?
+      register_channel pair: pair, channel: "ticker", &block
+    end
+  end
+end

data/lib/gemini/v1/trades.rb

@@ -0,0 +1,31 @@
+module Gemini
+  module V1::TradesClient
+
+    # Get a list of the most recent trades for the given symbol.
+    #
+    # @param symbol [string] the name of the symbol
+    # @param params :timestamp [time] Only show trades at or after this timestamp.
+    # @param params :limit_trades [int] Limit the number of trades returned. Must be >= 1.
+    # @return [Array]
+    # @example:
+    #   client.trades
+    def trades(symbol="btcusd", params={})
+      check_params(params, %i{timestamp limit_trades})
+      get("trades/#{symbol}", params).body
+    end
+
+    # Listen to the trades using websocket.
+    #
+    # @param pair [string]
+    # @param block [Block] The code to be executed when a new trade is executed
+    # @example:
+    #   client.listen_trades do |trade|
+    #     puts trade.inspect
+    #   end
+    def listen_trades(pair="BTCUSD", &block)
+      raise BlockMissingError unless block_given?
+      register_channel pair:pair, channel: 'trades', &block
+    end
+
+  end
+end

data/lib/gemini/v1/wallet.rb

@@ -0,0 +1,98 @@
+module Gemini
+  module V1::WalletClient
+
+    # See your balances.
+    #
+    # @param params :type [string] “trading”, “deposit” or “exchange”.
+    # @param params :currency [string] currency
+    # @param params :amount [decimal] How much balance of this currency in this wallet
+    # @param params :available [decimal] How much X there is in this wallet that is available to trade
+    # @return [Array]
+    # @example:
+    #   client.balances
+    def balances(params = {})
+      check_params(params, %i{type currency amount available})
+      authenticated_post("balances", params: params).body
+    end
+
+    # See your trading wallet information for margin trading.
+    #
+    # @return [Array]
+    # @example:
+    #   client.margin_infos
+    def margin_infos
+      authenticated_post("margin_infos").body
+    end
+
+    # See a symmary of your trade volume, funding profits etc.
+    #
+    # @return [Hash]
+    # @example:
+    #    client.summary
+    def summary
+      authenticated_post("summary").body
+    end
+
+    # Allow you to move available balances between your wallets.
+    #
+    # @param amount [decimal] Amount to transfer
+    # @param currency [string] Currency of funds to transfer
+    # @param wallet_from [string] Wallet to transfer from
+    # @param wallet_to [string] Wallet to transfer to
+    # @return [Array]
+    # @example:
+    #   client.transfer(10, 'btc', "exchange", "deposit")
+    def transfer(amount, currency, wallet_from, wallet_to)
+      params = {
+        amount: amount.to_s,
+        currency: currency.upcase,
+        walletfrom: wallet_from.downcase,
+        walletto: wallet_to.downcase
+      }
+      authenticated_post("transfer", params: params).body
+    end
+
+    # Allow you to request a withdrawal from one of your wallet.
+    #
+    # @param withdraw_type [string] can be “bitcoin”, “litecoin” or “darkcoin” or “tether” or “wire”
+    # @param walletselected [string] The wallet to withdraw from, can be “trading”, “exchange”, or “deposit”.
+    # @param amount [decimal] Amount to withdraw
+    # For Cryptocurrencies (including tether):
+    # @param params :address [string] Destination address for withdrawal
+    # For wire withdrawals
+    # @param params :account_name [string] account name
+    # @param params :account_number [string] account number
+    # @param params :bank_name [string] bank name
+    # @param params :bank_address [string] bank address
+    # @param params :bank_city [string] bank city
+    # @param params :bank_country [string] bank country
+    # @param params :detail_payment [string] (optional) message to beneficiary
+    # @param params :intermediary_bank_name [string] (optional) intermediary bank name
+    # @param params :intermediary_bank_address [string] (optional) intermediary bank address
+    # @param params :intermediary_bank_city [string] (optional) intermediary bank city
+    # @param params :intermediary_bank_country [string] (optional) intermediary bank country
+    # @param params :intermediary_bank_account [string] (optional) intermediary bank account
+    # @param params :intermediary_bank_swift [string] (optional) intemediary bank swift
+    # @param params :expressWire [int] (optional). “1” to submit an express wire withdrawal, “0” or omit for a normal withdrawal
+    # @return [Array]
+    # @example:
+    #   client.withdraw("bitcoin","deposit",1000, address: "1DKwqRhDmVyHJDL4FUYpDmQMYA3Rsxtvur")
+    def withdraw(withdraw_type, walletselected, amount, params={})
+      params.merge!({
+        withdraw_type: withdraw_type,
+        walletselected: walletselected.downcase,
+        amount: amount.to_s})
+
+      authenticated_post("withdraw", params: params).body
+    end
+
+    # Check the permissions of the key being used to generate this request
+    #
+    # @return [Hash]
+    # @example:
+    #   client.key_info
+    def key_info
+      authenticated_post("key_info").body
+    end
+  end
+end

data/lib/gemini/v2/margin.rb

@@ -0,0 +1,34 @@
+module Gemini
+  module V2::MarginClient
+
+    # Get active offers
+    #
+    # @example:
+    #    client.offers
+    def offers
+      authenticated_post("auth/r/offers").body
+    end
+
+    # Get account margin info
+    # - if symbol is not specified return everything
+    #
+    # @param symbol [string] (optional)
+    #
+    # @example:
+    #   client.margin_info("tBTCUSD")
+    def margin_info(symbol = "base")
+      authenticated_post("auth/r/margin/#{symbol}").body
+    end
+
+
+    # Get account funding info
+    #
+    # @param symbol [string] default fUSD
+    #
+    # @example:
+    #   client.funding_info
+    def funding_info(symbol = "fUSD")
+      authenticated_post("auth/r/funding/#{symbol}").body
+    end
+  end
+end

data/lib/gemini/v2/personal.rb

@@ -0,0 +1,94 @@
+module Gemini
+  module V2::PersonalClient
+
+    # Get account wallets
+    #
+    # @example:
+    #   client.wallets
+    def wallets
+      authenticated_post("auth/r/wallets").body
+    end
+
+    # Get account historical daily performance
+    #
+    # @example:
+    #   client.performance
+    def performance
+      authenticated_post("auth/r/stats/perf:1D/hist")
+    end
+
+    # Get the list of alerts
+    #
+    # @example:
+    #   client.alerts
+    def alerts(type = 'price')
+      authenticated_post("auth/r/alerts", params: {type: type}).body
+    end
+
+    # Set a new alert
+    #
+    # @param price
+    # @param symbol
+    # @param type
+    #
+    # @example:
+    #   client.alert(3000, "tBTCUSD")
+    def alert(price, symbol = "tBTCUSD", type = "price")
+      params = {
+        type: type,
+        price: price,
+        symbol: symbol
+      }
+      authenticated_post("auth/w/alert/set", params: params).body
+    end
+
+    # Delete an existing alert
+    #
+    # @param price
+    # @param symbol
+    #
+    # @example:
+    #   client.delete_alert(3000, "tBTCUSD")
+    def delete_alert(price, symbol = "tBTCUSD")
+      authenticated_post("auth/w/alert/price:#{symbol}:#{price}/del").body
+    end
+
+
+    # Calculate available balance for order/offer
+    #
+    # @param rate [int] Rate of the order/offer
+    # @param dir [int] direction of the order/offer
+    #         (orders: > 0 buy, < 0 sell | offers:
+    #             > 0 sell, < 0 buy)
+    # @param type [string] Type of the order/offer
+    #         EXCHANGE or MARGIN
+    # @param symbol [string]
+
+    # @example:
+    #   client.available_balance(800, 1, 'EXCHANGE', 'tBTCUSD')
+    def available_balance(rate, dir, type, symbol)
+      params = {
+        symbol: symbol,
+        dir: dir,
+        type: type,
+        rate: rate
+      }
+      authenticated_post("auth/calc/order/avail", params: params).body
+    end
+
+    # Listen to authenticated channel
+    #
+    # Documentation:
+    #    https://docs.gemini.com/v2/reference#account-info
+    #
+    # example:
+    #   client.listen_account do |account|
+    #     puts account
+    #   end
+    def listen_account(&block)
+      raise BlockMissingError unless block_given?
+      ws_auth(&block)
+    end
+
+  end
+end

data/lib/gemini/v2/stats.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module Gemini
+  module V2::StatsClient
+
+    # Various statistics about the requested pair.
+    #
+    # @param symbol [string] The symbol you want information about.
+    # @param key [string] Allowed values: "funding.size",
+    #     "credits.size", "credits.size.sym", "pos.size"
+    # @param side [string] Available values: "long", "short"
+    # @param section [string] Available values: "last", "hist"
+    # @param size [string] Available values: '1m'
+    # @param params :sort [int32] if = 1 it sorts results
+    #     returned with old > new
+    #
+    # @return [Array]
+    #
+    # @example:
+    #   client.stats('fUSD', 'pos.size')
+    def stats(symbol = 'fUSD', key = 'funding.size', side = "long", section = "last", size = '1m', params = {})
+      check_params(params, %i{sort})
+      get("stats1/#{key}:#{size}:#{symbol}:#{side}/#{section}").body
+    end
+
+  end
+end

data/lib/gemini/v2/ticker.rb

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+module Gemini
+  module V2::TickerClient
+
+    # Gives innermost bid and asks and information on
+    # the most recent trade, as well as high, low and
+    # volume of the last 24 hours.
+    #
+    # @param symbols a list of symbols
+    # @return [Hash]
+    # @example:
+    #   client.ticker("tBTCUSD","tLTCUSD","fUSD")
+    def ticker(*symbols)
+      if symbols.size == 1
+        get("ticker/#{symbols.first}").body
+      else
+        get("tickers", symbols: "#{symbols.flatten.join(",")}").body
+      end
+    end
+
+    # Call the specified block passing tickers, it uses websocket
+    #
+    # @param pair [string]
+    # @param block [Block] The code to be executed when a new ticker is sent by the server
+    #
+    # Documentation:
+    #    https://docs.gemini.com/v2/reference#ws-public-ticker
+    #
+    # @example:
+    #   client.listen_ticker do |tick|
+    #     puts tick.inspect
+    #   end
+    def listen_ticker(pair="tBTCUSD", &block)
+      raise BlockMissingError unless block_given?
+      register_channel pair: pair, channel: "ticker",  &block
+    end
+
+    # Provides a way to access charting candle info
+    #
+    # @param symbol [string]
+    # @param time_frame [string] default '1m' - see doc for list of options
+    #
+    # Documentation:
+    #    https://docs.gemini.com/v2/reference#ws-public-candle
+    #
+    # @example:
+    # client.listen_candles("tBTCUSD","1m") do |candle|
+    #   puts "high #{candle[1][8]} | low #{candle[1][9]}"
+    # end
+    def listen_candles(symbol="tBTCUSD", time_frame="1m", &block)
+      raise BlockMissingError unless block_given?
+      key = "trade:#{time_frame}:#{symbol}"
+      register_channel key: key, channel: 'candles', &block
+    end
+
+  end
+end

data/lib/gemini/v2/trading.rb

@@ -0,0 +1,146 @@
+module Gemini
+  module V2::TradingClient
+
+    # Provides a way to access charting candle info
+    #
+    # @param symbol [string] The symbol you want information about.
+    # @param timeframe [string] Available values: '1m', '5m', '15m',
+    #        '30m', '1h', '3h', '6h', '12h', '1D', '7D', '14D', '1M'
+    # @param section [string] Available values: "last", "hist"
+    # @param params :limit [int32] Number of candles requested
+    # @param params :start [int32] Filter start (ms)
+    # @param params :end   [int32] Filter end (ms)
+    # @param params :sort  [int32] if = 1 it sorts
+    #        results returned with old > new
+    #
+    # @return [Array]
+    #
+    # @example:
+    #   client.candles('tBTCUSD')
+    def candles(symbol = 'tBTCUSD', timeframe = '1m', section = "last", params = {})
+      check_params(params, %i{limit start end sort})
+      get("candles/trade:#{timeframe}:#{symbol}/#{section}", params).body
+    end
+
+    # The Order Books channel allow you to keep track
+    # of the state of the Gemini order book.
+    # It is provided on a price aggregated basis,
+    # with customizable precision.
+    #
+    #
+    # @param symbol [string] The symbol you want
+    #     information about. You can find the list of
+    #     valid symbols by calling the /symbols
+    #     endpoint.
+    # @param precision [string] Level of price
+    #     aggregation (P0, P1, P2, P3, R0)
+    # @param params :len [int32] Number of price
+    #     points ("25", "100")
+    #
+    # @return [Hash] :bids [Array], :asks [Array]
+    #
+    # @example:
+    #   client.orderbook("btcusd")
+    def books(symbol="btcusd", precision="P0", params = {})
+      check_params(params, %i{len})
+      get("book/#{symbol}/#{precision}", params: params).body
+    end
+
+    # Trades endpoint includes all the pertinent details
+    # of the trade, such as price, size and time.
+    #
+    # @param symbol [string] the name of the symbol
+    # @param params :limit [int32] Number of records
+    # @param params :start [int32] Millisecond start time
+    # @param params :end   [int32] Millisecond end time
+    # @param params :sort  [int32] if = 1 it sorts
+    #     results returned with old > new
+    #
+    # @return [Array]
+    #
+    # @example:
+    #   client.trades("tETHUSD")
+    def trades(symbol="tBTCUSD", params={})
+      check_params(params, %i{limit start end sort})
+      get("trades/#{symbol}", params).body
+    end
+
+    # Get active orders
+    #
+    # example:
+    # client.orders
+    def orders
+      authenticated_post("auth/r/orders").body
+    end
+
+    # Get Trades generated by an Order
+    #
+    # @param order_id [int32] Id of the order
+    # @param symbol [string] symbol used for the order
+    #
+    # @return [Array]
+    #
+    # @example:
+    #   client.order_trades 10010, "tBTCUSD"
+    #
+    def order_trades(order_id, symbol="tBTCUSD")
+      authenticated_post("auth/r/order/#{symbol}:#{order_id}/trades").body
+    end
+
+
+    # Get active positions
+    #
+    # return [Array]
+    #
+    # @example:
+    #    client.active_positions
+    def active_positions
+      authenticated_post("auth/positions").body
+    end
+
+
+    # This channel sends a trade message whenever a trade occurs at Gemini.
+    # It includes all the pertinent details of the trade, such as price, size and time.
+    #
+    # @param symbol [string]
+    # @param block [Block] The code to be executed when a new ticker is sent by the server
+    #
+    # Documentation:
+    #   https://docs.gemini.com/v2/reference#ws-public-trades
+    #
+    # @example:
+    #   client.listen_trades("tBTCUSD") do |trade|
+    #     puts "traded #{trade[2][2]} BTC for #{trade[2][3]} USD"
+    #   end
+    def listen_trades(symbol="tBTCUSD", &block)
+      raise BlockMissingError unless block_given?
+      register_channel symbol: symbol, channel: "trades", &block
+    end
+
+    # The Order Books channel allow you to keep track of the state of the Gemini order book.
+    # It is provided on a price aggregated basis, with customizable precision.
+    # After receiving the response, you will receive a snapshot of the book,
+    # followed by updates upon any changes to the book.
+    #
+    # @param symbol [string]
+    # @param precision [string] Level of price aggregation (P0, P1, P2, P3, R0).
+    #       (default P0) R0 is raw books - These are the most granular books.
+    # @param frequency [string] Frequency of updates (F0, F1, F2, F3).
+    #       F0=realtime / F1=2sec / F2=5sec / F3=10sec (default F0)
+    # @param length [int] Number of price points ("25", "100") [default="25"]
+    #
+    # Documentation:
+    #   https://docs.gemini.com/v2/reference#ws-public-order-books
+    #   https://docs.gemini.com/v2/reference#ws-public-raw-order-books
+    #
+    # @example:
+    #   client.listen_book("tBTCUSD") do |trade|
+    #     puts "traded #{trade[2][2]} BTC for #{trade[2][3]} USD"
+    #   end
+    def listen_book(symbol="tBTCUSD", frequency="F0", length=25, precision="P0", &block)
+      raise BlockMissingError unless block_given?
+      register_channel symbol: symbol, channel: "book", prec: precision, freq: frequency, len: length, &block
+    end
+
+  end
+end

data/lib/gemini/v2/utils.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module Gemini
+  module V2::UtilsClient
+
+    # Calculate the average execution rate for Trading or Margin funding.
+    #
+    # @param symbol [string] The symbol you want information about.
+    # @param amount [string] Amount. Positive for buy, negative for sell (ex. "1.123")
+    # @param period [string] (optional) Maximum period for Margin Funding
+    # @param rate_limit [string] Limit rate/price (ex. "1000.5")
+    #
+    # @return [Array]
+    #
+    # @example:
+    #   client.calc_avg_price('tBTCUSD', 1000, 1000)
+    def calc_avg_price(symbol = 'tBTCUSD', amount = 0, period = 0, rate_limit = nil)
+      params = {
+        symbol: symbol,
+        amount: amount.to_s,
+        period: period.to_s
+      }
+      params[:rateLimit] = rate_limit.to_s unless rate_limit.nil?
+      get("calc/trade/avg",params)
+    end
+  end
+end

data/lib/gemini/version.rb

@@ -0,0 +1,3 @@
+module Gemini
+  VERSION = "0.0.1"
+end