sintaxi / falconx-node

Node JS client for FalconX REST API

Overview

This is the official NodeJS client for the FalconX API.

API Documentation: http://docs.falconx.io

Installation

npm i -S falconx-node

OR

yarn add falconx-node

Quickstart

import FalconxClient from 'falconx-node';

const fxClient = new FalconxClient(apiKey, secretKey, passphrase);
fxClient.getQuote('ETH', 'USD', 0.1, 'two_way').then(quote => {
    fxClient.executeQuote(quote.fx_quote_id, 'sell').then(executedQuote => {
        console.log(executedQuote);
    });
});

New Order Endpoint

A new faster endpoint is now available to place orders. The same can be used as mentioned in the below sample. Optional argument 'v3'. If the argument is not passed, the old order (v1/order) endpoint is used.

import FalconxClient from 'falconx-node';

const fxClient = new FalconxClient(apiKey, secretKey, passphrase);

options = {
    client_order_id: '<some client order id>'
}

fxClient.placeOrder('ETH', 'USD', 0.1, 'sell', 'market', options, v3=true).then(quote => {
    fxClient.executeQuote(quote.fx_quote_id, 'sell').then(executedQuote => {
        console.log(executedQuote);
    });
});

About FalconX

FalconX is an institutional digital asset brokerage.