Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.28 KB

README.md

File metadata and controls

46 lines (27 loc) · 1.28 KB

Omniauth::Td::Ameritrade

An omni-auth strategy to authenticate with TD Ameritrade's developer API.

Get your API key at: https://developer.tdameritrade.com

Note that TD Ameritrade only provides Client ID. No Client Secret is provided or necessary when making the API call.

This implementation is useful when you need your access tokens automatically refreshed for servers that manage your portfolio.

I am doubtful, users would really be keen to login to your system and allow you direct access their portfolio's management

Installation

Add this line to your application's Gemfile:

gem 'omniauth-td-ameritrade'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-td-ameritrade

Usage

Here's an example for adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :amtd, ENV['AMERITRADE_CLIENT_ID'], nil
end

Contributing

  1. Fork it ( https://github.com/[my-github-username]/omniauth-td-ameritrade/fork )
  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 a new Pull Request