Integrate the FCLite API

Brief

The article teaches how to integrate the FCLite API.

Details

How to add the API to your project

To get started, you need a basic understanding of how to create a project in the language of your choice.

Step 1: The first step in adding the FCLite API to your project is to ensure that you have the NPM application installed. Which can be downloaded here: https://www.npmjs.com/

Step 2: The next step is to create a file named .npmrc in the root of your project containing a single command:

@gehtsoft:registry=https://www.myget.org/F/gehtsoft-public/npm/

Ensure that you do not have a VPN connection.

Step 3: Then you should open a command prompt and change to the directory containing your project. Now you need to execute the command:

npm install @gehtsoft/forex-connect-lite

This will download two packages to your project directory: forex-connect-lite to work in a browser and forex-connect-lite-node for node projects.

Now you can access the FCLite API from your project

The full list of classes could be found in the project directory node_modules\@gehtsoft\forex-connect-lite\index.d.ts The example of tsconfig.json.

To access the Login functionality, you will need to connect to the corresponding library endpoints.

typescriptjavascript
import * as FXConnectLite from '@gehtsoft/forex-connect-lite-node';

typescriptjavascript
const sessionFactory = require('@gehtsoft/forex-connect-lite-node').FXConnectLiteSessionFactory;
const IConnectionStatusChangeListener = require('@gehtsoft/forex-connect-lite-node').IConnectionStatusChangeListener;
const ILoginCallback = require('@gehtsoft/forex-connect-lite-node').ILoginCallback;
const LoginError = require('@gehtsoft/forex-connect-lite-node').LoginError;

typescriptjavascript
import * as FXConnectLite from '@gehtsoft/forex-connect-lite';

typescriptjavascript
const sessionFactory = require('@gehtsoft/forex-connect-lite').FXConnectLiteSessionFactory;
const IConnectionStatusChangeListener = require('@gehtsoft/forex-connect-lite').IConnectionStatusChangeListener;
const ILoginCallback = require('@gehtsoft/forex-connect-lite').ILoginCallback;
const LoginError = require('@gehtsoft/forex-connect-lite').LoginError;

The example of tsconfig.json.