adityak74/cryptoviz

A simple crypto coins ticker data collector and visualizer. Will be used as a dataset for the Crypto Prediction Project.

Crypto Visualizer (CryptoViz)

A simple wazirx coins ticker data collector and visualizer. Will be used as a dataset for the Crypto Prediction Project (ChainML ).

PreRequisite

• xampp/lampp/wampp application to run MySQL database and Apache server Download from here.
• Download Node js and install in your operating system. Download from here
• Postman a desktop app or you can use it chrome extension for API testing.Download from here

Used Packages

MYSQL

• For development please download and use XAMPP/LAMP.

---

SQL Configuration

cp config-example.json config.json

• Update your credentials for the environment you are using

---

Migrations

sequelize db:migrate

• Please run the migrations defined in the migrations folder using sequelize-cli

• Run the coins metadata seeder using the following command

node services/coins-seeder.js

---

Get Started

1. $ git clone https://github.com/adityak74/wazirx-visualizer.git
2. $ npm install
3. Launch Enviornment:
   • $ node app.js or nodemon app.js
4. In Cluster mode with the help of pm2 [optional step]:
   • $ pm2 start app.js or pm2 start app.js -i <no of instances>
5. Open in browser:
   • open http://localhost:8080

API Usage

1. Coins Seeder Route route - POST - http://localhost:8080/seedCoinsData
   • Seeds the coins from WazirX API to the database

Example response object for request (JSON object) -

{
    "seeder": "complete",
    "success": true,
    "coinsDataPayload": {
        "coins": [
            {
                "base_unit": "btc",
                "quote_unit": "inr",
                "low": "1489000.0",
                "high": "1505595.0",
                "last": "1498499.0",
                "type": "SPOT",
                "open": 1490899,
                "volume": "68.8624",
                "sell": "1498499.0",
                "buy": "1495715.0",
                "at": 1607354577,
                "name": "BTC/INR",
                "coinID": "76854fe4-8a6a-404f-b098-e9631da87fd7"
            },
            ...
        ]
    }
}

2. Get all Coins - GET - http://localhost:8080/coins
   • Gets all the coins available in the database

Example response object for request (JSON object) -

{
    success: true,
    coinsData: [
        {
            id: "0007b615-16ca-4743-9486-e2c051221bf7",
            name: "BZRX/USDT",
            unit: "usdt",
            base_unit: "bzrx",
            createdAt: "2020-11-21T03:42:54.000Z",
            updatedAt: "2020-11-21T03:42:54.000Z"
        },
    ]
}

Features

• To scrape the WazirX API Endpoint for Ticker, Market Data
• Store/Collect the data in the database
• GCP Cloud Run Deployed
• Sequelize Cacher for SQL Request caching/serving