ForexRateAPI

forexrateapi is the official Swift wrapper for ForexRateAPI.com. This allows you to quickly integrate our API and foreign exchange rate API into your application. Check https://forexrateapi.com documentation for more information.

Installation

We offer multiple ways to install our library.

Cocoapods

In your Podfile, specify:

pod ForexRateAPI

Carthage

In your Cartfile, specify:

github "ForexRateAPI"

Swift Package Manager

In Xcode, select File ▸ Swift Packages ▸ Add Package Dependency… and use the url: https://github.com/forexrateapi/forexrateapi-swift.git

Usage

import ForexRateAPI

apiKey = 'SET_YOUR_API_KEY_HERE'
let client = ForexRateAPIService(apiKey: apiKey)

---

Documentation

fetchSymbols()

client.fetchSymbols(completion: { result in
  // do something
})

Link

---

fetchLive(base, currencies)

• base <string> Optional. Pass in a base currency, defaults to USD.
• currencies <List<string>> Optional. Pass in an list of currencies to return values for.

client.fetchLive(base: "USD", currencies: ["AUD", "XAG", "GBP", "JPY"], completion: { result in
  // do something
})

Link

---

fetchHistorical(date, base, currencies)

• date <string> Required. Pass in a string with format YYYY-MM-DD
• base <string> Optional. Pass in a base currency, defaults to USD.
• currencies <List<string>> Optional. Pass in an list of currencies to return values for.

clientfetchHistorical(date: "2021-04-05", base: "USD", currencies: ["AUD", "XAG", "GBP", "JPY"], completion: { result in
  // do something
})

Link

---

ohlc(base, currency, date, date_type)

• base <string> Optional. Pass in a base currency, defaults to USD.
• currency <string> Required. Specify currency you would like to get OHLC for.
• date <string> Required. Specify date to get OHLC for specific date using format YYYY-MM-DD.
• date_type <string> Optional. Pass in a date type, overrides date parameter if passed in.

client.ohlc(base: "USD", currency: "EUR", date: "2021-04-05", dateType: nil, completion: { result in
  // do something
})

Link

---

convert(from_currency, to_currency, amount, date)

• from_currency <string> Optional. Pass in a base currency, defaults to USD.
• to_currency <string> Required. Specify currency you would like to convert to.
• amount <number> Required. The amount to convert.
• date <string> Optional. Specify date to use historical midpoint value for conversion with format YYYY-MM-DD. Otherwise, it will use live exchange rate date if value not passed in.

client.convert(fromCurrency: "USD", toCurrency: "EUR", amount: 100.0, date: "2021-04-05", completion: { result in
  // do something
})

Link

---

timeframe(start_date, end_date, base, currencies)

• start_date <string> Required. Specify the start date of your timeframe using the format YYYY-MM-DD.
• end_date <string> Required. Specify the end date of your timeframe using the format YYYY-MM-DD.
• base <string> Optional. Pass in a base currency, defaults to USD.
• currencies <List<string>> Optional. Pass in an list of currencies to return values for.

client.timeframe(startDate: "2021-04-05", endDate: "2021-04-06", base: "USD", currencies: ["AUD", "XAG", "GBP", "JPY"], completion: { result in
  // do something
})

Link

---

change(start_date, end_date, base, currencies)

• start_date <string> Required. Specify the start date of your timeframe using the format YYYY-MM-DD.
• end_date <string> Required. Specify the end date of your timeframe using the format YYYY-MM-DD.
• base <string> Optional. Pass in a base currency, defaults to USD.
• currencies <List<string>> Optional. Pass in an list of currencies to return values for.

client.change(startDate: "2021-04-05", endDate: "2021-04-06", base: "USD", currencies: ["AUD", "XAG", "GBP", "JPY"], completion: { result in
  // do something
})

Link

---

usage()

client.usage(completion: { result in
  // do something
})

Link

---

Official documentation

---

FAQ

• How do I get an API Key?

  Free API Keys are available here.

• I want more information

  Checkout our FAQs here.

Support

For support, get in touch using this form.