@currencycore/sdk 0.1.0

package/dist/apis/index.d.ts

@@ -0,0 +1 @@
+export * from './CurrencyCoreApi';

package/dist/apis/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./CurrencyCoreApi"), exports);

package/dist/client.d.ts

@@ -0,0 +1,21 @@
+import { CurrencyCoreApi } from './apis';
+export interface CreateClientOptions {
+    /**
+     * API key (e.g. `cc_live_...`). Falls back to the `CURRENCYCORE_API_KEY`
+     * environment variable on Node. Omit it for the public reference endpoints
+     * (`countries`, `currencies`).
+     */
+    apiKey?: string;
+    /**
+     * Full base URL override. Falls back to `CURRENCYCORE_BASE_URL`, otherwise
+     * the public host with the chosen `version`.
+     */
+    baseUrl?: string;
+    /** API version segment of the default base URL. Defaults to `v1`. */
+    version?: string;
+}
+/**
+ * Build a configured {@link CurrencyCoreApi}. Resolves the API key and base URL
+ * from explicit options first, then the environment.
+ */
+export declare function createClient(options?: CreateClientOptions): CurrencyCoreApi;

package/dist/client.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = createClient;
+/* tslint:disable */
+/* eslint-disable */
+const runtime_1 = require("./runtime");
+const apis_1 = require("./apis");
+const DEFAULT_HOST = 'https://api.currency-core.com';
+function fromEnv(name) {
+    // Guarded: `process` does not exist in the browser / React Native.
+    return typeof process !== 'undefined' && process.env ? process.env[name] : undefined;
+}
+/**
+ * Build a configured {@link CurrencyCoreApi}. Resolves the API key and base URL
+ * from explicit options first, then the environment.
+ */
+function createClient(options = {}) {
+    var _a, _b, _c, _d;
+    const apiKey = (_a = options.apiKey) !== null && _a !== void 0 ? _a : fromEnv('CURRENCYCORE_API_KEY');
+    const version = (_b = options.version) !== null && _b !== void 0 ? _b : 'v1';
+    const basePath = (_d = (_c = options.baseUrl) !== null && _c !== void 0 ? _c : fromEnv('CURRENCYCORE_BASE_URL')) !== null && _d !== void 0 ? _d : `${DEFAULT_HOST}/${version}`;
+    return new apis_1.CurrencyCoreApi(new runtime_1.Configuration({ basePath, accessToken: apiKey }));
+}

package/dist/esm/apis/CurrencyCoreApi.d.ts

@@ -0,0 +1,297 @@
+/**
+ * CurrencyCore API
+ * Edge-native currency exchange, PPP, and FX analytics API. Authenticate with your API key as `Authorization: Bearer <key>`.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AiResponse, ConvertResponse, CorrelationResponse, CountriesResponseInner, CurrenciesResponseInner, DrawdownResponse, HistoryAnalysisResponse, HistoryResponse, MeanReversionResponse, PppAnalysisResponse, RatesByBaseResponse, RatesResponse, SafeHavenResponse, VolatilityResponse } from '../models/index';
+export interface AiRequest {
+    q: string;
+}
+export interface ConvertRequest {
+    from: string;
+    to: string;
+    amount?: number;
+    ppp?: boolean;
+    date?: string;
+}
+export interface CorrelationRequest {
+    currencies: string;
+    base?: string;
+    from?: string;
+    to?: string;
+}
+export interface DrawdownRequest {
+    currency?: string;
+    base?: string;
+    from?: string;
+    to?: string;
+    sort?: string;
+    universe?: string;
+    limit?: number;
+}
+export interface HistoryRequest {
+    currency: string;
+    from?: string;
+    to?: string;
+    base?: string;
+    interval?: string;
+}
+export interface HistoryAnalysisRequest {
+    base?: string;
+    currencies?: string;
+    from?: string;
+    to?: string;
+    period?: string;
+    sort?: string;
+    assetClass?: string;
+    limit?: number;
+    interval?: string;
+    stats?: boolean;
+}
+export interface MeanReversionRequest {
+    currencies?: string;
+    base?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface PppAnalysisRequest {
+    countries?: string;
+    from?: string;
+    to?: string;
+    period?: string;
+    sort?: string;
+    limit?: number;
+    stats?: boolean;
+}
+export interface RatesRequest {
+    date?: string;
+}
+export interface RatesByBaseRequest {
+    base: string;
+    date?: string;
+}
+export interface SafeHavenRequest {
+    currencies?: string;
+    base?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface VolatilityRequest {
+    currency?: string;
+    base?: string;
+    from?: string;
+    to?: string;
+    sort?: string;
+    universe?: string;
+    limit?: number;
+}
+/**
+ *
+ */
+export declare class CurrencyCoreApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for ai without sending the request
+     */
+    aiRequestOpts(requestParameters: AiRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Ask a natural-language currency question; the model answers using live rates.
+     * AI
+     */
+    aiRaw(requestParameters: AiRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AiResponse>>;
+    /**
+     * Ask a natural-language currency question; the model answers using live rates.
+     * AI
+     */
+    ai(requestParameters: AiRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AiResponse>;
+    /**
+     * Creates request options for convert without sending the request
+     */
+    convertRequestOpts(requestParameters: ConvertRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Convert an amount between currencies, optionally PPP-adjusted.
+     * Convert
+     */
+    convertRaw(requestParameters: ConvertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConvertResponse>>;
+    /**
+     * Convert an amount between currencies, optionally PPP-adjusted.
+     * Convert
+     */
+    convert(requestParameters: ConvertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConvertResponse>;
+    /**
+     * Creates request options for correlation without sending the request
+     */
+    correlationRequestOpts(requestParameters: CorrelationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Correlation of each currency\'s daily returns with a base currency\'s, over a window. Growth plan or higher.
+     * Correlation
+     */
+    correlationRaw(requestParameters: CorrelationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CorrelationResponse>>;
+    /**
+     * Correlation of each currency\'s daily returns with a base currency\'s, over a window. Growth plan or higher.
+     * Correlation
+     */
+    correlation(requestParameters: CorrelationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CorrelationResponse>;
+    /**
+     * Creates request options for countries without sending the request
+     */
+    countriesRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * The supported countries and their official currencies. Public, no key needed.
+     * Countries
+     */
+    countriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CountriesResponseInner>>>;
+    /**
+     * The supported countries and their official currencies. Public, no key needed.
+     * Countries
+     */
+    countries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CountriesResponseInner>>;
+    /**
+     * Creates request options for currencies without sending the request
+     */
+    currenciesRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * Currencies
+     */
+    currenciesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CurrenciesResponseInner>>>;
+    /**
+     * 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.
+     * Currencies
+     */
+    currencies(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CurrenciesResponseInner>>;
+    /**
+     * Creates request options for drawdown without sending the request
+     */
+    drawdownRequestOpts(requestParameters: DrawdownRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Maximum peak-to-trough decline vs a base (with peak/trough/recovery), or a drawdown ranking. Growth plan or higher.
+     * Drawdown
+     */
+    drawdownRaw(requestParameters: DrawdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DrawdownResponse>>;
+    /**
+     * Maximum peak-to-trough decline vs a base (with peak/trough/recovery), or a drawdown ranking. Growth plan or higher.
+     * Drawdown
+     */
+    drawdown(requestParameters?: DrawdownRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DrawdownResponse>;
+    /**
+     * Creates request options for history without sending the request
+     */
+    historyRequestOpts(requestParameters: HistoryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * A single currency\'s daily rate time series over a date range. Growth plan or higher.
+     * History
+     */
+    historyRaw(requestParameters: HistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HistoryResponse>>;
+    /**
+     * A single currency\'s daily rate time series over a date range. Growth plan or higher.
+     * History
+     */
+    history(requestParameters: HistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HistoryResponse>;
+    /**
+     * Creates request options for historyAnalysis without sending the request
+     */
+    historyAnalysisRequestOpts(requestParameters: HistoryAnalysisRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Trends, comparisons & \'movers\': % change, strength, and min/max/avg over a window. Growth plan or higher.
+     * History analysis
+     */
+    historyAnalysisRaw(requestParameters: HistoryAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HistoryAnalysisResponse>>;
+    /**
+     * Trends, comparisons & \'movers\': % change, strength, and min/max/avg over a window. Growth plan or higher.
+     * History analysis
+     */
+    historyAnalysis(requestParameters?: HistoryAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HistoryAnalysisResponse>;
+    /**
+     * Creates request options for meanReversion without sending the request
+     */
+    meanReversionRequestOpts(requestParameters: MeanReversionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Ranks currencies by how strongly they revert to their mean (crossing frequency + reversion half-life). Growth plan or higher.
+     * Mean reversion
+     */
+    meanReversionRaw(requestParameters: MeanReversionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MeanReversionResponse>>;
+    /**
+     * Ranks currencies by how strongly they revert to their mean (crossing frequency + reversion half-life). Growth plan or higher.
+     * Mean reversion
+     */
+    meanReversion(requestParameters?: MeanReversionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MeanReversionResponse>;
+    /**
+     * Creates request options for pppAnalysis without sending the request
+     */
+    pppAnalysisRequestOpts(requestParameters: PppAnalysisRequest): Promise<runtime.RequestOpts>;
+    /**
+     * PPP over time: how a country\'s purchasing-power-parity factor changed, comparing countries, or \'movers\'. Growth plan or higher.
+     * PPP analysis
+     */
+    pppAnalysisRaw(requestParameters: PppAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PppAnalysisResponse>>;
+    /**
+     * PPP over time: how a country\'s purchasing-power-parity factor changed, comparing countries, or \'movers\'. Growth plan or higher.
+     * PPP analysis
+     */
+    pppAnalysis(requestParameters?: PppAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PppAnalysisResponse>;
+    /**
+     * Creates request options for rates without sending the request
+     */
+    ratesRequestOpts(requestParameters: RatesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The full exchange-rate snapshot for a date (USD base).
+     * Rates
+     */
+    ratesRaw(requestParameters: RatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RatesResponse>>;
+    /**
+     * The full exchange-rate snapshot for a date (USD base).
+     * Rates
+     */
+    rates(requestParameters?: RatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RatesResponse>;
+    /**
+     * Creates request options for ratesByBase without sending the request
+     */
+    ratesByBaseRequestOpts(requestParameters: RatesByBaseRequest): Promise<runtime.RequestOpts>;
+    /**
+     * The same snapshot re-expressed against any base currency.
+     * Rates by base
+     */
+    ratesByBaseRaw(requestParameters: RatesByBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RatesByBaseResponse>>;
+    /**
+     * The same snapshot re-expressed against any base currency.
+     * Rates by base
+     */
+    ratesByBase(requestParameters: RatesByBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RatesByBaseResponse>;
+    /**
+     * Creates request options for safeHaven without sending the request
+     */
+    safeHavenRequestOpts(requestParameters: SafeHavenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Ranks currencies by a composite safe-haven score (low volatility + shallow drawdown + 2008-crisis resilience). Growth plan or higher.
+     * Safe haven
+     */
+    safeHavenRaw(requestParameters: SafeHavenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SafeHavenResponse>>;
+    /**
+     * Ranks currencies by a composite safe-haven score (low volatility + shallow drawdown + 2008-crisis resilience). Growth plan or higher.
+     * Safe haven
+     */
+    safeHaven(requestParameters?: SafeHavenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SafeHavenResponse>;
+    /**
+     * Creates request options for volatility without sending the request
+     */
+    volatilityRequestOpts(requestParameters: VolatilityRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Annualized volatility of a currency vs a base, or a stability ranking of the liquid currencies. Growth plan or higher.
+     * Volatility
+     */
+    volatilityRaw(requestParameters: VolatilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VolatilityResponse>>;
+    /**
+     * Annualized volatility of a currency vs a base, or a stability ranking of the liquid currencies. Growth plan or higher.
+     * Volatility
+     */
+    volatility(requestParameters?: VolatilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VolatilityResponse>;
+}