bittrex-enterprise 0.1.0

data/lib/bittrex-enterprise/markets.rb

@@ -0,0 +1,92 @@
+module BittrexEnterprise
+  class Markets
+    include ApiHelpers
+
+  # ==============================================================================================
+  # PUBLIC METHODS - NO AUTH REQUIRED ============================================================
+  # ==============================================================================================
+
+    # ------------------------------------- LIST -------------------------------------------------
+    # List markets
+    # --------------------------------------------------------------------------------------------
+    def self.list
+      get 'markets'
+    end
+
+
+    # ----------------------------------- SUMMARIES ----------------------------------------------
+    # List summaries of the last 24 hours of activity for all markets.
+    # --------------------------------------------------------------------------------------------
+    def self.summaries
+      get 'markets/summaries'
+    end
+
+
+    # ------------------------------------ INFO --------------------------------------------------
+    # Retrieve information for a specific market.
+    # ------ PARAMS ------
+    # market_symbol: string - required - symbol of market to retrieve
+    # --------------------------------------------------------------------------------------------
+    def self.info(market_symbol)
+      get 'markets/{marketSymbol}', marketSymbol: market_symbol
+    end
+
+
+    # ----------------------------------- SUMMARY ------------------------------------------------
+    # Retrieve summary of the last 24 hours of activity for a specific market.
+    # ------ PARAMS ------
+    # market_symbol: string - required - symbol of market to retrieve summary for
+    # --------------------------------------------------------------------------------------------
+    def self.summary(market_symbol)
+      get 'markets/{marketSymbol}/summary', marketSymbol: market_symbol
+    end
+
+
+    # ---------------------------------- ORDER BOOK ----------------------------------------------
+    # Retrieve the order book for a specific market.
+    # ------ PARAMS ------
+    # market_symbol: string - required - symbol of market to retrieve order book for
+    # depth: integer - optional - maximum depth of order book to return
+    #                             (allowed values are [1, 25, 500], default is 25)
+    # --------------------------------------------------------------------------------------------
+    def self.order_book(market_symbol, depth=nil)
+      get 'markets/{marketSymbol}/orderbook', marketSymbol: market_symbol, depth: depth
+    end
+
+
+    # ------------------------------------ TRADES ------------------------------------------------
+    # Retrieve the recent trades for a specific market.
+    # ------ PARAMS ------
+    # market_symbol: string - required - symbol of market to retrieve recent trades for
+    # --------------------------------------------------------------------------------------------
+    def self.trades(market_symbol)
+      get 'markets/{marketSymbol}/trades', marketSymbol: market_symbol
+    end
+
+
+    # ----------------------------------- TICKER -------------------------------------------------
+    # Retrieve the ticker for a specific market.
+    # ------ PARAMS ------
+    # market_symbol: string - required - symbol of market to retrieve recent trades for
+    # --------------------------------------------------------------------------------------------
+    def self.ticker(market_symbol)
+      get 'markets/{marketSymbol}/trades', marketSymbol: market_symbol
+    end
+    
+
+    # ----------------------------------- CANDLES ------------------------------------------------
+    # Retrieve recent candles for a specific market. The maximum age of the returned candles
+    # depends on the interval as follows:
+    # (MINUTE_1: 1 day, MINUTE_5: 1 day, HOUR_1: 31 days, DAY_1: 366 days).
+    # Candles for intervals without any trading activity are omitted.
+    # ------ PARAMS ------
+    # market_symbol: string - required - symbol of market to retrieve recent trades for
+    # candle_interval: string_enum - required - desired time interval between candles -
+    #                                           [MINUTE_1, MINUTE_5, HOUR_1, DAY_1]
+    # --------------------------------------------------------------------------------------------
+    def self.candles(market_symbol, candle_interval)
+      get 'markets/{marketSymbol}/trades', marketSymbol: market_symbol, candleInterval: candle_interval
+    end
+
+  end
+end

data/lib/bittrex-enterprise/orders.rb

@@ -0,0 +1,98 @@
+module BittrexEnterprise
+  class Orders
+    include ApiHelpers
+
+  # ==============================================================================================
+  # AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # ----------------------------------------- OPEN ---------------------------------------------
+    # List open deposits. Results are sorted in inverse order of UpdatedAt, and are limited to
+    # the first 1000.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # marketSymbol - string - optional - filter by market
+    # --------------------------------------------------------------------------------------------
+    def self.open(params={})
+      get_signed 'orders/open', params
+    end
+
+
+    # ---------------------------------------- CLOSED --------------------------------------------
+    # List closed orders.
+    # StartDate and EndDate filters apply to the ClosedAt field. Pagination and the sort order
+    # of the results are in inverse order of the ClosedAt field.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # marketSymbol - string - optional - filter by market
+    #
+    # nextPageToken - string - The unique identifier of the item that the resulting query result
+    #         should start after, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the forward direction. (May only be specified if PreviousPageToken
+    #         is not specified.)
+    #
+    # previousPageToken - string - The unique identifier of the item that the resulting query
+    #         result should end before, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the reverse direction. (May only be specified if NextPageToken is
+    #         not specified.)
+    #
+    # pageSize - integer - maximum number of items to retrieve -- default 100, minimum 1, maximum 200
+    #
+    # startDate - string(date-time) - Filters out results before this timestamp. In ISO 8601 format
+    #         (e.g., "2019-01-02T16:23:45Z"). Precision beyond one second is not supported. Use
+    #         pagination parameters for more precise filtering.
+    #
+    # endDate - string(date-time) - Filters out result after this timestamp. Uses the same format
+    #         as StartDate. Either, both, or neither of StartDate and EndDate can be set. The only
+    #         constraint on the pair is that, if both are set, then EndDate cannot be before StartDate.
+    # --------------------------------------------------------------------------------------------
+    def self.closed(params={})
+      get_signed 'orders/closed', params
+    end
+
+
+    # --------------------------------------- RETRIEVE -------------------------------------------
+    # Retrieve information on a specific order.
+    #
+    # ------ PARAMS ------
+    # order_id - string - required - (guid-formatted string) - ID of the order to retrieve
+    # --------------------------------------------------------------------------------------------
+    def self.retrieve(order_id)
+      get_signed 'orders/{orderId}', orderId: order_id
+    end
+
+    # ---------------------------------------- CANCEL --------------------------------------------
+    # Cancel an order.
+    #
+    # ------ PARAMS ------
+    # order_id - string - required - (guid-formatted string) - ID of the order to retrieve
+    # --------------------------------------------------------------------------------------------
+    def self.cancel(order_id)
+      delete_signed 'orders/{orderId}', orderId: order_id
+    end
+
+
+    # ---------------------------------------- CREATE --------------------------------------------
+    # Create a new order.
+    #
+    # ------ PARAMS ------
+    # NewOrder - object - required - information specifying the order to create
+    #         {
+    #           "marketSymbol": "string",
+    #           "direction": "string",
+    #           "type": "string",
+    #           "quantity": "number (double)",
+    #           "ceiling": "number (double)",
+    #           "limit": "number (double)",
+    #           "timeInForce": "string",
+    #           "expiresAt": "string (date-time)",
+    #           "clientOrderId": "string (uuid)"
+    #         }
+    #   *** REQUIRED - marketSymbol, direction, type ***
+    # --------------------------------------------------------------------------------------------
+    def self.create(new_order)
+      post_signed 'orders', new_order
+    end
+
+  end
+end

data/lib/bittrex-enterprise/ping.rb

@@ -0,0 +1,17 @@
+module BittrexEnterprise
+  class Ping
+    include ApiHelpers
+
+  # ==============================================================================================
+  # PUBLIC METHODS - NO AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # ----------------------------------------- PING -----------------------------------------
+    # Pings the service
+    # --------------------------------------------------------------------------------------------
+    def self.send
+      get 'ping'
+    end
+
+  end
+end

data/lib/bittrex-enterprise/sub_accounts.rb

@@ -0,0 +1,55 @@
+module BittrexEnterprise
+  class SubAccounts
+    include ApiHelpers
+
+  # ==============================================================================================
+  # AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # ------------------------------------------ LIST --------------------------------------------
+    # List subaccounts. (NOTE: This API is limited to partners and not available for traders.)
+    # Pagination and the sort order of the results are in inverse order of the CreatedAt field.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # nextPageToken - string - The unique identifier of the item that the resulting query result
+    #         should start after, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the forward direction. (May only be specified if PreviousPageToken
+    #         is not specified.)
+    #
+    # previousPageToken - string - The unique identifier of the item that the resulting query
+    #         result should end before, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the reverse direction. (May only be specified if NextPageToken is
+    #         not specified.)
+    #
+    # pageSize - integer - maximum number of items to retrieve -- default 100, minimum 1, maximum 200
+    # --------------------------------------------------------------------------------------------
+    def self.list(params={})
+      get_signed 'subaccounts', params
+    end
+
+
+    # ------------------------------------------ CREATE ------------------------------------------
+    # Create a new subaccount. (NOTE: This API is limited to partners and not available for traders.)
+    #
+    # ------ PARAMS ------
+    # no params required. Passes an empty hash
+    # --------------------------------------------------------------------------------------------
+    def self.create()
+      post_signed 'subaccounts', {}
+    end
+
+
+    # --------------------------------------- RETRIEVE -------------------------------------------
+    # Retrieve details for a specified subaccount. (NOTE: This API is limited to partners
+    # and not available for traders.)
+    #
+    # ------ PARAMS ------
+    # sub_account_id - string - required - (guid-formatted string) - ID of the subaccount to
+    #                                                                retrieve details for
+    # --------------------------------------------------------------------------------------------
+    def self.retrieve(sub_account_id)
+      get_signed 'subaccounts/{subaccountId}', subaccountId: sub_account_id
+    end
+
+  end
+end

data/lib/bittrex-enterprise/transfers.rb

@@ -0,0 +1,111 @@
+module BittrexEnterprise
+  class Transfers
+    include ApiHelpers
+
+  # ==============================================================================================
+  # AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # ----------------------------------------- SENT ---------------------------------------------
+    # List sent transfers. (NOTE: This API is limited to partners and not available for traders.)
+    # Pagination and the sort order of the results are in inverse order of the Executed field.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # toSubaccountId - string - optional
+    #
+    # toMasterAccount - boolean - optional
+    #
+    # currencySymbol - string - optional
+    #
+    # nextPageToken - string - The unique identifier of the item that the resulting query result
+    #         should start after, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the forward direction. (May only be specified if PreviousPageToken
+    #         is not specified.)
+    #
+    # previousPageToken - string - The unique identifier of the item that the resulting query
+    #         result should end before, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the reverse direction. (May only be specified if NextPageToken is
+    #         not specified.)
+    #
+    # pageSize - integer - maximum number of items to retrieve -- default 100, minimum 1, maximum 200
+    #
+    # startDate - string(date-time) - Filters out results before this timestamp. In ISO 8601 format
+    #         (e.g., "2019-01-02T16:23:45Z"). Precision beyond one second is not supported. Use
+    #         pagination parameters for more precise filtering.
+    #
+    # endDate - string(date-time) - Filters out result after this timestamp. Uses the same format
+    #         as StartDate. Either, both, or neither of StartDate and EndDate can be set. The only
+    #         constraint on the pair is that, if both are set, then EndDate cannot be before StartDate.
+    # --------------------------------------------------------------------------------------------
+    def self.sent(params={})
+      get_signed 'transfers/sent', params
+    end
+
+
+    # -------------------------------------- RECEIVED --------------------------------------------
+    # List sent transfers. (NOTE: This API is limited to partners and not available for traders.)
+    # Pagination and the sort order of the results are in inverse order of the Executed field.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # fromSubaccountId - string - optional
+    #
+    # fromMasterAccount - boolean - optional
+    #
+    # currencySymbol - string - optional
+    #
+    # nextPageToken - string - The unique identifier of the item that the resulting query result
+    #         should start after, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the forward direction. (May only be specified if PreviousPageToken
+    #         is not specified.)
+    #
+    # previousPageToken - string - The unique identifier of the item that the resulting query
+    #         result should end before, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the reverse direction. (May only be specified if NextPageToken is
+    #         not specified.)
+    #
+    # pageSize - integer - maximum number of items to retrieve -- default 100, minimum 1, maximum 200
+    #
+    # startDate - string(date-time) - Filters out results before this timestamp. In ISO 8601 format
+    #         (e.g., "2019-01-02T16:23:45Z"). Precision beyond one second is not supported. Use
+    #         pagination parameters for more precise filtering.
+    #
+    # endDate - string(date-time) - Filters out result after this timestamp. Uses the same format
+    #         as StartDate. Either, both, or neither of StartDate and EndDate can be set. The only
+    #         constraint on the pair is that, if both are set, then EndDate cannot be before StartDate.
+    # --------------------------------------------------------------------------------------------
+    def self.received(params={})
+      get_signed 'transfers/received', params
+    end
+
+
+    # --------------------------------------- RETRIEVE -------------------------------------------
+    # Retrieve information on the specified transfer. (NOTE: This API is limited to partners and
+    # not available for traders.)
+    #
+    # ------ PARAMS ------
+    # transfer_id - string - required - (guid-formatted string) - ID of the transfer to retrieve
+    # --------------------------------------------------------------------------------------------
+    def self.retrieve(transfer_id)
+      get_signed 'transfers/{transferId}', transferId: transfer_id
+    end
+
+    # ---------------------------------------- CREATE --------------------------------------------
+    # Executes a new transfer. (NOTE: This API is limited to partners and not available for traders.)
+    #
+    # ------ PARAMS ------
+    # NewTransfer - object - required - information specifying the transfer to execute
+    #         {
+    #           "toSubaccountId": "string (uuid)",
+    #           "requestId": "string (uuid)",
+    #           "currencySymbol": "string",
+    #           "amount": "number (double)",
+    #           "toMasterAccount": "boolean"
+    #         }
+    #   *** REQUIRED - currencySymbol, amount ***
+    # --------------------------------------------------------------------------------------------
+    def self.create(new_transfer)
+      post_signed 'transfers', new_transfer
+    end
+
+  end
+end

data/lib/bittrex-enterprise/version.rb

@@ -0,0 +1,3 @@
+module BittrexEnterprise
+  VERSION = '0.1.0'
+end

data/lib/bittrex-enterprise/withdrawals.rb

@@ -0,0 +1,115 @@
+module BittrexEnterprise
+  class Withdrawals
+    include ApiHelpers
+
+  # ==============================================================================================
+  # AUTH REQUIRED ================================================================================
+  # ==============================================================================================
+
+    # ----------------------------------------- OPEN ---------------------------------------------
+    # List open withdrawals. Results are sorted in inverse order of the CreatedAt field, and are
+    # limited to the first 1000.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # status - string enum: [REQUESTED, AUTHORIZED, PENDING, ERROR_INVALID_ADDRESS] - optional -
+    #                                                      filter by an open withdrawal status
+    #
+    # currencySymbol - string - optional - filter by currency
+    # --------------------------------------------------------------------------------------------
+    def self.open(params={})
+      get_signed 'withdrawals/open', params
+    end
+
+
+    # ---------------------------------------- CLOSED --------------------------------------------
+    # List closed withdrawals. StartDate and EndDate filters apply to the CompletedAt field.
+    # Pagination and the sort order of the results are in inverse order of the CompletedAt field.
+    #
+    # ------ PARAMS ------ PARAMS MUST BE PASSED AS KEY VALUE PAIRS
+    # status - string enum: [COMPLETED, CANCELLED] - optional - filter by an open withdrawal status
+    #
+    # currencySymbol - string - optional - filter by currency
+    #
+    # nextPageToken - string - The unique identifier of the item that the resulting query result
+    #         should start after, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the forward direction. (May only be specified if PreviousPageToken
+    #         is not specified.)
+    #
+    # previousPageToken - string - The unique identifier of the item that the resulting query
+    #         result should end before, in the sort order of the given endpoint. Used for traversing
+    #         a paginated set in the reverse direction. (May only be specified if NextPageToken is
+    #         not specified.)
+    #
+    # pageSize - integer - maximum number of items to retrieve -- default 100, minimum 1, maximum 200
+    #
+    # startDate - string(date-time) - Filters out results before this timestamp. In ISO 8601 format
+    #         (e.g., "2019-01-02T16:23:45Z"). Precision beyond one second is not supported. Use
+    #         pagination parameters for more precise filtering.
+    #
+    # endDate - string(date-time) - Filters out result after this timestamp. Uses the same format
+    #         as StartDate. Either, both, or neither of StartDate and EndDate can be set. The only
+    #         constraint on the pair is that, if both are set, then EndDate cannot be before StartDate.
+    # --------------------------------------------------------------------------------------------
+    def self.closed(params={})
+      get_signed 'withdrawals/closed', params
+    end
+
+
+    # --------------------------------------- BY TX ID -------------------------------------------
+    # Retrieves all withdrawals for this account with the given TxId
+    #
+    # ------ PARAMS ------
+    # tx_id - string - required - the transaction id to lookup
+    # --------------------------------------------------------------------------------------------
+    def self.by_tx_id(tx_id)
+      get_signed 'withdrawals/ByTxId/{txId}', txId: tx_id
+    end
+
+
+    # --------------------------------------- RETRIEVE -------------------------------------------
+    # Retrieve information on a specified withdrawal.
+    #
+    # ------ PARAMS ------
+    # withdrawal_id - string - required - (guid-formatted string) - ID of withdrawal to retrieve
+    # --------------------------------------------------------------------------------------------
+    def self.by_tx_id(withdrawal_id)
+      get_signed 'withdrawals/{withdrawalId}', withdrawalId: tx_id
+    end
+
+
+    # ---------------------------------------- CANCEL --------------------------------------------
+    # Cancel an order.
+    #
+    # ------ PARAMS ------
+    # withdrawal_id - string - required - (guid-formatted string) - ID of withdrawal to cancel
+    # --------------------------------------------------------------------------------------------
+    def self.cancel(withdrawal_id)
+      delete_signed 'withdrawals/{withdrawalId}', withdrawalId: withdrawal_id
+    end
+
+
+    # ---------------------------------------- CREATE --------------------------------------------
+    # Create a new withdrawal.
+    #
+    # ------ PARAMS ------
+    # NewWithdrawal - object - required - information specifying the withdrawal to create
+    #         {
+    #           "id": "string (uuid)",
+    #           "currencySymbol": "string",
+    #           "quantity": "number (double)",
+    #           "cryptoAddress": "string",
+    #           "cryptoAddressTag": "string",
+    #           "txCost": "number (double)",
+    #           "txId": "string",
+    #           "status": "string",
+    #           "createdAt": "string (date-time)",
+    #           "completedAt": "string (date-time)"
+    #         }
+    #   *** REQUIRED - id, currencySymbol, quantity, cryptoAddress, status, createdAt  ***
+    # --------------------------------------------------------------------------------------------
+    def self.create(new_withdrawal)
+      post_signed 'withdrawals', new_withdrawal
+    end
+
+  end
+end

data/lib/bittrex_enterprise.rb

@@ -0,0 +1,46 @@
+require 'openssl'
+require 'digest'
+require 'addressable/uri'
+require 'deep_symbolize'
+require 'json'
+require 'httparty'
+
+require 'bittrex-enterprise/version'
+require 'bittrex-enterprise/api_helpers'
+require 'bittrex-enterprise/account'
+require 'bittrex-enterprise/addresses'
+require 'bittrex-enterprise/balances'
+require 'bittrex-enterprise/currencies'
+require 'bittrex-enterprise/deposits'
+require 'bittrex-enterprise/markets'
+require 'bittrex-enterprise/orders'
+require 'bittrex-enterprise/ping'
+require 'bittrex-enterprise/sub_accounts'
+require 'bittrex-enterprise/transfers'
+require 'bittrex-enterprise/withdrawals'
+
+# Gem to use Bittrex API
+module BittrexEnterprise
+
+  class << self
+      attr_accessor :configuration
+  end
+
+  def self.setup
+    @configuration ||= Configuration.new
+    yield(configuration)
+    puts configuration.inspect
+  end
+
+  # Handles the Bittrex API keys
+  class Configuration
+    attr_accessor :key, :secret
+    attr_reader :base_uri
+
+    def initialize
+      @key = ''
+      @secret = ''
+    end
+  end
+
+end

data/lib/deep_symbolize.rb

@@ -0,0 +1,68 @@
+# Symbolizes all of hash's keys and subkeys.
+# Also allows for custom pre-processing of keys (e.g. downcasing, etc)
+# if the block is given:
+#
+# somehash.deep_symbolize { |key| key.downcase }
+#
+# Usage: either include it into global Hash class to make it available to
+#        to all hashes, or extend only your own hash objects with this
+#        module.
+#        E.g.:
+#        1) class Hash; include DeepSymbolizable; end
+#        2) myhash.extend DeepSymbolizable
+#
+# Source: https://github.com/ntamvl/poloniex_ruby/blob/master/lib/deep_symbolize.rb
+
+# Used to symbolize hashes
+module DeepSymbolizable
+  def deep_symbolize(&block)
+    method = self.class.to_s.downcase.to_sym
+    syms = DeepSymbolizable::Symbolizers
+    syms.respond_to?(method) ? syms.send(method, self, &block) : self
+  end
+
+  # Used to symbolize hashes
+  module Symbolizers
+    module_function
+
+    # the primary method - symbolizes keys of the given hash,
+    # preprocessing them with a block if one was given, and recursively
+    # going into all nested enumerables
+    def hash(hash, &block)
+      hash.each_with_object({}) do |(key, value), result|
+        # Recursively deep-symbolize subhashes
+        value = _recurse_(value, &block)
+
+        # Pre-process the key with a block if it was given
+        key = yield key if block_given?
+        # Symbolize the key string if it responds to to_sym
+        sym_key = begin
+                    key.to_sym
+                  rescue StandardError
+                    key
+                  end
+
+        # write it back into the result and return the updated hash
+        result[sym_key] = value
+      end
+    end
+
+    # walking over arrays and symbolizing all nested elements
+    def array(ary, &block)
+      ary.map { |v| _recurse_(v, &block) }
+    end
+
+    # handling recursion - any Enumerable elements (except String)
+    # is being extended with the module, and then symbolized
+    def _recurse_(value, &block)
+      if value.is_a?(Enumerable) && !value.is_a?(String)
+        # support for a use case without extended core Hash
+        unless value.class.include?(DeepSymbolizable)
+          value.extend DeepSymbolizable
+        end
+        value = value.deep_symbolize(&block)
+      end
+      value
+    end
+  end
+end