@tetherto/wdk-pricing-bitfinex-http

Note: This package is in beta. Please test in a dev setup first.

HTTP client for prices from Bitfinex, it uses Bitfinex Public HTTP API to obtain the current price & historical data for given ticker.

It works as a PricingClient for @tetherto/wdk-pricing-provider.

🔍 About WDK

This module is part of the WDK (Wallet Development Kit) project. Learn more at https://docs.wallet.tether.io.

✨ Features

• Compatible with @tetherto/wdk-pricing-provider
• Fetch current price for given ticker (single or batch) via the Bitfinex FX endpoint
• Fetch historical prices given ticker
• Downscales long history to max 100 points

⬇️ Installation

npm install @tetherto/wdk-pricing-bitfinex-http

🚀 Quick Start

import { BitfinexPricingClient } from "@tetherto/wdk-pricing-bitfinex-http";

// Create the client
const client = new BitfinexPricingClient();

// Get latest price
const current = await client.getCurrentPrice("BTC", "USD");

// Get historical prices
const history = await client.getHistoricalPrice("BTC", "USD", {
  start: 1709906400000, // optional
  end: 1709913600000, // optional
});

📚 API Reference

BitfinexPricingClient

Simple HTTP pricing client for Bitfinex.

Constructor

new BitfinexPricingClient(options?)

Parameters:

• options (optional): future use

Methods

| Method | Description | Returns | | ------------------------------------ | --------------------------------- | ---------------------------------------- | | getCurrentPrice(base, quote) | Get latest price | Promise<number \| null> | | getMultiCurrentPrices(pairs) | Get latest prices in a batch | Promise<Array<number \| null>> | | getMultiPriceData(pairs) | Get last price + 24h change batch | Promise<Array<PriceData \| null>> | | getHistoricalPrice(from, to, opts?)| Get price history | Promise<Array<any>> |

getCurrentPrice(base, quote)

Uses the Bitfinex /calc/fx/batch endpoint. Returns null if Bitfinex cannot quote the pair directly (typically a fiat currency it does not list).

const price = await client.getCurrentPrice("BTC", "USD");

getMultiCurrentPrices(pairs)

Resolves many pairs in a single batch request. Results are returned in the same order as the input; a pair Bitfinex cannot quote directly is null.

const prices = await client.getMultiCurrentPrices([
  { from: "BTC", to: "USD" },
  { from: "ETH", to: "USD" },
]);

getMultiPriceData(pairs)

Returns the last price plus 24h absolute and relative change for each pair, from the Bitfinex /tickers endpoint. A currency Bitfinex does not quote directly resolves to null. Results are returned in the same order as the input.

const data = await client.getMultiPriceData([{ from: "BTC", to: "USD" }]);
// [{ lastPrice, dailyChange, dailyChangeRelative }]

getHistoricalPrice(from, to, opts?)

If the list is longer than 100 points, it is downscaled by 2x steps until <= 100.

const series = await client.getHistoricalPrice("BTC", "USD");

⚠️ Limitations

• Currency codes are Bitfinex-specific. You must pass the codes Bitfinex uses, not the common ISO/ticker symbol. For example, Tether is UST (not USDT), and some fiats are only available as tokenized assets such as CNHT or MXNT. Unknown codes resolve to null. The full list is at https://api-pub.bitfinex.com/v2/conf/pub:list:currency.
• Only pairs Bitfinex quotes directly are supported. Fiat currencies Bitfinex does not quote (e.g. BRL, ARS) resolve to null in getCurrentPrice, getMultiCurrentPrices, and getMultiPriceData, and getHistoricalPrice returns an empty array for them (Bitfinex has no historical FX series for such pairs).

🛠️ Development

npm install
npm run lint
npm test

📜 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

🆘 Support

For support, please open an issue on the GitHub repository.