Rubygem for interacting with the Tradier API.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gemtest
.gitignore
.rspec switch to default rspec formatter Sep 5, 2014
.travis.yml
.yardopts updated YARD options Nov 5, 2013
Gemfile remove dependency on guard Sep 5, 2014
LICENSE.md
README.md
Rakefile
tradier.gemspec

README.md

Tradier

Gem Version Build Status Dependency Status Coverage Status

Rubygem for interacting with the Tradier API.

Installation

gem install tradier

Usage

Create an instance of a Tradier::Client:

require 'tradier'

client = Tradier::Client.new(:access_token => 'token')

Placing Orders

Orders can be placed using the create_order method. Here are some basic examples:

Place an equity order:

client.create_order({
  :account  => '123456789'
  :class    => 'equity',
  :symbol   => 'AAPL',
  :duration => 'day',
  :side     => 'buy',
  :quantity => '100',
  :type     => 'market'
})

Placing an option order:

client.create_order({
  :account       => '123456789'
  :class         => 'option',
  :symbol        => 'AAPL',
  :option_symbol => 'AAPL140118C00195000',
  :duration      => 'day',
  :side          => 'buy',
  :quantity      => '100',
  :type          => 'market'
})

For a complete list of the types of orders accepted, refer to Tradier's trading API documentation

Interacting with Accounts

Obtain a user's profile/accounts:

client.profile

Balances

Obtain an account's balances:

client.balance('12345678')

Positions

Obtain an account's positions

client.positions('12345678')

Obtain positions for all of a user's accounts:

client.positions

Orders

Obtain an account's order

client.orders('12345678')

Obtain order for all of a user's accounts:

client.orders

Market Data

To obtain a quote, simply request:

client.quote('SYMBOL')

Or multiple quotes at one time:

client.quote(['SYMBOL', 'SYMBOL2'])

Option chains can be requested using a symbol and expiration:

client.chain('SYMBOL', :expiration => '2013-11-14')

Refer to the complete documentation for a complete listing of methods and classes.

Copyright

Copyright (c) 2013 Tradier Inc. See LICENSE for detail.