freecurrencyapi-ruby is the official Ruby Wrapper around the freecurrencyapi.
Add this line to your application's Gemfile:
gem 'freecurrencyapi'
And then execute:
$ bundle
Or install it yourself as:
$ gem install freecurrencyapi
You will need your apikey to use freecurrencyapi, you can get one https://app.freecurrencyapi.com/register here.
Create an instance and pass your api key like here:
fx = freecurrencyapi::Endpoints.new(:apikey => 'APIKEY')
Use the instance to call the endpoints
Returns your current quota
fx.status()
Returns all our supported currencies
fx.currencies(currencies)
| Parameter | Data type | Mandatory | Description | ------------| --- | ----------- | --- | ----------- | | currencies | string | no | A list of comma seperated currency codes which you want to get (EUR,USD,CAD). By default all available currencies will be shown |
Returns the latest exchange rates. The default base currency is USD.
fx.latest(base_currency, currencies)
| Parameter | Data type | Mandatory | Description |
|---|---|---|---|
| base_currency | string | no | By default all values are based on USD. By default all values are based on USD |
| currencies | string | no | A list of comma seperated currency codes which you want to get (EUR,USD,CAD). By default all available currencies will be shown |
Returns the latest exchange rates. The default base currency is USD.
fx.historical(date, base_currency, currencies)
| Parameter | Data type | Mandatory | Description |
|---|---|---|---|
| date | string | yes | Date to retrieve historical rates from (format: 2021-12-31) |
| base_currency | string | no | By default all values are based on USD. By default all values are based on USD |
| currencies | string | no | A list of comma seperated currency codes which you want to get (EUR,USD,CAD). By default all available currencies will be shown |
You can find further information on https://freecurrencyapi.com/docs/
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Bug reports and pull requests are welcome on GitHub at https://github.com/everapihq/freecurrencyapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the freecurrencyapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.