Module: Tradier::API::Watchlists

Includes:

Utils

Included in:

Client

Defined in:

lib/tradier/api/watchlists.rb

Instance Method Summary

• #add_watchlist_item(id, options = {}) ⇒ Tradier::Watchlist (also: #create_watchlist_item, #create_watchlist_symbol, #add_watchlist_symbol)

  Update a watchlist symbol.

• #create_watchlist(options = {}) ⇒ Tradier::Watchlist

  Create a new watchlist.

• #delete_watchlist(id, options = {}) ⇒ Boolean

  Delete a watchlist.

• #remove_watchlist_item(id, symbol, options = {}) ⇒ Tradier::Watchlist (also: #delete_watchlist_item, #remove_watchlist_symbol, #delete_watchlist_symbol)

  Remove a watchlist symbol.

• #update_watchlist(id, options = {}) ⇒ Tradier::Watchlist

  Update a watchlist.

• #update_watchlist_item(id, symbol, options = {}) ⇒ Tradier::WatchlistItem (also: #update_watchlist_symbol)

  Update a watchlist symbol.

• #watchlist(id, options = {}) ⇒ Tradier::Watchlist

  Get a watchlist.

• #watchlist_item(id, symbol, options = {}) ⇒ Tradier::WatchlistItem (also: #watchlist_symbol)

  Retrieve a watchlist symbol.

• #watchlists(options = {}) ⇒ Array<Tradier::Watchlist>

  Get all watchlists.

Instance Method Details

#add_watchlist_item(id, options = {}) ⇒ Tradier::Watchlist Also known as: create_watchlist_item, create_watchlist_symbol, add_watchlist_symbol

Update a watchlist symbol.

Options Hash (options):

• :symbols (String) —

  A comma delimited list of symbols.

Raises:

• (Tradier::Error::BadRequest) —

  Error raised when request is not valid.

• (Tradier::Error::NotFound) —

  Error raised when watchlist is not found.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/add-watchlist-symbol

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 94

def add_watchlist_item(id, options={})
  object_from_response(Tradier::WatchlistItem, :post, "/watchlists/#{id}/symbols", options)
end

#create_watchlist(options = {}) ⇒ Tradier::Watchlist

Create a new watchlist.

Options Hash (options):

• :name (String) —

  The watchlist name.

Raises:

• (Tradier::Error::BadRequest) —

  Error raised when request is not valid.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/create-watchlist

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 51

def create_watchlist(options={})
  object_from_response(Tradier::Watchlist, :post, '/watchlists', options)
end

#delete_watchlist(id, options = {}) ⇒ Boolean

Delete a watchlist.

Raises:

• (Tradier::Error::NotFound) —

  Error raised when watchlist is not found.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/delete-watchlist

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 38

def delete_watchlist(id, options={})
  send(:delete, "/watchlists/#{id}", options)[:status] == 200
end

#remove_watchlist_item(id, symbol, options = {}) ⇒ Tradier::Watchlist Also known as: delete_watchlist_item, remove_watchlist_symbol, delete_watchlist_symbol

Remove a watchlist symbol.

Raises:

• (Tradier::Error::NotFound) —

  Error raised when watchlist or watchlist item is not found.

• (Tradier::Error::BadRequest) —

  Error raised when request is not valid.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/remove-watchlist-symbol

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 111

def remove_watchlist_item(id, symbol, options={})
  send(:delete, "/watchlists/#{id}/symbols/#{symbol}", options)[:status] == 200
end

#update_watchlist(id, options = {}) ⇒ Tradier::Watchlist

Update a watchlist.

Options Hash (options):

• :name (String) —

  The watchlist name.

Raises:

• (Tradier::Error::BadRequest) —

  Error raised when request is not valid.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/update-watchlist

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 65

def update_watchlist(id, options={})
  object_from_response(Tradier::Watchlist, :put, "/watchlists/#{id}", options)
end

#update_watchlist_item(id, symbol, options = {}) ⇒ Tradier::WatchlistItem Also known as: update_watchlist_symbol

Update a watchlist symbol.

Options Hash (options):

• :shares (String) —

  The number of shares.

• :purchase_date (String) —

  The purchase date.

• :purchase_price (String) —

  The purchase price.

Raises:

• (Tradier::Error::NotFound) —

  Error raised when watchlist or watchlist item is not found.

• (Tradier::Error::BadRequest) —

  Error raised when request is not valid.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/update-watchlist-symbol

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 132

def update_watchlist_item(id, symbol, options={})
  object_from_response(Tradier::WatchlistItem, :put, "/watchlists/#{id}/symbols/#{symbol}", options)
end

#watchlist(id, options = {}) ⇒ Tradier::Watchlist

Get a watchlist.

Raises:

• (Tradier::Error::NotFound) —

  Error raised when watchlist is not found.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/get-specific-watchlist

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 26

def watchlist(id, options={})
  object_from_response(Tradier::Watchlist, :get, "/watchlists/#{id}", options)
end

#watchlist_item(id, symbol, options = {}) ⇒ Tradier::WatchlistItem Also known as: watchlist_symbol

Retrieve a watchlist symbol.

Raises:

• (Tradier::Error::NotFound) —

  Error raised when watchlist or watchlist item is not found.

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/update-watchlist

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 78

def watchlist_item(id, symbol, options={})
  object_from_response(Tradier::WatchlistItem, :get, "/watchlists/#{id}/symbols/#{symbol}", options)
end

#watchlists(options = {}) ⇒ Array<Tradier::Watchlist>

Get all watchlists.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/watchlists/get-watchlists

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/tradier/api/watchlists.rb', line 14

def watchlists(options={})
  response = object_from_response(Tradier::API::Utils::Watchlist, :get, '/watchlists', options).body
end