https://github.com/oslego/rexapp-server

Server for REX App
https://github.com/oslego/rexapp-server

Last synced: about 1 month ago
JSON representation

Server for REX App

• Host: GitHub
• URL: https://github.com/oslego/rexapp-server
• Owner: oslego
• Created: 2012-10-01T23:34:49.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2014-06-03T15:44:56.000Z (over 10 years ago)
• Last Synced: 2024-04-15T10:48:41.264Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 227 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# REX App Server

Crawler, currency aggregation logic and API for [REX App](https://github.com/oslego/rexapp).

Install

=====

Requirements: 

- [Node.js](http://nodejs.org/) and [npm](https://npmjs.org/)

- [Postgresql](http://www.postgresql.org/) database

Install dependencies

`$ npm install` 

Setup the DB schema. See db-setup.js for database connection string.

`$ node db-setup.js`

Run

=====

`$ node worker.js` for crawler and aggregator. Runs on Cron

`$ node api.js` for exposing API endpoints over HTTP

API

=====

The REX App API returns currency exchange rates available from banks in Romania. All rates are in RON, the national Romanian currency.

All endpoints described in this document must be prefixed with the URL where the server is running, for example `http://localhost:3000`. For brevity, this URL was omitted from the examples below.

Response format

----

All responses come in JSON format.

Get JSONP for easy cross-domain calls by appending `?callback={functionName}` to each call, where {functionName} is the name of your handler function.

Response status

----

**Success**

If the request was successful the response object will have the `status` property set to `ok` along with the requested data.

Example:

`

{

    "status": "ok",

    "rates": ...

}`

**Error**

If the request results in an error the response object will have the `status` property set to `error` and a `message` property with a description of the error.

Example

`

{

    "status": "error",

    "message": "Invalid currency code."

}`

Rates API

----

`GET /v1/rates`

Get all the latest currency exchange rates.

`GET /v1/rates/{currency_code}`

Get all the latest currency exchange rates for a currency code. 

Currency codes are alphabetic codes from the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) standard. 

Supported codes: EUR, USD, AUD, CAD, CHF, SEK, DKK, IKK, NOK, GBP, JPY, HUF, PLN, CZK, RUB, BGN. 

Banks API

-----

`GET /v1/banks`

Get details of banks that provide currency rates: name, url, etc.

Response


{

  "status": "ok",

  "banks": {

    "cec": {

      "name": "CEC Bank",

      "url": "https://www.cec.ro/curs-valutar.aspx"

    },

    

    "bcr": {

      "name": "BCR",

      "url": "http://www.bcr.ro/ro/curs-valutar"

    }


    ...

}