Class: BittrexEnterprise::Markets

Inherits:
Object
  • Object
show all
Includes:
ApiHelpers
Defined in:
lib/bittrex-enterprise/markets.rb

Class Method Summary collapse

Methods included from ApiHelpers

included

Class Method Details

.candles(market_symbol, candle_interval) ⇒ Object

———————————– 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]



87
88
89
 
# File 'lib/bittrex-enterprise/markets.rb', line 87

def self.candles(market_symbol, candle_interval)
  get 'markets/{marketSymbol}/trades', marketSymbol: market_symbol, candleInterval: candle_interval
end

.info(market_symbol) ⇒ Object

———————————— INFO ————————————————– Retrieve information for a specific market. —— PARAMS —— market_symbol: string - required - symbol of market to retrieve



30
31
32
 
# File 'lib/bittrex-enterprise/markets.rb', line 30

def self.info(market_symbol)
  get 'markets/{marketSymbol}', marketSymbol: market_symbol
end

.list ⇒ Object

————————————- LIST ————————————————- List markets



12
13
14
 
# File 'lib/bittrex-enterprise/markets.rb', line 12

def self.list
  get 'markets'
end

.order_book(market_symbol, depth = nil) ⇒ Object

———————————- 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)



52
53
54
 
# File 'lib/bittrex-enterprise/markets.rb', line 52

def self.order_book(market_symbol, depth=nil)
  get 'markets/{marketSymbol}/orderbook', marketSymbol: market_symbol, depth: depth
end

.summaries ⇒ Object

———————————– SUMMARIES ———————————————- List summaries of the last 24 hours of activity for all markets.



20
21
22
 
# File 'lib/bittrex-enterprise/markets.rb', line 20

def self.summaries
  get 'markets/summaries'
end

.summary(market_symbol) ⇒ Object

———————————– 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



40
41
42
 
# File 'lib/bittrex-enterprise/markets.rb', line 40

def self.summary(market_symbol)
  get 'markets/{marketSymbol}/summary', marketSymbol: market_symbol
end

.ticker(market_symbol) ⇒ Object

———————————– TICKER ————————————————- Retrieve the ticker for a specific market. —— PARAMS —— market_symbol: string - required - symbol of market to retrieve recent trades for



72
73
74
 
# File 'lib/bittrex-enterprise/markets.rb', line 72

def self.ticker(market_symbol)
  get 'markets/{marketSymbol}/trades', marketSymbol: market_symbol
end

.trades(market_symbol) ⇒ Object

———————————— TRADES ———————————————— Retrieve the recent trades for a specific market. —— PARAMS —— market_symbol: string - required - symbol of market to retrieve recent trades for



62
63
64
 
# File 'lib/bittrex-enterprise/markets.rb', line 62

def self.trades(market_symbol)
  get 'markets/{marketSymbol}/trades', marketSymbol: market_symbol
end