apex-exchange
WARNING: This package is still early beta, following the designs of my other connectors. If you want to stay informed when this may be ready for testing, please get in touch via telegram.
Node.js connector for the apex APIs and WebSockets, with TypeScript & browser support.
Installation
npm install --save apex-exchange
Issues & Discussion
Related projects
Check out my related projects:
- Try my connectors:
- Try my misc utilities:
- Check out my examples:
Documentation
Most methods accept JS objects. These can be populated using parameters specified by apex's API documentation.
Structure
This project uses typescript. Resources are stored in 3 key structures:
- src - the whole connector written in typescript
- lib - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release.
- dist - the packed bundle of the project for use in browser environments.
- examples - some implementation examples & demonstrations. Contributions are welcome!
Usage
WebSockets
Inverse, linear & spot WebSockets can be used via a shared WebsocketClient
. However, make sure to make one instance of WebsocketClient per market type (spot vs inverse vs linear vs linearfutures):
const { WebsocketClient } = require('apex-exchange');
const API_KEY = 'xxx';
const PRIVATE_KEY = 'yyy';
const wsConfig = {
key: API_KEY,
secret: PRIVATE_KEY,
};
const ws = new WebsocketClient(wsConfig);
ws.subscribe(['position', 'execution', 'trade']);
ws.subscribe('kline.BTCUSD.1m');
ws.on('update', data => {
console.log('update', data);
});
ws.on('open', ({ wsKey, event }) => {
console.log('connection open for websocket with ID: ' + wsKey);
});
ws.on('response', response => {
console.log('response', response);
});
ws.on('close', () => {
console.log('connection closed');
});
ws.on('error', err => {
console.error('ERR', err);
});
See websocket-client.ts for further information.
Note: for linear websockets, pass linear: true
in the constructor options when instancing the WebsocketClient
. To connect to both linear and inverse websockets, make two instances of the WebsocketClient.
Customise Logging
Pass a custom logger which supports the log methods silly
, debug
, notice
, info
, warning
and error
, or override methods from the default logger as desired.
const { WebsocketClient, DefaultLogger } = require('apex-exchange');
DefaultLogger.silly = () => {};
const ws = new WebsocketClient(
{ key: 'xxx', secret: 'yyy' },
DefaultLogger
);
Browser Usage
Build a bundle using webpack:
npm install
npm build
npm pack
The bundle can be found in dist/
. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO.
Contributions & Thanks
Donations
tiagosiebler
Support my efforts to make algo trading accessible to all - register with my referral links:
Or buy me a coffee using any of these:
- BTC:
1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk
- ETH (ERC20):
0xd773d8e6a50758e1ada699bb6c4f98bb4abf82da
Contributions & Pull Requests
Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.