@allratestoday/sdk 1.0.0

package/README.md

@@ -0,0 +1,90 @@
+# @allratestoday/sdk
+
+Official JavaScript/TypeScript SDK for the [AllRatesToday](https://allratestoday.com) exchange rate API.
+
+Real-time mid-market exchange rates for 160+ currencies, sourced from Reuters (Refinitiv) and interbank market feeds.
+
+## Installation
+
+```bash
+npm install @allratestoday/sdk
+```
+
+## Quick Start
+
+### Free Public Rates (No API Key)
+
+```typescript
+import AllRatesToday from '@allratestoday/sdk';
+
+const client = new AllRatesToday();
+
+// Get exchange rate
+const rate = await client.getRate('USD', 'EUR');
+console.log(`1 USD = ${rate.rate} EUR`);
+
+// Convert amount
+const result = await client.convert('USD', 'EUR', 100);
+console.log(`$100 = €${result.result}`);
+```
+
+### Authenticated Rates (API Key Required)
+
+```typescript
+import AllRatesToday from '@allratestoday/sdk';
+
+const client = new AllRatesToday({ apiKey: 'art_live_your_key_here' });
+
+// Get authenticated rates
+const rates = await client.getRates('USD', 'EUR');
+console.log(rates);
+
+// Get historical rates
+const history = await client.getHistoricalRates('USD', 'EUR', '30d');
+console.log(history.rates);
+```
+
+## API Reference
+
+### `new AllRatesToday(options?)`
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `apiKey` | `string` | — | Your API key (from [dashboard](https://allratestoday.com/profile)) |
+| `baseUrl` | `string` | `https://allratestoday.com` | API base URL |
+| `timeout` | `number` | `10000` | Request timeout in ms |
+
+### Methods
+
+| Method | Auth | Description |
+|--------|------|-------------|
+| `getRate(from, to, amount?)` | No | Get exchange rate (free) |
+| `convert(from, to, amount)` | No | Convert amount between currencies |
+| `getRates(source, target)` | Yes | Authenticated rate lookup |
+| `getHistoricalRates(source, target, period)` | Yes | Historical rates (1d/7d/30d/1y) |
+
+### Error Handling
+
+```typescript
+import AllRatesToday, { AllRatesTodayError } from '@allratestoday/sdk';
+
+try {
+  const rate = await client.getRate('USD', 'INVALID');
+} catch (err) {
+  if (err instanceof AllRatesTodayError) {
+    console.log(err.message); // Error description
+    console.log(err.status);  // HTTP status code
+  }
+}
+```
+
+## Links
+
+- [API Documentation](https://allratestoday.com/docs)
+- [Get API Key](https://allratestoday.com/profile)
+- [Pricing](https://allratestoday.com/pricing)
+- [Status](https://allratestoday.com/status)
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,71 @@
+interface RateResponse {
+    from: {
+        currency: string;
+        amount: number;
+    };
+    to: {
+        currency: string;
+        amount: number;
+    };
+    rate: number;
+    source: string;
+}
+interface AuthRateResponse {
+    rate: number;
+    source: string;
+    target: string;
+    time: string;
+}
+interface HistoricalRateResponse {
+    source: string;
+    target: string;
+    period: string;
+    current: {
+        rate: number;
+        time: string;
+    };
+    rates: Array<{
+        rate: number;
+        time: string;
+    }>;
+}
+interface AllRatesTodayOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+declare class AllRatesToday {
+    private apiKey?;
+    private baseUrl;
+    private timeout;
+    constructor(options?: AllRatesTodayOptions);
+    private request;
+    /**
+     * Get exchange rate between two currencies (free, no auth required)
+     */
+    getRate(from: string, to: string, amount?: number): Promise<RateResponse>;
+    /**
+     * Get authenticated exchange rate (requires API key)
+     */
+    getRates(source: string, target: string): Promise<AuthRateResponse[]>;
+    /**
+     * Get historical rates (requires API key)
+     */
+    getHistoricalRates(source: string, target: string, period?: '1d' | '7d' | '30d' | '1y'): Promise<HistoricalRateResponse>;
+    /**
+     * Convert an amount from one currency to another
+     */
+    convert(from: string, to: string, amount: number): Promise<{
+        from: string;
+        to: string;
+        amount: number;
+        result: number;
+        rate: number;
+    }>;
+}
+declare class AllRatesTodayError extends Error {
+    status?: number;
+    constructor(message: string, status?: number);
+}
+
+export { AllRatesToday, AllRatesTodayError, type AllRatesTodayOptions, type AuthRateResponse, type HistoricalRateResponse, type RateResponse, AllRatesToday as default };

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+interface RateResponse {
+    from: {
+        currency: string;
+        amount: number;
+    };
+    to: {
+        currency: string;
+        amount: number;
+    };
+    rate: number;
+    source: string;
+}
+interface AuthRateResponse {
+    rate: number;
+    source: string;
+    target: string;
+    time: string;
+}
+interface HistoricalRateResponse {
+    source: string;
+    target: string;
+    period: string;
+    current: {
+        rate: number;
+        time: string;
+    };
+    rates: Array<{
+        rate: number;
+        time: string;
+    }>;
+}
+interface AllRatesTodayOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+declare class AllRatesToday {
+    private apiKey?;
+    private baseUrl;
+    private timeout;
+    constructor(options?: AllRatesTodayOptions);
+    private request;
+    /**
+     * Get exchange rate between two currencies (free, no auth required)
+     */
+    getRate(from: string, to: string, amount?: number): Promise<RateResponse>;
+    /**
+     * Get authenticated exchange rate (requires API key)
+     */
+    getRates(source: string, target: string): Promise<AuthRateResponse[]>;
+    /**
+     * Get historical rates (requires API key)
+     */
+    getHistoricalRates(source: string, target: string, period?: '1d' | '7d' | '30d' | '1y'): Promise<HistoricalRateResponse>;
+    /**
+     * Convert an amount from one currency to another
+     */
+    convert(from: string, to: string, amount: number): Promise<{
+        from: string;
+        to: string;
+        amount: number;
+        result: number;
+        rate: number;
+    }>;
+}
+declare class AllRatesTodayError extends Error {
+    status?: number;
+    constructor(message: string, status?: number);
+}
+
+export { AllRatesToday, AllRatesTodayError, type AllRatesTodayOptions, type AuthRateResponse, type HistoricalRateResponse, type RateResponse, AllRatesToday as default };

package/dist/index.js

@@ -0,0 +1,109 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AllRatesToday: () => AllRatesToday,
+  AllRatesTodayError: () => AllRatesTodayError,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var BASE_URL = "https://allratestoday.com";
+var AllRatesToday = class {
+  constructor(options = {}) {
+    this.apiKey = options.apiKey;
+    this.baseUrl = options.baseUrl || BASE_URL;
+    this.timeout = options.timeout || 1e4;
+  }
+  async request(path, params = {}) {
+    const url = new URL(path, this.baseUrl);
+    for (const [key, value] of Object.entries(params)) {
+      if (value) url.searchParams.set(key, value);
+    }
+    const headers = {};
+    if (this.apiKey) {
+      headers["Authorization"] = `Bearer ${this.apiKey}`;
+    }
+    const response = await fetch(url.toString(), {
+      headers,
+      signal: AbortSignal.timeout(this.timeout)
+    });
+    if (!response.ok) {
+      const error = await response.json().catch(() => ({ error: response.statusText }));
+      throw new AllRatesTodayError(
+        error.error || `HTTP ${response.status}`,
+        response.status
+      );
+    }
+    return response.json();
+  }
+  /**
+   * Get exchange rate between two currencies (free, no auth required)
+   */
+  async getRate(from, to, amount) {
+    const params = { from, to };
+    if (amount !== void 0) params.amount = String(amount);
+    return this.request("/api/public/rates", params);
+  }
+  /**
+   * Get authenticated exchange rate (requires API key)
+   */
+  async getRates(source, target) {
+    if (!this.apiKey) throw new AllRatesTodayError("API key required for authenticated requests");
+    return this.request("/api/v1/rates", { source, target });
+  }
+  /**
+   * Get historical rates (requires API key)
+   */
+  async getHistoricalRates(source, target, period = "7d") {
+    if (!this.apiKey) throw new AllRatesTodayError("API key required for historical rates");
+    return this.request("/api/historical-rates", {
+      source,
+      target,
+      period
+    });
+  }
+  /**
+   * Convert an amount from one currency to another
+   */
+  async convert(from, to, amount) {
+    const data = await this.getRate(from, to, amount);
+    return {
+      from,
+      to,
+      amount,
+      result: data.to.amount,
+      rate: data.rate
+    };
+  }
+};
+var AllRatesTodayError = class extends Error {
+  constructor(message, status) {
+    super(message);
+    this.name = "AllRatesTodayError";
+    this.status = status;
+  }
+};
+var index_default = AllRatesToday;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AllRatesToday,
+  AllRatesTodayError
+});

package/dist/index.mjs

@@ -0,0 +1,83 @@
+// src/index.ts
+var BASE_URL = "https://allratestoday.com";
+var AllRatesToday = class {
+  constructor(options = {}) {
+    this.apiKey = options.apiKey;
+    this.baseUrl = options.baseUrl || BASE_URL;
+    this.timeout = options.timeout || 1e4;
+  }
+  async request(path, params = {}) {
+    const url = new URL(path, this.baseUrl);
+    for (const [key, value] of Object.entries(params)) {
+      if (value) url.searchParams.set(key, value);
+    }
+    const headers = {};
+    if (this.apiKey) {
+      headers["Authorization"] = `Bearer ${this.apiKey}`;
+    }
+    const response = await fetch(url.toString(), {
+      headers,
+      signal: AbortSignal.timeout(this.timeout)
+    });
+    if (!response.ok) {
+      const error = await response.json().catch(() => ({ error: response.statusText }));
+      throw new AllRatesTodayError(
+        error.error || `HTTP ${response.status}`,
+        response.status
+      );
+    }
+    return response.json();
+  }
+  /**
+   * Get exchange rate between two currencies (free, no auth required)
+   */
+  async getRate(from, to, amount) {
+    const params = { from, to };
+    if (amount !== void 0) params.amount = String(amount);
+    return this.request("/api/public/rates", params);
+  }
+  /**
+   * Get authenticated exchange rate (requires API key)
+   */
+  async getRates(source, target) {
+    if (!this.apiKey) throw new AllRatesTodayError("API key required for authenticated requests");
+    return this.request("/api/v1/rates", { source, target });
+  }
+  /**
+   * Get historical rates (requires API key)
+   */
+  async getHistoricalRates(source, target, period = "7d") {
+    if (!this.apiKey) throw new AllRatesTodayError("API key required for historical rates");
+    return this.request("/api/historical-rates", {
+      source,
+      target,
+      period
+    });
+  }
+  /**
+   * Convert an amount from one currency to another
+   */
+  async convert(from, to, amount) {
+    const data = await this.getRate(from, to, amount);
+    return {
+      from,
+      to,
+      amount,
+      result: data.to.amount,
+      rate: data.rate
+    };
+  }
+};
+var AllRatesTodayError = class extends Error {
+  constructor(message, status) {
+    super(message);
+    this.name = "AllRatesTodayError";
+    this.status = status;
+  }
+};
+var index_default = AllRatesToday;
+export {
+  AllRatesToday,
+  AllRatesTodayError,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@allratestoday/sdk",
+  "version": "1.0.0",
+  "description": "Official JavaScript/TypeScript SDK for AllRatesToday exchange rate API",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "exchange-rate",
+    "currency",
+    "forex",
+    "api",
+    "allratestoday",
+    "conversion",
+    "mid-market-rate",
+    "reuters"
+  ],
+  "author": "AllRatesToday <info@allratestoday.com>",
+  "license": "MIT",
+  "homepage": "https://allratestoday.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/allratestoday/sdk-javascript"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  }
+}