fxapi 1.0.0

.NET Standard 2.1

dotnet add package fxapi --version 1.0.0

NuGet\Install-Package fxapi -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="fxapi" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add fxapi --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: fxapi, 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 fxapi as a Cake Addin
#addin nuget:?package=fxapi&version=1.0.0

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

fxapi-dotnet

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

Configuration

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

Create an instance and pass your api key like here:

var fx = new Fxapi("[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://fxapi.com/docs/

Contributing

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/fxapi. 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 fxapi 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.0	187	5/23/2023