Class: BitmexClient::HTTP::Public::Client

Inherits:

Object

• Object
• BitmexClient::HTTP::Public::Client

Defined in:

lib/bitmex_client/http/public.rb

Instance Method Summary

• #announcement(options = {}) ⇒ Object
• #announcement_urgent(options = {}) ⇒ Object
• #funding(options = {}) ⇒ Object
• #initialize ⇒ Client constructor

  A new instance of Client.

• #instrument(options = {}) ⇒ Object
• #instrument_active ⇒ Object
• #insurance(options = {}) ⇒ Object
• #leaderboard(options = {}) ⇒ Object
• #liquidation(options = {}) ⇒ Object
• #order_book_l2(symbol, depth = 25) ⇒ Object
• #settlement(options = {}) ⇒ Object
• #stats ⇒ Object
• #stats_history ⇒ Object
• #stats_history_usd ⇒ Object
• #trade(options = {}) ⇒ Object

Constructor Details

#initialize ⇒ Client

Returns a new instance of Client.

# File 'lib/bitmex_client/http/public.rb', line 6

def initialize
  @connection = Connection.new(nil, nil)
end

Instance Method Details

#announcement(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Announcement/Announcement_get

# File 'lib/bitmex_client/http/public.rb', line 11

def announcement(options = {})
  @connection.get('/api/v1/announcement', options).body
end

#announcement_urgent(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Announcement/Announcement_getUrgent

# File 'lib/bitmex_client/http/public.rb', line 16

def announcement_urgent(options = {})
  @connection.get('/api/v1/announcement/urgent', options).body
end

#funding(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Funding/Funding_get

# File 'lib/bitmex_client/http/public.rb', line 21

def funding(options = {})
  @connection.get('/api/v1/funding', options).body
end

#instrument(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Instrument/Instrument_get

# File 'lib/bitmex_client/http/public.rb', line 26

def instrument(options = {})
  @connection.get('/api/v1/instrument', options).body
end

#instrument_active ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Instrument/Instrument_getActive

# File 'lib/bitmex_client/http/public.rb', line 31

def instrument_active
  @connection.get('/api/v1/instrument/active').body
end

#insurance(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Insurance/Insurance_get

# File 'lib/bitmex_client/http/public.rb', line 36

def insurance(options = {})
  @connection.get('/api/v1/insurance', options).body
end

#leaderboard(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Leaderboard/Leaderboard_get

# File 'lib/bitmex_client/http/public.rb', line 41

def leaderboard(options = {})
  @connection.get('/api/v1/leaderboard', options).body
end

#liquidation(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Liquidation/Liquidation_get

# File 'lib/bitmex_client/http/public.rb', line 46

def liquidation(options = {})
  @connection.get('/api/v1/liquidation', options).body
end

#order_book_l2(symbol, depth = 25) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/OrderBook/OrderBook_getL2

# File 'lib/bitmex_client/http/public.rb', line 51

def order_book_l2(symbol, depth = 25)
  @connection.get('/api/v1/orderBook/L2', { symbol: symbol, depth: depth }).body
end

#settlement(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Settlement/Settlement_get

# File 'lib/bitmex_client/http/public.rb', line 56

def settlement(options = {})
  @connection.get('/api/v1/settlement', options).body
end

#stats ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Stats/Stats_get

# File 'lib/bitmex_client/http/public.rb', line 61

def stats
  @connection.get('/api/v1/stats').body
end

#stats_history ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Stats/Stats_history

# File 'lib/bitmex_client/http/public.rb', line 66

def stats_history
  @connection.get('/api/v1/stats/history').body
end

#stats_history_usd ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Stats/Stats_historyUSD

# File 'lib/bitmex_client/http/public.rb', line 71

def stats_history_usd
  @connection.get('/api/v1/stats/historyUSD').body
end

#trade(options = {}) ⇒ Object

See Also:

• https://www.bitmex.com/api/explorer/#!/Trade/Trade_get

# File 'lib/bitmex_client/http/public.rb', line 76

def trade(options = {})
  @connection.get('/api/v1/trade', options).body
end