Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timrogers/amex
A library for accessing data on an American Express account
https://github.com/timrogers/amex
Last synced: 13 days ago
JSON representation
A library for accessing data on an American Express account
- Host: GitHub
- URL: https://github.com/timrogers/amex
- Owner: timrogers
- Created: 2012-12-26T12:04:22.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T16:18:56.000Z (about 2 years ago)
- Last Synced: 2024-12-15T02:32:05.381Z (26 days ago)
- Language: Ruby
- Size: 558 KB
- Stars: 30
- Watchers: 6
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## Amex *[(view on RubyGems.org)](http://rubygems.org/gems/amex)*
Welcome to the last continuation of my Ruby-based assault on various online
banking systems, much like my
[Lloyds TSB screen scraper](https://github.com/timrogers/lloydstsb).
However, this one doesn't rely on nasty screen-scraping. Instead, it uses
the previous unknown internal API used by American Express for their
"Amex UK" iPhone app. I suspect it works elsewhere, but I haven't tested.
This allows you to fetch the details of all the cards on your American
Express login, as well as transactions on each card.
*See CHANGELOG.md for a changelog.*
### Usage
The file `example.rb` provides a very simple example of how the code works, but here's a step by step:
1. Ensure the gem is installed, and then include it in your Ruby file, or in your Gemfile where appropriate:
```
$ gem install amex
...
require 'rubygems'
require 'amex'
```
2. You'll just need two variables, @username and @password, each unsurprisingly corresponding to different authentication details used
```
@username = "chuck_norris"
@password = "roundhousekick123"
```
3. Instantiate a new instance of the `Amex::Client` object, passing in the
username and password - this is used to perform the authentication required.
`client = Amex::Client.new(@username, @password)`
4. Call the `account` method of the object you just made - it'll take a few seconds, and will return an Amex::CardAccount object. There'll only be one, since this
only supports one card at a time right now.
```
accounts = client.accounts
my_account = accounts.first
puts my_account.product
puts my_account.type
puts my_account.transactions.inspect
```
### Documentation
You can view the full YARD documentation [here](http://rubydoc.info/github/timrogers/amex/master/frames).
### Examples
* __[amex_alerts](https://github.com/timrogers/amex-alerts)__, a script
designed to be run as a cron which tracks and alerts you on your rewards
balances
### License
Use this for what you will, as long as it isn't evil. If you make any changes or cool improvements, please let me know at .