API Reference

Package: `@tetherto/wdk-pricing-bitfinex-http`

Class: `BitfinexPricingClient`

Simple HTTP pricing client for Bitfinex Public REST API.

Constructor

Create Client

new BitfinexPricingClient(options?)

options (optional): reserved for future use

Methods

Method	Description	Returns
`getCurrentPrice(base, quote)`	Fetch latest price for base/quote pair	`Promise<number>`
`getHistoricalPrice({ from, to, start?, end? })`	Fetch historical series (downscaled to ≤ 100 points if needed)	`Promise<any[]>`

`getCurrentPrice(base, quote)`

Current Price

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

`getHistoricalPrice({ from, to, start?, end? })`

If the returned series exceeds 100 points, it is downscaled by powers of two until ≤ 100.

Historical Prices

const series = await client.getHistoricalPrice({
  from: 'BTC',
  to: 'USD',
  start: 1709906400000, // optional
  end:   1709913600000  // optional
})

Package: `@tetherto/wdk-pricing-provider`

Class: `PricingProvider`

Cache-aware wrapper providing a unified API over a PricingClient implementation.

Constructor

Create Provider

new PricingProvider({
  client,                 // required: implements PricingClient
  priceCacheDurationMs    // optional: defaults to 1h
})

client: instance implementing the PricingClient contract
priceCacheDurationMs (number, optional): cache TTL for last price in ms (default 3,600,000)

Methods

Method	Description	Returns
`getLastPrice(base, quote)`	Returns cached last price; refreshes when TTL expires	`Promise<number>`
`getHistoricalPrice({ from, to, start?, end? })`	Delegates to client for historical data	`Promise<any[]>`

`getLastPrice(base, quote)`

Last Price with Caching

const provider = new PricingProvider({ client })
const last = await provider.getLastPrice('BTC', 'USD')

`getHistoricalPrice({ from, to, start?, end? })`

Historical via Provider

const hist = await provider.getHistoricalPrice({ from: 'BTC', to: 'USD' })

Interface: `PricingClient` (abstract)

Implement this interface to plug your data source into PricingProvider.

Method	Signature	Notes
`getCurrentPrice`	`(from: string, to: string) => Promise<number>`	Should return spot price
`getHistoricalPrice`	`(opts: { from: string, to: string, start?: number, end?: number }) => Promise<any[]>`	Return series for charting

Notes

Uses Bitfinex Public HTTP API (/v2/ticker and /v2/candles) under the hood for the Bitfinex client
Provider caches last price per pair using in-memory store and TTL

Need Help?

Discord CommunityConnect with developers, ask questions, share your projects

Join Community

GitHub IssuesReport bugs, request features, and get technical help

Open an Issue

Email ContactFor sensitive or private matters, contact our team directly

Send an email

API Reference

On this page