Currencyapi 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Currencyapi --version 1.0.0
NuGet\Install-Package Currencyapi -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Currencyapi" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Currencyapi --version 1.0.0
#r "nuget: Currencyapi, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Currencyapi as a Cake Addin
#addin nuget:?package=Currencyapi&version=1.0.0

// Install Currencyapi as a Cake Tool
#tool nuget:?package=Currencyapi&version=1.0.0

currencyapi-dotnet

currencyapi-dotnet is the official C# package for currencyapi.

Configuration

You will need your apikey to use currencyapi, you can get one https://app.currencyapi.com/register.

Create an instance and pass your api key like here:

var fx = new Currencyapi("[YOUR_API_KEY]");

Usage & Endpoints

Use the instance to call the endpoints

Status

Returns your current quota

fx.status()
Currencies

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
Latest Exchange Rates

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
Historical Exchange Rates

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
Range Historical Exchange Rates

Returns a range of exchange rates. Generally, we provide data going back to 1999.

fx.range(datetime_start, datetime_end, accuracy, baseCurrency, currencies)    
Parameter Data type Mandatory Description
datetime_start string yes Datetime for the start of your requested range (format: 2021-12-31T23:59:59Z / ISO8601 Datetime)
datetime_end string yes Datetime for the start of your requested range (format: 2021-12-31T23:59:59Z / ISO8601 Datetime)
accuracy string no The accuracy you want to receive. Possible Values: day, hour, quarter_hour, minute Default: day For valid time ranges see below
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
Convert Exchange Rates

Returns calculated values for today or any given date for all currencies.

fx.convert(value, date, baseCurrency, currencies)
Parameter Data type Mandatory Description
value string yes The value you want to convert
date string no 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://currencyapi.com/docs/

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Bug reports and pull requests are welcome on GitHub at https://github.com/everapihq/currencyapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Currencyapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.1

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 7,577 9/1/2022
1.0.1 139 9/1/2022
1.0.0 154 9/1/2022