CurrencyCoreApi class

Constructors

CurrencyCoreApi(Dio _dio, Serializers _serializers)

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

ai({required String q, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<AiResponse>>

AI Ask a natural-language currency question; the model answers using live rates.

convert({required String from, required String to, num? amount, bool? ppp, String? date, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<ConvertResponse>>

Convert Convert an amount between currencies, optionally PPP-adjusted.

correlation({required String currencies, String? base_, String? from, String? to, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<CorrelationResponse>>

Correlation Correlation of each currency's daily returns with a base currency's, over a window. Growth plan or higher.

countries({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<CountriesResponseInner>>>

Countries The supported countries and their official currencies. Public, no key needed.

currencies({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<CurrenciesResponseInner>>>

Currencies The full list of supported ISO 4217 currencies. Use it to resolve a name or symbol to its code, or to check whether a currency is supported (so a missing one fails clearly, not silently). Public, no key needed.

drawdown({String? currency, String? base_, String? from, String? to, String? sort, String? universe, num? limit, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<DrawdownResponse>>

Drawdown Maximum peak-to-trough decline vs a base (with peak/trough/recovery), or a drawdown ranking. Growth plan or higher.

history({required String currency, String? from, String? to, String? base_, String? interval, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<HistoryResponse>>

History A single currency's daily rate time series over a date range. Growth plan or higher.

historyAnalysis({String? base_, String? currencies, String? from, String? to, String? period, String? sort, String? assetClass, num? limit, String? interval, bool? stats, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<HistoryAnalysisResponse>>

History analysis Trends, comparisons & 'movers': % change, strength, and min/max/avg over a window. Growth plan or higher.

meanReversion({String? currencies, String? base_, String? from, String? to, num? limit, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<MeanReversionResponse>>

Mean reversion Ranks currencies by how strongly they revert to their mean (crossing frequency + reversion half-life). Growth plan or higher.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pppAnalysis({String? countries, String? from, String? to, String? period, String? sort, num? limit, bool? stats, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<PppAnalysisResponse>>

PPP analysis PPP over time: how a country's purchasing-power-parity factor changed, comparing countries, or 'movers'. Growth plan or higher.

rates({String? date, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<RatesResponse>>

Rates The full exchange-rate snapshot for a date (USD base).

ratesByBase({required String base_, String? date, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<RatesByBaseResponse>>

Rates by base The same snapshot re-expressed against any base currency.

safeHaven({String? currencies, String? base_, String? from, String? to, num? limit, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<SafeHavenResponse>>

Safe haven Ranks currencies by a composite safe-haven score (low volatility + shallow drawdown + 2008-crisis resilience). Growth plan or higher.

toString() → String

A string representation of this object.

inherited

volatility({String? currency, String? base_, String? from, String? to, String? sort, String? universe, num? limit, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<VolatilityResponse>>

Volatility Annualized volatility of a currency vs a base, or a stability ranking of the liquid currencies. Growth plan or higher.

Operators

operator ==(Object other) → bool

The equality operator.

inherited