Class: Bitex::Ask

Inherits:
OrderBase show all
Defined in:
lib/bitex/order.rb

Overview

An Ask is an order to sell a given specie.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from OrderBase

active, all, #cancel!, find

Instance Attribute Details

#created_at ⇒ Time

Returns Time when this Ask was created.

Returns:

  • (Time) —

    Time when this Ask was created.




# File 'lib/bitex/order.rb', line 115

#id ⇒ Integer

Returns This Ask’s unique ID.

Returns:

  • (Integer) —

    This Ask’s unique ID.




# File 'lib/bitex/order.rb', line 112

#price ⇒ BigDecimal

Returns Minimum price to charge per unit.

Returns:

  • (BigDecimal) —

    Minimum price to charge per unit.




# File 'lib/bitex/order.rb', line 129

#quantity ⇒ BigDecimal

Returns Quantity of specie to sell in this Ask.

Returns:

  • (BigDecimal) —

    Quantity of specie to sell in this Ask.



123
124
125
 
# File 'lib/bitex/order.rb', line 123

def quantity
  @quantity
end

#remaining_quantity ⇒ BigDecimal

Returns Quantity of specie left to sell in this Ask.

Returns:

  • (BigDecimal) —

    Quantity of specie left to sell in this Ask.



127
128
129
 
# File 'lib/bitex/order.rb', line 127

def remaining_quantity
  @remaining_quantity
end

#specie ⇒ Symbol

Returns :btc or :ltc.

Returns:

  • (Symbol) —

    :btc or :ltc




# File 'lib/bitex/order.rb', line 118

#status ⇒ Object

The status of this Ask in its lifecycle.

  • :received queued to check if you have enough funds.

  • :executing available in our ourderbook waiting to be matched.

  • :cancelling To be cancelled as soon as our trading engine unlocks it.

  • :cancelled no further executed. May have some Remaining Quantity.

  • :completed Fully executed, Remaining Quantity should be 0.




# File 'lib/bitex/order.rb', line 132

Class Method Details

.create!(specie, quantity, price) ⇒ Object

Create a new Ask for selling a Quantity of specie charging no less than Price per each.

Parameters:

  • specie (Symbol) —

    :btc or :ltc, whatever you’re selling.

See Also:



149
150
151
152
153
154
155
156
 
# File 'lib/bitex/order.rb', line 149

def self.create!(specie, quantity, price)
  params = {
    amount: quantity,
    price: price,
    specie: {btc: 1, ltc: 2}[specie]
  }
  from_json(Api.private(:post, "/private#{base_path}", params))
end