OandaApiV20

Gem Version Build Status

Ruby client that supports the Oanda REST API V20 methods.

Installation

Add this line to your application's Gemfile:

gem 'oanda_api_v20'

And then execute:

$ bundle

Or install it yourself as:

$ gem install oanda_api_v20

Usage

Add the following to your ruby program:

require 'oanda_api_v20'

Initialise a client:

client = OandaApiV20.new(access_token: 'my_access_token')

If you would like to trade with your test account:

client = OandaApiV20.new(access_token: 'my_access_token', practice: true)

If you would like to use the streaming endpoints:

client = OandaApiV20.new(access_token: 'my_access_token', stream: true)

If you need your requests to go through a proxy:

client = OandaApiV20.new(access_token: 'my_access_token', proxy_url: 'https://user:[email protected]:80')

You can adjust the persistend connection pool size, the default is 2:

client = OandaApiV20.new(access_token: 'my_access_token', connection_pool_size: 10)

You can adjust the number of requests per second allowed to Oanda API, the default is 100:

client = OandaApiV20.new(access_token: 'my_access_token', max_requests_per_second: 10)

Examples

Accounts

See the Oanda Documentation for all available options on accounts.

client.accounts.show

client.('account_id').show

client.('account_id').summary.show

client.('account_id').instruments.show

client.('account_id').instruments('EUR_USD,EUR_CAD').show

options = { 'sinceTransactionID' => '6358' }

client.('account_id').changes(options).show

options = { alias: 'My New Account #2' }

client.('account_id').configuration(options).update

Instruments

See the Oanda Documentation for all available options on instruments.

options = { count: 10 }

client.instrument('EUR_USD').candles(options).show

Orders

See the Oanda Documentation for all available options on orders.

client.('account_id').orders.show

options = { 'instrument' => 'USD_CAD' }

client.('account_id').orders(options).show

client.('account_id').pending_orders.show

id = client.('account_id').orders.show['orders'][0]['id']

client.('account_id').order(id).show

options = {
  'order' => {
    'units' => '100',
    'instrument' => 'EUR_CAD',
    'timeInForce' => 'FOK',
    'type' => 'MARKET',
    'positionFill' => 'DEFAULT'
  }
}

client.('account_id').order(options).create

id = client.('account_id').orders.show['orders'][0]['id']

options = {
  'order' => {
    'instrument' => 'EUR_CAD',
    'price' => '1.6000',
    'timeInForce' => 'GTC',
    'type' => 'MARKET_IF_TOUCHED',
    'units' => '200',
    'positionFill' => 'DEFAULT'
  }
}

client.('account_id').order(id, options).update

id = client.('account_id').orders.show['orders'][0]['id']

options = {
  'clientExtensions' => {
    'comment' => 'New comment for my limit order'
  }
}

client.('account_id').order(id, options).update

id = client.('account_id').orders.show['orders'][0]['id']

client.('account_id').order(id).cancel

Trades

See the Oanda Documentation for all available options on trades.

options = { 'instrument' => 'USD_CAD' }

client.('account_id').trades(options).show

client.('account_id').open_trades.show

id = client.('account_id').open_trades.show['trades'][0]['id']

client.('account_id').trade(id).show

id = client.('account_id').open_trades.show['trades'][0]['id']

options = {
  'takeProfit' => {
    'timeInForce' => 'GTC',
    'price' => '2.5'
  },
  'stopLoss' => {
    'timeInForce' => 'GTC',
    'price' => '0.5'
  }
}

client.('account_id').trade(id, options).update

id = client.('account_id').open_trades.show['trades'][0]['id']

options = {
  'clientExtensions' => {
    'comment' => 'This is a USD/CAD trade',
    'tag' => 'trade tag',
    'id' => 'my_usd_cad_trade'
  }
}

client.('account_id').trade(id, options).update

id = client.('account_id').open_trades.show['trades'][0]['id']

options = { 'units' => '10' }

client.('account_id').trade(id, options).close

id = client.('account_id').open_trades.show['trades'][0]['id']

client.('account_id').trade(id).close

Positions

See the Oanda Documentation for all available options on positions.

client.('account_id').positions.show

client.('account_id').open_positions.show

client.('account_id').position('EUR_USD').show

options = { 'longUnits' => 'ALL' }

client.('account_id').position('EUR_CAD', options).close

Transactions

See the Oanda Documentation for all available options on transactions.

client.('account_id').transactions.show

options = {
  'from' => '2016-08-01T02:00:00Z',
  'to' => '2016-08-15T02:00:00Z'
}

client.('account_id').transactions(options).show

id = 6410

client.('account_id').transaction(id).show

options = {
  'from' => '6409',
  'to' => '6412'
}

client.('account_id').transactions_id_range(options).show

options = {
  'id' => '6411'
}

client.('account_id').transactions_since_id(options).show

Pricing

See the Oanda Documentation for all available options on pricing.

options = {
  'instruments' => 'EUR_USD,USD_CAD'
}

client.('account_id').pricing(options).show

client = OandaApiV20.new(access_token: 'my_access_token', stream: true)

options = {
  'instruments' => 'EUR_USD,USD_CAD'
}

client.('account_id').pricing_stream(options).show do |json|
  puts json if json['type'] == 'PRICE'
end

Exceptions

A OandaApiV20::ParseError will be raised when a response from the Oanda API is malformed.

A OandaApiV20::RequestError will be raised when a request to the Oanda API failed for any reason.

You can access the original exception in a OandaApiV20::RequestError:

begin
  do_something
rescue OandaApiV20::RequestError => e
  e.original_exception
end

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request