Module: Tradier::API::Markets

Includes:

Utils

Included in:

Client

Defined in:

lib/tradier/api/markets.rb

Instance Method Summary

• #calendar(options = {}) ⇒ Tradier::Calendar

  Obtain the market calendar.

• #chains(symbol, options = {}) ⇒ Array<Tradier::OptionQuote> (also: #chain)

  Obtain an option chain.

• #clock(options = {}) ⇒ Tradier::Clock

  Obtain the market clock.

• #expirations(symbol) ⇒ Array<Date>

  Obtain an underlier's expiration dates.

• #history(symbol, options = {}) ⇒ Array<Tradier::Event>

  Get historical pricing for a given symbol.

• #quotes(symbols, options = {}) ⇒ Array<Tradier::Quote> (also: #quote)

  Obtain quotes.

• #strikes(symbol, expiration) ⇒ Array<String>

  Obtain an underlier's expiration strikes for an expiration date.

• #timesales(symbol, options = {}) ⇒ Array<Tradier::Timesales>

  Get time and sales for a given symbol.

Instance Method Details

#calendar(options = {}) ⇒ Tradier::Calendar

Obtain the market calendar

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/markets/get-calendar

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/markets.rb', line 73

def calendar(options={})
  object_from_response(Tradier::Calendar, :get, '/markets/calendar', options)
end

#chains(symbol, options = {}) ⇒ Array<Tradier::OptionQuote> Also known as: chain

Obtain an option chain.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/markets/get-options-chains

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/markets.rb', line 28

def chains(symbol, options={})
  options.merge!('symbol' => symbol)
  object_from_response(Tradier::API::Utils::OptionQuote, :get, '/markets/options/chains', options).body
end

#clock(options = {}) ⇒ Tradier::Clock

Obtain the market clock

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/markets/get-clock

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/markets.rb', line 63

def clock(options={})
  object_from_response(Tradier::Clock, :get, '/markets/clock', options)
end

#expirations(symbol) ⇒ Array<Date>

Obtain an underlier's expiration dates.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/markets/get-options-expirations

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/markets.rb', line 41

def expirations(symbol)
  object_from_response(Tradier::API::Utils::Expiration, :get, '/markets/options/expirations', :symbol => symbol).body
end

#history(symbol, options = {}) ⇒ Array<Tradier::Event>

Get historical pricing for a given symbol.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/markets/get-history

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/markets.rb', line 96

def history(symbol, options={})
  options.merge!('symbol' => symbol)
  object_from_response(Tradier::API::Utils::History, :get, '/markets/history', options).body
end

#quotes(symbols, options = {}) ⇒ Array<Tradier::Quote> Also known as: quote

Obtain quotes.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/markets/get-quotes

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/markets.rb', line 15

def quotes(symbols, options={})
  options.merge!('symbols' => normalized_symbols(symbols))
  object_from_response(Tradier::API::Utils::Quote, :get, '/markets/quotes', options).body
end

#strikes(symbol, expiration) ⇒ Array<String>

Obtain an underlier's expiration strikes for an expiration date.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/markets/get-options-strikes

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/markets.rb', line 53

def strikes(symbol, expiration)
  object_from_response(Tradier::API::Utils::Strike, :get, '/markets/options/strikes', :symbol => symbol, :expiration => expiration).body
end

#timesales(symbol, options = {}) ⇒ Array<Tradier::Timesales>

Get time and sales for a given symbol.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/markets/get-timesales

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/markets.rb', line 84

def timesales(symbol, options={})
  options.merge!('symbol' => symbol)
  object_from_response(Tradier::API::Utils::Timesales, :get, '/markets/timesales', options).body
end