Module: OandaAPI

Defined in:
lib/oanda_api/errors.rb,
lib/oanda_api/version.rb,
lib/oanda_api/utils/utils.rb,
lib/oanda_api/client/client.rb,
lib/oanda_api/configuration.rb,
lib/oanda_api/resource_base.rb,
lib/oanda_api/resource/order.rb,
lib/oanda_api/resource/price.rb,
lib/oanda_api/resource/trade.rb,
lib/oanda_api/resource/candle.rb,
lib/oanda_api/resource/account.rb,
lib/oanda_api/streaming/client.rb,
lib/oanda_api/resource/position.rb,
lib/oanda_api/streaming/request.rb,
lib/oanda_api/client/json_parser.rb,
lib/oanda_api/resource/heartbeat.rb,
lib/oanda_api/client/token_client.rb,
lib/oanda_api/resource/instrument.rb,
lib/oanda_api/resource_collection.rb,
lib/oanda_api/resource/transaction.rb,
lib/oanda_api/streaming/json_parser.rb,
lib/oanda_api/throttling/throttling.rb,
lib/oanda_api/client/namespace_proxy.rb,
lib/oanda_api/client/username_client.rb,
lib/oanda_api/streaming/adapter_error.rb,
lib/oanda_api/streaming/adapters/gson.rb,
lib/oanda_api/streaming/adapters/yajl.rb,
lib/oanda_api/client/resource_descriptor.rb,
lib/oanda_api/streaming/adapters/generic.rb,
lib/oanda_api/resource/labs/calendar_event.rb,
lib/oanda_api/resource/labs/spread_history.rb,
lib/oanda_api/resource/transaction_history.rb

Defined Under Namespace

Modules: Client, Resource, Streaming, Throttling, Utils Classes: Configuration, RequestError, ResourceBase, ResourceCollection, StreamingDisconnect

Constant Summary collapse

VERSION = 
"0.9.6"
DOMAINS =

List of valid subdomains clients can access.

[:live, :practice, :sandbox]
DATETIME_FORMATS = 
[:rfc3339, :unix]

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration

Returns:



225
226
227
 
# File 'lib/oanda_api/configuration.rb', line 225

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|Configuration| ... } ⇒ void

This method returns an undefined value.

Use to configure application-wide settings.

Examples:

Example Usage

OandaAPI.configure |config|
  config.use_compression = true
  config.use_request_throttling = true
end

Yields:



219
220
221
 
# File 'lib/oanda_api/configuration.rb', line 219

def self.configure
  yield configuration
end