liquid-tap

library0.3.6jsnpmunverified

Liquid Tap is the official WebSocket API client for the Liquid cryptocurrency exchange (formerly Quoine). Version 0.3.6 provides real-time market data and account updates via a WebSocket connection. It supports TypeScript types and can be used in Node.js and browser environments. Key differentiators include automatic reconnection, promise-based event binding, and simplified authentication token management. The library is maintained by Quoine Financial and follows a monthly release cadence.

messaging finance

npm install liquid-tap

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · LIQUID-TAP

liquid-tap

messagingjavascriptv0.3.6

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

TapClient

✓ import { TapClient } from 'liquid-tap'

✗ const TapClient = require('liquid-tap')

Library provides named export; default export is not available. Use ES import syntax.

CLIENT_EVENTS

✓ import { CLIENT_EVENTS } from 'liquid-tap'

✗ import { ClientEvents } from 'liquid-tap'

CLIENT_EVENTS is a named export with uppercase convention. Case-sensitive.

TapClient

✓ import { TapClient } from 'liquid-tap'

✗ import TapClient from 'liquid-tap'

Default import is not supported; library only exports named symbols.

Demonstrates initializing TapClient with API credentials, subscribing to a public channel, and handling connection events.

// Install via npm: npm install liquid-tap // Ensure you have a Liquid API token: https://app.liquid.com/settings/api-tokens import { TapClient } from 'liquid-tap'; const tap = new TapClient({ tokenId: process.env.LIQUID_TOKEN_ID ?? '', tokenSecret: process.env.LIQUID_TOKEN_SECRET ?? '', }); // Bind to connected event tap.bind('connected', (data) => { console.log('Connected! Reconnect:', data.reconnect); }); // Subscribe to a public channel const channel = tap.subscribe('product_cash_btcsgd_7'); channel.bind('updated', (data) => { console.log('Update:', data); }); // Connect to the WebSocket tap.connect();

Debug

Known issues

gotchaThe default WebSocket host is 'tap.liquid.com' on port 433. Ensure your network allows WebSocket connections to this host.

fix

Use the 'wsHost' and 'wsPort' options to configure a custom endpoint if needed.

affects: >=0.1.0

deprecatedEvent names like 'CONNECTED' and 'AUTH_SUCCESS' are not officially documented. Use the CLIENT_EVENTS constants or lowercase event strings (e.g., 'connected').

fix

Use CLIENT_EVENTS.CONNECTED or the string 'connected'.

affects: >=0.3.0

gotchaThe library does not export a default export. Using default import (import TapClient from 'liquid-tap') will result in undefined.

fix

Use named import: import { TapClient } from 'liquid-tap'.

affects: >=0.1.0

Errors

Common errors & fixes

Uncaught TypeError: tap.bind is not a function

Using tap.bind before creating an instance (e.g., TapClient.bind instead of new TapClient().bind).

fix

Initialize with 'new TapClient()' then call bind on the instance.

Error: Cannot find module 'liquid-tap'

Package not installed or not in node_modules.

fix

Run 'npm install liquid-tap' or add it to dependencies.

Error: The first authentication argument must be the token id

Missing or incorrect tokenId/tokenSecret passed to TapClient constructor.

fix

Provide valid tokenId and tokenSecret from Liquid API settings.

Upgrade

Version history

0.3.6latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

39 hits · last 30 days

node

Resources

githubhttps://github.com/QuoineFinancial/liquid-tap-js ↗

packageliquid-tap ↗

homepagehttps://github.com/QuoineFinancial/liquid-tap-js#readme ↗