Module: Bitfinex::RESTv1Lends

Included in:
RESTv1
Defined in:
lib/rest/v1/lends.rb

Instance Method Summary collapse

Instance Method Details

#lends(currency = "usd", params = {}) ⇒ Array

Get a list of the most recent funding data for the given currency: total amount provided and Flash Return Rate (in % by 365 days) over time.

@example:

client.lends

Parameters:

  • currency (string) (defaults to: "usd") —

    (optional) Specify the currency, default “USD”

  • params (defaults to: {}) —

    :timestamp [time] (optional) Only show data at or after this timestamp

  • params (defaults to: {}) —

    :limit_lends [int] (optional) Limit the amount of funding data returned. Must be > 1, default 50

Returns:

  • (Array) 


12
13
14
15
 
# File 'lib/rest/v1/lends.rb', line 12

def lends(currency = "usd", params = {})
  check_params(params, %i{timestamp limit_lends})
  get("lends/#{currency}", params: params).body
end