Module: Alpaca::News::Api

Defined in:
lib/alpaca/news/api.rb,
lib/alpaca/news/api/base.rb,
lib/alpaca/news/api/error.rb,
lib/alpaca/news/api/version.rb,
lib/alpaca/news/api/rest/base.rb,
lib/alpaca/news/api/rest/news.rb,
lib/alpaca/news/api/models/news.rb,
lib/alpaca/news/api/rest/client.rb,
lib/alpaca/news/api/models/event.rb,
lib/alpaca/news/api/configuration.rb,
lib/alpaca/news/api/realtime/base.rb,
lib/alpaca/news/api/realtime/news.rb,
lib/alpaca/news/api/realtime_news.rb,
lib/alpaca/news/api/historical_news.rb,
lib/alpaca/news/api/realtime/client.rb,
lib/alpaca/news/api/rest/collection.rb

Defined Under Namespace

Modules: Models, Realtime, Rest Classes: Base, Configuration, Error, HistoricalNews, RealtimeNews

Constant Summary collapse

VERSION = 
'0.1.3'

Class Method Summary collapse

Class Method Details

.configure {|Alpaca::News::Api::Configuration| ... } ⇒ Alpaca::News::Api::Configuration

Current API configuration

Yields:

Returns:



12
13
14
15
16
 
# File 'lib/alpaca/news/api.rb', line 12

def configure
  @configuration ||= Configuration.new(default_options)
  yield(@configuration) if block_given?
  @configuration
end

.default_options ⇒ Hash

Default options hash with :host

Returns:

  • (Hash) 


22
23
24
25
26
27
28
 
# File 'lib/alpaca/news/api.rb', line 22

def default_options
  {
    host: 'data.alpaca.markets',
    stream: 'stream.data.alpaca.markets',
    client_options: {}
  }
end