@pontx/currencybeacon-rest

Type-safe TypeScript SDK and CLI for the CurrencyBeacon REST API


Keywords
currencybeacon, currency, exchange-rate, forex, api, sdk, typescript
License
MIT
Install
npm install @pontx/currencybeacon-rest@0.1.3

Documentation

@pontx/currencybeacon-rest

Pontx Hub SDK guide

Type-safe TypeScript SDK and CLI for the CurrencyBeacon v1 REST API.

npm install @pontx/currencybeacon-rest

SDK

import { createCurrencyBeaconClient } from "@pontx/currencybeacon-rest";

const client = createCurrencyBeaconClient({
  apiKey: process.env.PONTX_CURRENCYBEACON_API_KEY,
});

const rates = await client.latest({
  base: "USD",
  symbols: "EUR,GBP",
});

Use authMode: "bearer" to send the same caller-owned key through the Authorization: Bearer header instead of the default query parameter.

CLI

export PONTX_CURRENCYBEACON_API_KEY="..."
pontx-currencybeacon-rest call latest --base USD --symbols EUR,GBP --dry-run

The SDK and CLI connect directly to CurrencyBeacon. They do not proxy, cache, persist, or display supplier responses, and keys are added only at request execution time so dry-run output never includes them.