Method: Bitmex::Client#liquidations

Defined in:

lib/bitmex/client.rb

#liquidations(filters = {}) {|Hash| ... } ⇒ Array

Get liquidation orders

Examples:

Get liquidations orders

liquidations = client.liquidations symbol: 'XBTUSD'

Listen for liquidation orders

client.liquidations symbol: 'XBTUSD' do |liquidation|
  puts liquidation.inspect
end

Parameters:

• filters (Hash) (defaults to: {}) —

  the filters to apply to mostly REST API requests with a few exceptions

Options Hash (filters):

• :symbol (String) —

  the instrument symbol, this filter works in both REST and Websocket APIs

• :filter (String) —

  generic table filter, send key/value pairs Timestamp Filters

• :columns (String) —

  array of column names to fetch; if omitted, will return all columns.

• :count (Double) — default: 100 —

  number of results to fetch.

• :start (Double) —

  Starting point for results.

• :reverse (Boolean) — default: false —

  if true, will sort results newest first.

• :startTime (Datetime, String) —

  Starting date filter for results.

• :endTime (Datetime, String) —

  Ending date filter for results

Yields:

• (Hash) —

  the liquidation data

Returns:

• (Array) —

  the liquidations

# File 'lib/bitmex/client.rb', line 85

def liquidations(filters = {}, &ablock)
  if block_given?
    websocket.listen liquidation: filters[:symbol], &ablock
  else
    rest.get :liquidation, params: filters
  end
end