acx v1.3.9

ACX API & WebSocket Utilities

This projectis designed to help you make your own projects that interact with the ACX Exchange.

ACX is ambitious, awesome, advanced and Australian. Since 2013, we've taken the complexity out of trading and owning digital currencies for everyone in Australian and beyond. Our goal at ACX is to provide the highest quality, instant and simplified purchasing experience for customers looking to acquire Blockchain Backed assets, starting with Bitcoin.

Read Full Usage Guide On GitHub

What's new

• New parameter "market" has been introduced in clearOrder request.
• New function "deleteOrders" which allow user to cancel multiple orders.

Getting started

Installation

npm install acx --save

Prerequisites

To get started, you need to request for access/secret key at first. Please visit ACX API Reference for more information.

REST API Usage

Initialise

const ACX = require('acx');
var acx = new ACX({maret:"dashbtc", access_key:<access_key>, secret_key:<secret_key>);

const ACX = require('acx');
var acx = new ACX({maret:"dashbtc", access_key:<access_key>, secret_key:<secret_key>, tradeFee:0.001);

Functions

Get my account information

acx.getMyAccount().then(data => {
    console.log(data);
}).catch(e => { console.error(e); });

Get recent trades on the market

acx.getMarketTrades().then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

acx.getMarketTrades({from:7476198, order_by:'asc'}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

acx.getMarketTrades({timestamp:1522904400}).then(data => {
    console.log(data);
}).catch(e => { console.error(e); });

Get my trade history

Get recent 50 trades in descending order.

acx.getMyTrades().then(data => {
    console.log(data);
}).catch(e => { console.error(e); });

You can also specify other parameters to narrow down results.

acx.getMyTrades({from:7476198, order_by:'asc'}).then(data => {
    console.log(data);
}).catch(e => { console.error(e); });

acx.getMyTrades({timestamp:1522904400}).then(data => {
    console.log(data);
}).catch(e => { console.error(e); });

Get my open orders

Get my recent open orders.

acx.getOrders().then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

acx.getOrders().then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

acx.getOrders({ state: 'wait' }).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

acx.getOrders({ limit: 2, page: 2 }).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Update my order by order id

This function has been abandoned.

Get my orders by order id

Get information of specified order by order id

acx.getOrderById(536786).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Get my deposits history

Get my deposits history by currency value(contains btc, aud, bch, eth, hsr, fuel, ubtc, eet, dash).

acx.getDeposits().then(data=>{
    console.log(data)
}).catch(e => { console.error(e); });

acx.getDeposits({ currency: 'aud' }).then(data=>{
    console.log(data)
}).catch(e => { console.error(e); });

acx.getDeposits({ state: 'submitting', limit: 10 }).then(data=>{
    console.log(data)
}).catch(e => { console.error(e); });

Get my deposit by txid

acx.getDeposit('mock29c5de23a0dfc10648fb5f128ff5bd140e153a5a99d0208b9f3d755e29721137').then(data => {
    console.log(data)
});

Get my deposit address by currency

acx.getDepositAddress('btc').then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Create multiple sell/buy orders

Create multiple sell/buy orders by list of order objects. Response status message will be displayed.

acx.placeOrders([
        {side: 'sell', price: 0.04452900, volume: 0.1},
        {side: 'sell', price:0.04452800, volume: 0.2}
    ]).then(data => { console.log(data)
}).catch(e => { console.error(e); });

Cancel an order

Cancel a specific order by order id

acx.deleteOrder(536791).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Bulk cancel orders

Delete orders by ids

acx.deleteOrders('23,24,26').then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Clear orders

acx.clearOrders();

acx.clearOrders().then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Alternatively, you can also cancel your orders by market and side(buy/sell)

acx.clearOrders({market: 'btcaud', side:'buy'}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Get order book by market

acx.getOrderBook({market:'btcaud'}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

acx.getOrderBook({market:'btcaud', asks_limit:10, bids_limit: 20}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Function will return the order book for the market which you have defined when you create the acx object if you haven't specified the market parameter.

acx.getOrderBook().then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Get market depth

acx.getDepth({market:'btcaud'}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

acx.getDepth({market:'btcaud', limit:1000}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Function will return the depth of the market which you have defined when you create the acx object if you haven't specified the market parameter.

acx.getDepth().then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

acx.getDepth({limit:1000}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Get OHLC(K Line) of specific market

//Time period of K line, default to 1. You can choose between 1, 5, 15, 30, 60, 120, 240, 360, 720, 1440, 4320, 10080
acx.getKLine({period:5}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Function will return the OHLC of the market which you have defined when you create the acx object if you haven't specified the market parameter.

acx.getKLine().then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Get K data with pending trades

Get K data with pending trades, which are the trades not included in K data yet, because there's delay between trade generated and processed by K data generator.

//Time period of K line, default to 1. You can choose between 1, 5, 15, 30, 60, 120, 240, 360, 720, 1440, 4320, 10080
acx.getKLineWithPendingTrades({period:5}).then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Function will return the OHLC of the market which you have defined when you create the acx object if you haven't specified the market parameter.

acx.getKLineWithPendingTrades().then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Get server current time

Get server current time, in seconds since Unix epoch.

acx.getServerTimestamp().then(data => {
    console.log(data)
});

Get your cryptocurrency withdraws

Function will return your recent cryptocurrency withdraws if limit not set.

acx.getWithdraws().then(data=>{
    console.log(data)
}).catch(e => { console.error(e); });

Set more parameters to get cryptocurrency withdraws

acx.getWithdraws({currency: 'aud'}).then(data=>{
    console.log(data)
}).catch(e => { console.error(e); });

acx.getWithdraws({currency: 'aud', state: 'accepted', limit: 10}).then(data=>{
    console.log(data)
}).catch(e => { console.error(e); });

Get your cryptocurrency withdraw by id

acx.getWithdrawById('25').then(data => {
    console.log(data)
}).catch(e => { console.error(e); });

Create a withdraw

acx.createWithdraw({sum:0.001, address: <'Crypto-currency address'>}).then(data => { 
    console.log(data)
}).catch(e => { console.error(e); });

WebSocket Usage

Initialise WebSocket

acx.initWebSorket();

Trades WebSocket

acx.onTradeChanged((data) => {
    console.log(data);
});

Orderbook WebSocket

acx.onOrderbookChanged(['btcaud','ethaud'], (data) => {
    console.log(data);
}, 10);

Authors

• Sean Fang - Initial work
• Shi Yan - Improvement

License

This project is licensed under the MIT License