FXRate

Yet another foreign exchange rate API project.

---

Usage

Test URL: https://fxrate.186526.eu.org/

Web UI: 186526/fxrate-web (Still work in progress)

Rest API v1 Usage

• GET (/v1)/info - show instance's details.

type source = string;

interface result {
    status: 'ok' as string;
    sources: source[];
    version: string;
    apiVersion: 'v1';
    environment: 'production' | 'development';
}

export default result;

• GET (/v1)/:source/ - show source's details.

enum currency {
    // For example
    USD = 'USD';
}

type UTCString = string;

interface result {
    status: 'ok' as string;
    source: source;
    currency: currency[];
    date: UTCString;
}

export default result;

• GET (/v1)/:source/:from(?reverse&precision&amount&fees) - show currency's FX rates to other currency in source's db.

// query use ?reverse means calculating how much currency is needed to obtain the $amount $from currency is needed.
// query use ?precision means get data rounded to $precision decimal place. use -1 as the flag means that getting infinite recurrent decimal.
// query use ?amount means convert from/to $amount currency.
// query use ?fees means add $fees% ftf.
interface FXRate {
    updated: UTCString;
    // number: 721.55
    // string: 721.(55)
    cash: number | string | false;
    remit: number | string | false;
    middle: number | string;
}

interface result {
    [to in keyof curreny]: FXRate;
}

return result;

• GET (/v1)/:source/:from/:to(?reverse&precision&amount&fees) - show currency's FX rates to other currency in source's db.

type result = FXRate;

export default result;

• GET (/v1)/:source/:from/:to/:type(/:amount)(?reverse&precision&amount&fees) - show currency's FX rates to other currency in source's db.

type result = FXRate;

export default result[type];

JSONRPC v2 API Usage

Endpoint (/v1)/jsonrpc/v2

• instanceInfo

  Params: undefined
  Response: Follow GET (/v1)/info

• listCurrencies

  Params:

  {
      source: string;
  }

  Response: Follow GET (/v1)/:source/

• listFXRates

  Params:

  {
      source: string;
      from: currency;
      precision: number = 2;
      amount: number = 100;
      fees: number = 0;
      reverse: boolean = false;
  }

  Response: Follow GET (/v1)/:source/:from(?reverse&precision&amount&fees)

• getFXRates

  Params:

  {
      source: string;
      from: currency;
      to: currency;
      type: 'remit' | 'cash' | 'middle' | 'all';
      precision: number = 2;
      amount: number = 100;
      fees: number = 0;
      reverse: boolean = false;
  }

  Response: Follow GET (/v1)/:source/:from/:to/:type(/:amount)(?reverse&precision&amount&fees)

Running

Some APIs require configuration tokens to work properly.

environment variables	value	details	defaults
ENABLE_WISE	1 | 0	Enable Wise FX Rates API	0
WISE_TOKEN	string	configure Wise's API Token	null
WISE_SANDBOX_API	1 | 0	Using Wise's sandbox API environment.	0
ENABLE_CORS	domain	configure FXRate's API to allow CORS	null
HEADER_USER_AGENT	userAgentString	configure spider to use which user agent to fetch from site	fxrate axios/latest

yarn install
yarn dev

## In production

yarn start

License

The program's code is under MIT LICENSE (SEE LICENSE IN LICENSE.MIT).

Data copyright belongs to its source (SEE LICENSE IN LICENSE.DATA).