Forex API Documentation

Use our interactive documentation and code generation to get going in seconds


GET/v1/convert

This endpoint makes an HTTP GET request to convert an amount from one currency to another using the forex API. The request URL includes parameters for the source currency (from), target currency (to), and the amount to be converted.

Header(s)

x-api-key required
Value should be your API Key- get one here

Query Parameter(s)

fromrequired
From currency input
torequired
To currency input
amountrequired
Amount to convert input

Example Request

  • Axios
  • Native
  • Request
  • Unirest
Loading...

GET/v1/multi-convert

This endpoint performs an HTTP GET request to retrieve the converted amounts for the specified currencies based on a given amount in a base currency. The request should include the base currency code ("from"), target currency codes ("to"), and the amount to be converted.

Header(s)

x-api-key required
Value should be your API Key- get one here

Query Parameter(s)

fromrequired
From currency input
torequired
To currency input [multi-choice-currencies]
amountrequired
Amount to convert input

Example Request

  • Axios
  • Native
  • Request
  • Unirest
Loading...

GET/v1/live-rates

This endpoint retrieves the live forex rates for the specified base currency and target currency codes. Amounts in base_currency can be multiplied by the rates in the response to achieve the converted amounts values

Header(s)

x-api-key required
Value should be your API Key- get one here

Query Parameter(s)

base_currency_coderequired
From currency input
currency_codesrequired
To currency input [multi-choice-currencies]

Example Request

  • Axios
  • Native
  • Request
  • Unirest
Loading...

GET/v1/supported-currencies

This HTTP GET request retrieves a list of available currencies. Use the 'search' query parameter to filter the results or leave it blank to return all supported currencies

Header(s)

x-api-key required
Value should be your API Key- get one here

Query Parameter(s)

searchoptional
Search avaliable currencies that are supported using codes or names

Example Request

  • Axios
  • Native
  • Request
  • Unirest
Loading...