Skip to content
/ Crypz Public

Basic API to check current cryptocurrency trading margins

Notifications You must be signed in to change notification settings

mononz/Crypz

Repository files navigation

Coin API

Basic NodeJS API developed with the Koa2 framework to check current trading margins between different cryptocurrency markets.

Initial setup

Create the env file and fill out all values

cp .env.template .env

Create the knexfile file and fill out all values

cp knexfile.js.template knexfile.js

Install dependencies (rerun when package.json changes)

npm install

Run

node index or npm start

Documentation

GET /btcmarkets

Optional query parameters

Param Description Defaults
stake amount to invest 2000
sellFee btcmarkets trading fee 0.5
minimal true for reduced output false

Ex. http://localhost:3001/btcmarkets?stake=300&sellFee=0.75&minimal=false

POST /prices

Optional header parameters

Param Description Value
save Supply the auth value to save to the database qwertyuiop
slack Supply the auth value to send a slack notification qwertyuiop

Ex. http://localhost:3001/prices

About

Basic API to check current cryptocurrency trading margins

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published