npm:xcoin.compliancedesk

README

Xcoin Compliance Desk Documentation

Setting the Authentication API Key

The prefered authentication method within the compliance desk's backend is the setting of the API key. This key is a special key which provides access to all underlying records within the exchange platform. This is done but initialsing a compliace desk instance with the backend url, the auth id and the associated key.

let xcc = new XCC('http://127.0.0.1:8000/rest', 1, '1234567890123456789012345678901234567890123456789012345678901234');

The compilance desk module consists of uses the xcoin filter object in order to enable paging and other filtering.

The Filter object can be initialised via this comamnd.

let filter = new this.xcoin.factories.filter();

Settings a page offset can be done by means of the offset method within the filter object

filter.offset(0, 100);
filter.range(min, high); // Is a filter method used to select a range of transaction ids.


This should be all you need to know about the filtering object.

The Methods used to interact with the exchange in a way complementing to the needs of the compliance desk ar as follows

Filter helper methods; These are just quick methods to help with an automatically incremented filter for easy pagination;

    XCComplianceDesk.prototype.reset = function() {
        this.filter = new this.xcoin.factories.filter();
        this.filter.offset(0, 100);
    }

    XCComplianceDesk.prototype.setDateRange = function(list, from, to) {
        this.filter.dateRange(from, to);
    }

    XCComplianceDesk.prototype.setOffset = function(list, offset, limit) {
        this.filter.offset(offset, limit);
    }

    XCComplianceDesk.prototype.setRange = function(list, from, to) {
        this.filter.range(from, to);
    }


Retrival methods;

    XCComplianceDesk.prototype.getTransactions = function(currency_eqv, filter=null)

        The currency_eqv is the iso code of the currency value you would like to retreive. The filter is optional, if omitted the internal pagination filter is used.

    XCComplianceDesk.prototype.exchangeTradingHistory = function(filter)

        Retrieval of exchange trading history

    XCComplianceDesk.prototype.getTotalBalanceByIds = function(account_ids)

    XCComplianceDesk.prototype.getBalancesByUser = function(user_id)

    XCComplianceDesk.prototype.getMoneyOverview = function(time, timeframe, count)

Usage no npm install needed!

README