README.md

DerivAPI

Async Websocket API for deriv-app

Code Coverage:

Requirement:

Node.js (v12.18.0 or higher is recommended)

Installation

NPM

npm install @deriv/deriv-api

yarn

yarn add @deriv/deriv-api

Usage

Basic library

The basic library is a lighter version of the Deriv API, suitable for apps that want to directly deal with API calls.

It can either be imported as a separate module (to reduce the final bundle size) or if the DerivAPI library is already imported, can be accessed using api.basic.

const api = new DerivAPI({...args});
const basic = api.basic;

basic.ping().then(console.log);

ES6 modules

Basic API

// Smaller bundle size, dealing only with the low-level library
import DerivAPIBasic from '@deriv/deriv-api/dist/DerivAPIBasic';

const api = new DerivAPIBasic({app_id: /* your app_id */ });

CommonJS modules

Basic API

// Smaller bundle size, dealing only with the low-level library
const DerivAPIBasic = require('@deriv/deriv-api/dist/DerivAPIBasic');

const api = new DerivAPIBasic({app_id: /* your app_id */ });

Using the HTML script tag

Basic API

<script src="https://unpkg.com/@deriv/deriv-api/dist/DerivAPIBasic.js"></script>
<script>
const api = new DerivAPIBasic({app_id: /* your app_id */ });
/* rest of your code */
</script>

Creating a WebSocket connection

There are two ways to establish a connection:

1. Use a previously opened connection:

   const connection = new WebSocket('ws://...');
   const api        = new DerivAPI({ connection });

2. Pass the arguments needed to create a connection:

   const api = new DerivAPI({ endpoint: 'ws://...', app_id: /* your app_id */, lang: 'EN' });

Documentation

Wiki

There is a short tutorial about how to use Deriv API in the wiki page.

API reference

The complete API reference is hosted here

The above reference in one page: DerivAPI reference

Development

git clone https://github.com/binary-com/deriv-api
cd deriv-api
npm install

To run the tests

npm test

Run tests automatically on source code edits

npm run devel

Run linter

npm run syntax

Run all tests (lint + js tests)

npm run test_all

Prettify the code (done automatically on commit)

npm run prettify

Generate documentations

npm run docs

Regenerate docs automatically on source code edit

Needs inotify to work.

npm run devel_docs

Serve docs on localhost and update on source code changes

npm run serve_docs

Generate html version of the docs and publish it to gh-pages

npm run gh-pages

Build the package

npm run build

Run examples

DERIV_TOKEN=YourTokenHere npm run examples