Module: Binance::Api

Defined in:
lib/binance/api.rb,
lib/binance/api/error.rb,
lib/binance/api/order.rb,
lib/binance/api/account.rb,
lib/binance/api/request.rb,
lib/binance/api/version.rb,
lib/binance/api/data_stream.rb,
lib/binance/api/configuration.rb

Defined Under Namespace

Classes: Account, Configuration, DataStream, Error, Order, Request

Constant Summary collapse

VERSION = 
"0.1.6"

Class Method Summary collapse

Class Method Details

.candlesticks!(end_time: nil, interval: nil, limit: 500, start_time: nil, symbol: nil) ⇒ Object

Valid limits:[5, 10, 20, 50, 100, 500, 1000]

Raises:



5
6
7
8
9
10
 
# File 'lib/binance/api.rb', line 5

def candlesticks!(end_time: nil, interval: nil, limit: 500, start_time: nil, symbol: nil) 
  raise Error.new(message: 'interval is required') unless interval
  raise Error.new(message: 'symbol is required') unless symbol
  params = { endTime: end_time, interval: interval, limit: limit, startTime: start_time, symbol: symbol }
  Request.send!(api_key_type: :read_info, path: '/api/v1/klines', params: params)
end

.compressed_aggregate_trades!(end_time: nil, from_id: nil, limit: 500, start_time: nil, symbol: nil) ⇒ Object

Raises:



12
13
14
15
16
 
# File 'lib/binance/api.rb', line 12

def compressed_aggregate_trades!(end_time: nil, from_id: nil, limit: 500, start_time: nil, symbol: nil) 
  raise Error.new(message: "symbol is required") unless symbol
  params = { endTime: end_time, fromId: from_id, limit: limit, startTime: start_time, symbol: symbol }
  Request.send!(api_key_type: :read_info, path: '/api/v1/aggTrades', params: params)
end

.depth!(symbol: nil, limit: 100) ⇒ Object

Raises:



18
19
20
21
22
 
# File 'lib/binance/api.rb', line 18

def depth!(symbol: nil, limit: 100)
  raise Error.new(message: "symbol is required") unless symbol
  params = { limit: limit, symbol: symbol }
  Request.send!(api_key_type: :read_info, path: '/api/v1/depth', params: params)
end

.exchange_info! ⇒ Object 



24
25
26
 
# File 'lib/binance/api.rb', line 24

def exchange_info!
  Request.send!(api_key_type: :read_info, path: '/api/v1/exchangeInfo')
end

.historical_trades!(symbol: nil, limit: 500, from_id: nil) ⇒ Object

Raises:



28
29
30
31
32
 
# File 'lib/binance/api.rb', line 28

def historical_trades!(symbol: nil, limit: 500, from_id: nil)
  raise Error.new(message: "symbol is required") unless symbol
  params = { fromId: from_id, limit: limit, symbol: symbol }
  Request.send!(api_key_type: :read_info, path: '/api/v1/historicalTrades', params: params, security_type: :market_data)
end

.ping! ⇒ Object 



34
35
36
 
# File 'lib/binance/api.rb', line 34

def ping!
  Request.send!(path: '/api/v1/ping')
end

.ticker!(symbol: nil, type: nil) ⇒ Object

Raises:



38
39
40
41
42
43
44
 
# File 'lib/binance/api.rb', line 38

def ticker!(symbol: nil, type: nil)
  ticker_type = type&.to_sym
  error_message = "type must be one of: #{ticker_types.join(', ')}. #{type} was provided."
  raise Error.new(message: error_message) unless ticker_types.include? ticker_type
  params = symbol ? { symbol: symbol } : {}
  Request.send!(api_key_type: :read_info, path: ticker_path(type: type), params: params)
end

.time! ⇒ Object 



46
47
48
 
# File 'lib/binance/api.rb', line 46

def time!
  Request.send!(path: '/api/v1/time')
end

.trades!(symbol: nil, limit: 500) ⇒ Object

Raises:



50
51
52
53
54
 
# File 'lib/binance/api.rb', line 50

def trades!(symbol: nil, limit: 500)
  raise Error.new(message: "symbol is required") unless symbol
  params = { limit: limit, symbol: symbol }
  Request.send!(api_key_type: :read_info, path: '/api/v1/trades', params: params)
end