Module: Tradier::API::Orders

Includes:

Utils

Included in:

Client

Defined in:

lib/tradier/api/orders.rb

Instance Method Summary

• #cancel_order(options = {}) ⇒ Tradier::Order

  Cancel an order.

• #create_order(options = {}) ⇒ Tradier::Order (also: #place_order, #submit_order)

  Place an order.

• #order(options = {}) ⇒ Tradier::Order

  Retrieve an order.

• #preview_order(options = {}) ⇒ Tradier::Order

  Preview an order.

• #update_order(options = {}) ⇒ Tradier::Order (also: #change_order)

  Update an order.

Instance Method Details

#cancel_order(options = {}) ⇒ Tradier::Order

Cancel an order.

Parameters:

• options (Hash) (defaults to: {})

Options Hash (options):

• :account (String) —

  The account number.

• :id (String) —

  The id of the order.

Returns:

• (Tradier::Order) —

  An order.

Raises:

• (Tradier::Error::BadRequest) —

  Error raised when supplied order is not valid.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/trading/cancel-order

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/orders.rb', line 45

def cancel_order(options={})
  account = options.delete(:account)
  id      = options.delete(:id)
  object_from_response(Tradier::Order, :delete, "/accounts/#{account}/orders/#{id}", options)
end

#create_order(options = {}) ⇒ Tradier::Order Also known as: place_order, submit_order

Place an order.

Parameters:

• options (Hash) (defaults to: {})

Options Hash (options):

• :account (String) —

  The account number.

Returns:

• (Tradier::Order) —

  An order.

Raises:

• (Tradier::Error::BadRequest) —

  Error raised when supplied order is not valid.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/trading/create-order

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/orders.rb', line 17

def create_order(options={})
  account = options.delete(:account)
  object_from_response(Tradier::Order, :post, "/accounts/#{account}/orders", options)
end

#order(options = {}) ⇒ Tradier::Order

Retrieve an order.

Parameters:

• options (Hash) (defaults to: {})

Options Hash (options):

• :account (String) —

  The account number.

• :id (String) —

  The id of the order.

Returns:

• (Tradier::Order) —

  An order.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/accounts/get-account-order

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/orders.rb', line 60

def order(options={})
  account = options.delete(:account)
  id      = options.delete(:id)
  object_from_response(Tradier::Order, :get, "/accounts/#{account}/orders/#{id}", options)
end

#preview_order(options = {}) ⇒ Tradier::Order

Preview an order.

Returns:

• (Tradier::Order) —

  An order.

Raises:

• (Tradier::Error::BadRequest) —

  Error raised when supplied order is not valid.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/trading/preview-order

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/orders.rb', line 31

def preview_order(options={})
  create_order(options.merge(preview: true))
end

#update_order(options = {}) ⇒ Tradier::Order Also known as: change_order

Update an order.

Parameters:

• options (Hash) (defaults to: {})

Options Hash (options):

• :account (String) —

  The account number.

• :id (String) —

  The id of the order.

Returns:

• (Tradier::Order) —

  An order.

Raises:

• (Tradier::Error::BadRequest) —

  Error raised when supplied order is not valid.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/trading/change-order

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/orders.rb', line 76

def update_order(options={})
  account = options.delete(:account)
  id      = options.delete(:id)
  object_from_response(Tradier::Order, :put, "/accounts/#{account}/orders/#{id}", options)
end