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 150

#id ⇒ Integer

Returns This Ask’s unique ID.

Returns:

  • (Integer) —

    This Ask’s unique ID.




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

#price ⇒ BigDecimal

Returns Minimum price to charge per unit.

Returns:

  • (BigDecimal) —

    Minimum price to charge per unit.




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

#quantity ⇒ BigDecimal

Returns Quantity of specie to sell in this Ask.

Returns:

  • (BigDecimal) —

    Quantity of specie to sell in this Ask.



158
159
160
 
# File 'lib/bitex/order.rb', line 158

def quantity
  @quantity
end

#reason ⇒ Object

The cancellation reason of this Ask.

  • :not_cancelled Has not been cancelled.

  • :not_enough_funds Not enough funds to place this order.

  • :user_cancelled Cancelled per user’s request

  • :system_cancelled Bitex cancelled this order, for a good reason.




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

#remaining_quantity ⇒ BigDecimal

Returns Quantity of specie left to sell in this Ask.

Returns:

  • (BigDecimal) —

    Quantity of specie left to sell in this Ask.



162
163
164
 
# File 'lib/bitex/order.rb', line 162

def remaining_quantity
  @remaining_quantity
end

#specie ⇒ Symbol

Returns :btc or :ltc.

Returns:

  • (Symbol) —

    :btc or :ltc




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

#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 167

Class Method Details

.create!(specie, quantity, price, wait = false) ⇒ 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.

  • quantity (BigDecimal) —

    Quantity to sell.

  • price (BigDecimal) —

    Minimum price to charge when selling.

  • wait (Boolean) (defaults to: false) —

    Block the process and wait until this ask moves out of the :received state, defaults to false.

See Also:



195
196
197
 
# File 'lib/bitex/order.rb', line 195

def self.create!(specie, quantity, price, wait=false)
  super
end