deriv-api

deriv-api

Async Websocket API for deriv.app

Code Coverage:

Usage

There are two ways to establish a connection:

• Use a previously opened connection:

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

• Pass the arguments needed to create a connection:

  import DerivAPI from 'DerivAPI';
  
  const api = new DerivAPI({ endpoint: 'ws://...', appId: 1003, lang: 'EN' });
  

For more detailed examples see the wiki See also: DerivAPI reference

Development

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