Overview

The REST JSON/XML API has support for currency conversion, IP lookup services, and general information on currencies and countries.

Countries

GET countries/{id}?format={format}

Provides information about supported countries.

Response Class

Country {
    TwoLetterCountryCode(string): Two-character ISO 3166 country code
    EnglishName(string): English name of the country
    NativeName(string): Native name of the country
    CurrencyEnglishName(string): English name of the currency used by the country
    CurrencyNativeName(string): Native name of the currency used by the country
    CurrencySymbol(string): Currency symbol associated with the currency used by the country
    CurrencyNativeFormatting(string): Currency accounting format pattern for positive and negative currency values
    ThreeLetterCurrencyCode(string): Three-character ISO 4217 currency code of the currency used by the country
}

Try Request

Name Value Description
id Unique Country Identifier. If omitted, then all supported countries are returned.
format Overrides the preferred media type of the Request Accept Header

    

Currencies

GET currencies/{id}?format={format}

Provides information about supported currencies.

Response Class

Currency {
    ThreeLetterCurrencyCode(string): Three-character ISO 4217 currency code
    NumericCurrencyCode(int): Three-digit ISO 4217 currency code
    EnglishName(string): English name of the currency
    DecimalDigits(int): Number of decimal places to use in currency values
    Countries(array[string]): Two-character ISO 3166 country code of all countries using the currency
}

Try Request

Name Value Description
id Unique Currency Identifier. If omitted, then all supported currencies are returned
format Overrides the preferred media type of the Request Accept Header

    

Exchange

GET exchange?amount={amount}&from={from}&to={to}&token={token}

Exchanges an amount from one currency to another.

Response Class

Money {
    Amount(number): The amount of money
    Currency(Currency): The currency of the money
}
Currency {
    ThreeLetterCurrencyCode(string): Three-character ISO 4217 currency code
    NumericCurrencyCode(int): Three-digit ISO 4217 currency code
    EnglishName(string): English name of the currency
    DecimalDigits(int): Number of decimal places to use in currency values
    Countries(array[string]): Two-character ISO 3166 country code of all countries using the currency
}

Try Request

Name Value Description
amount The amount of the from currency to exchange from
from Currency Identifier of the currency to exchange from
to Currency Identifier of the currency to exchange to
token Subscription Token
format Overrides the preferred media type of the Request Accept Header

    

IPAddress

GET ipaddress?token={token}&format={format}

Gets your IP host address.

Response Class

string: IP version 4 address

Try Request

Name Value Description
token Subscription Token
format Overrides the preferred media type of the Request Accept Header