Currency Rates API

Express API for fetching current foreign exchange rates.

Steps to run the server locally

Install dependencies with the command npm install
Start the server with the command npm run serve
Visit http://localhost:5000/api/rates

API Reference

BASE URL: https://api-currency-rates.herokuapp.com/

`GET /api/rates`

This fetches and returns the latest currency rates .

Query Parameters

base: string (optional) - the home currency rates to be quoted against (i.e. CZK)
currency: string (optional) -the specific exchange rates based on a comma-separated symbols parameter (i.e. EUR,GBP,USD)

Sample Request

curl 'https://api-currency-rates.herokuapp.com/api/rates?base=CZK&currency=EUR,GBP,USD' -X GET

Sample Response

results: object - JSON object containing the results from the API.
base: string - the requested home rate from the request URL query strings.
date: string - the current date.
rates: object - object containing the requested currency in the request URL query strings

{
    "results": {
        "base": "CZK",
        "date": "2020-11-17",
        "rates": {
            "EUR": 0.0377244605,
            "GBP": 0.033795458,
            "USD": 0.044824204
        }
    }
}

Error Handling

Response Object

Errors are returned as JSON in the following format:

{
    "error": 404,
    "message": "The requested resource was not found."
}

Response Keys

error - Status code of the error that occurred.
message - Accompanying error message.

Status Codes

400 (Bad request) - Your request was not properly formatted.
404 (Not found) - The requested resource was not found.
500 (Internal server error) - Something went wrong on the server.

KarenOk/currency-rates-api