To run the application (nodeJS + MongoDB) on docker
docker compose up --build
This will consume the default docker-compose.yml
The entrypoint for the program for both connecting to the Websocket and/or REST API is on index.js
For development you can turn on
DEV="true"
on .env, this will make use of any variable(s) with DEV prefix.
Start the database and web gui with
docker compose up -f mongo-docker-compose.yml up --build
This will bring up a containers for MongoDB and Mongo-Express, and now running index.js with nodeJS will connect to this MongoDB container.
npm install
node index.js
There are three main scripts
| Script name | What it does |
|---|---|
bitmex_ws.js |
Connects to BitMEX websocket and saves incomming data. |
bitmex_rest.js |
Makes requests to BitMEX REST API every 5 seconds and saves the data. It will request pages number of pages of pageSize data points each. |
cleaner.js |
This script is meant to be run periodically, it will remove any duplicates from database, it is specially usefull if running both bitmex_ws.js and bitmex_rest.js in parallel. standalone |
For some more information consult the inline comments inside the scripts.
This repository makes use of the code under lib directory from the official BitMEX-API-Connectors.