Method: Bitmex::Chat#messages

Defined in:
lib/bitmex/chat.rb

#messages(options = { count: 100, reverse: true }) {|Hash| ... } ⇒ Array

Get chat messages

Examples:

Get last 10 messages for channel 1

messages = client.chat.messages channelID: 1, count: 10, reverse: true

Parameters:

  • options (Hash) (defaults to: { count: 100, reverse: true }) —

    options to filter by

Options Hash (options):

  • :count (Integer) — default: 100 —

    number of results to fetch.

  • :start (Integer) —

    starting ID for results

  • :reverse (Boolean) —

    If true, will sort results newest first

  • :channelID (Integer) —

    Channel id. GET /chat/channels for ids. Leave blank for all.

Yields:

  • (Hash) —

    the message

Returns:

  • (Array) —

    the messages



15
16
17
18
19
20
21
 
# File 'lib/bitmex/chat.rb', line 15

def messages(options = { count: 100, reverse: true }, &ablock)
  if block_given?
    websocket.listen chat: options[:channelID], &ablock
  else
    rest.get chat_path, params: options
  end
end