Skip to content

Commit

Permalink
create new repo structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Joss Crowcroft committed Aug 14, 2012
1 parent 0ab50f7 commit a79a285
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -0,0 +1 @@
.DS_Store
37 changes: 34 additions & 3 deletions README.md
@@ -1,4 +1,35 @@
open-exchange-rates-2
=====================
# Open Exchange Rates API

Code, examples and libraries for working with the Open Exchange Rates API (https://openexchangerates.org)
**[Open Exchange Rates](http://openexchangerates.org)** is a free, real-time JSON API that provides exchange rates (forex/fx rates) for 150+ currencies, relative to USD.

Rates are collected from several reliable sources and blending together algorithmically, to acheive a consistent and unbiased level of cross-market accuracy.

You can use these data anywhere and in any language - whether performing JavaScript currency conversion on the client-side (eg. for a web app, smartphone app or online shopping cart - try **[money.js](http://josscrowcroft.github.com/money.js)**) or for back-end processing (eg. databases, dashboards, analytics, accounting, tickers, desktop software, whatever).

The latest exchange rates are available on **[openexchangerates.org](http://openexchangerates.org)**, along with historical EOD (end of day) rates going back to January 1999, with HTTPS support, optional JSONP callback and friendly `Access-Control` HTTP headers - so you can load it in via AJAX with a cross-domain request without worrying about browser security restrictions.

To get the data, you just need to access `latest.json` via AJAX, CURL, Scrapy, node-httpagent, or your method of choice. There's a bunch of **[documentation](http://openexchangerates.org/documentation)** and examples/sample projects are coming to this repo very soon.

You can sign up easily at the **[signup](https://openexchangerates.org/signup)** page - any questions, **[send Joss an email](mailto:joss@openexchangerates.org)**!


## Accuracy

As with all exchange rate data, accuracy can never be guaranteed when you're not paying through the teeth for the service - and when money changes currencies, everyone takes a cut - so it's a good idea to inform people that these are for informational purposes only, something like "Converted prices/exchange rates are for informational purposes only." Feel free to say that rates come from the Open Exchange Rates service.


## Homepage and documentation:

Check out **[openexchangerates.org](http://openexchangerates.org)** for all the info.

There are guides for most languages, with more on the way. If you're working in client-side or server-side Javascript, check out **[money.js](http://josscrowcroft.github.com/money.js)**, a tiny (1kb) JavaScript currency conversion library.


## Legal

There's a License, Terms and Conditions and Privacy Policy available on **[openexchangerates.org](http://openexchangerates.org)**, which you are required to read and understand before querying the data.


## Future

This Git repository will soon be updated with working code samples and example projects for using the API and data.
3 changes: 3 additions & 0 deletions examples/readme.md
@@ -0,0 +1,3 @@
# Open Exchange Rates - Usage Examples

Coming soon!
3 changes: 3 additions & 0 deletions libraries/readme.md
@@ -0,0 +1,3 @@
# Open Exchange Rates - API Libraries

Coming soon!

0 comments on commit a79a285

Please sign in to comment.