falconx-node

library2.0.2jsnpmunverified

Official Node.js REST client for FalconX institutional digital asset brokerage APIs. Version 2.0.2 provides access to quoting, execution, and order management endpoints. The client supports both ESM and CommonJS, with TypeScript type definitions available. Key differentiator: streamlined access to FalconX's liquidity network for crypto trading. Release cadence is intermittent, tied to API updates.

finance

npm install falconx-node

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · FALCONX-NODE

falconx-node

financejavascriptv2.0.2

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.

FalconxClient

✓ import FalconxClient from 'falconx-node'

✗ const { FalconxClient } = require('falconx-node')

Default export, not named export.

FalconxClient

✓ const FalconxClient = require('falconx-node')

✗ const { FalconxClient } = require('falconx-node')

CommonJS: use default require, not destructuring.

FalconxClient type

✓ import FalconxClient from 'falconx-node'

✗ import { FalconxClient } from 'falconx-node'

TypeScript: default import works; no named type export.

Demonstrates authentication, quote retrieval, and order execution using the FalconX client.

import FalconxClient from 'falconx-node'; const apiKey = process.env.FALCONX_API_KEY ?? ''; const secretKey = process.env.FALCONX_SECRET_KEY ?? ''; const passphrase = process.env.FALCONX_PASSPHRASE ?? ''; const client = new FalconxClient(apiKey, secretKey, passphrase); async function main() { try { const quote = await client.getQuote('ETH', 'USD', 0.1, 'two_way'); console.log('Quote:', quote); const executed = await client.executeQuote(quote.fx_quote_id, 'sell'); console.log('Executed:', executed); } catch (err) { console.error('Error:', err); } } main();

Debug

Known issues

deprecatedv3 flag has been removed. Do not pass v3 parameter.

fix

Remove any v3 flag from request options.

affects: >=2.0.0

breakingAll trading requests now default to faster v3 endpoints; previous v2 endpoints may be deprecated.

fix

Update to version 2.0.0+ and remove any endpoint version overrides.

affects: >=2.0.0

gotchaImport is default export, not named export.

fix

Use import FalconxClient from 'falconx-node' not import { FalconxClient }.

affects: *

gotchaCommonJS require must be default, not destructured.

fix

Use const FalconxClient = require('falconx-node').

affects: *

Errors

Common errors & fixes

TypeError: FalconxClient is not a constructor

Using named import instead of default import.

fix

Change import { FalconxClient } to import FalconxClient.

Cannot find module 'falconx-node'

Package not installed or missing from node_modules.

fix

Run 'npm install falconx-node'.

Error: API key validation failed

Missing or incorrect API key, secret, or passphrase.

fix

Ensure environment variables are set correctly.

Upgrade

Version history

2.0.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

28 hits · last 30 days

node

Resources

githubhttps://github.com/falconxio/falconx-node ↗

packagefalconx-node ↗

homepagehttps://github.com/falconxio/falconx-node#readme ↗