Skip to content
The Open Trading Platform API is an independent module for trading across 5 crypto currency exchanges allowing both spot and margin trading.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
controllers Console log clean up Jul 4, 2019
definitions
models Console log clean up Jul 4, 2019
modules Console log clean up Jul 4, 2019
workers
.DS_Store
.gitignore Initial commit Jun 14, 2019
CODE_OF_CONDUCT.md
LICENSE.txt license and readme Jun 17, 2019
README.md Update README.md Jul 11, 2019
config-debug Initial commit Jun 14, 2019
config-release
debug.js
keys.js
package.json
release.js
test.js

README.md

Open Trading Platform - API

Open Trading Platform is a Unified web application; meta trading platform for cryptocurrency Traders and Developers to run on your browser. It allows you to trade across 5 cryptocurrency exchanges for now:

  • Bitfinex (Spot trading)
  • Binance (Spot trading)
  • Bequant or HitBtc (Spot trading)
  • Bitmex(Margin trading)

The Open Trading Platform platform allows Traders to manage all their accounts on One Unified Secure platform completely in their control with the capabilities to add new features to the system.

The Development is constantly maintained and updated by Blocknomic Technologies Pvt. Ltd

The open source system has been built keeping non-developers in mind to allow ease of startup. You can test out the platform at https://trader.opentradingplatform.org

Use Open Trading Platform UI to trade safely and efficiently

INDEX

  1. System architecture
  2. Getting Started
  3. Platform Features
  4. How to recommend Platform features to us?
  5. Developers, Contributors and how to contribute
  6. Todos
  7. Developer Note
  8. Roadmap
  9. Wiki
  10. Documentation (Coming soon)
  11. Donations
  12. Your security concerns!!!!

System Architecture

The Open Trading platform has three main components

  1. UI
  2. API
  3. ENGINE
  4. TradingView widgets

The UI is available at https://github.com/blocknomic-technologies/open-trading-platform-UI repository that contains all the code for the frontend which is displayed on browser. The UI requires both the API and the ENGINE to operate properly.

The API available at https://github.com/blocknomic-technologies/open-trading-platform-API repository that contains all the platforms Api's and can work independantly from the other two components. It can be used by developers for programming their own system and function for automation.

The ENGINE is currently being run by us. It's a simple aggregator engine that complies all the different exchanges ticker/market data and displays it for users to use to choose their currency pair and comparing market rates etc. The ENGINE will be open sourced in future dates after cleaning up of the code.

The TRADING VIEW WIDGETS are also currently being run by us. If you wish to run it on your own follow the instruction on https://github.com/blocknomic-technologies/open-trading-platform-TradingView/blob/master/README.md

Getting Started

The platform has been designed and built for two types of users Traders with no development experience and Traders/Developers with basic development experience below we will give you the different options to run the system. There are 3 ways to start the system.

  1. Headless (Easy)
  2. Full (Medium)
  3. Download (Easiest)

Headless

Headless allows the developer to run the platform without running the UI on there computer. They can simply use https://trader.opentradingplatform.org to connect the server running on their computer.

Requirements

  1. Node.js V8.9.0+
  2. NPM
  3. git

Download node.js and NPM at https://nodejs.org/en/download/package-manager/

Download Git at https://git-scm.com/downloads

For Development environments...

$ git clone https://github.com/blocknomic-technologies/open-trading-platform-API.git
$ cd open-trading-platform-API
$ npm install
(In the root directory search and edit the keys.js file and input your API keys for the exchanges)
(To run simply type)
$ node debug.js
(open up https://trader.opentradingplatform.org) and see if you are connected. 

For Production environment (Coming soon)

Full

Running the full system could get heavy that is why we recommend using Head Less. But if you are looking to overhaul the system and test out all the feature there are two main part to running it.

Requirements
  1. Node.js V8.9.0+
  2. NPM
  3. Vue.js V2.5.13+ ( Have not tested in later version, but shouldn't be an issue)
  4. Git

Download node.js and NPM at https://nodejs.org/en/download/package-manager/

Download Git at https://git-scm.com/downloads

For Development environments...

$ git clone https://github.com/blocknomic-technologies/open-trading-platform-API.git
$ cd open-trading-platform-API
$ npm install
(In the root directory search for the keys.js file and input your API keys for the exchanges)
(To run simply type)
$ node debug.js

after downloading and running the server get out of the API root directory and follow the below instructions to run the UI.

$ git clone https://github.com/blocknomic-technologies/open-trading-platform-UI.git
$ cd open-trading-platform-UI
$ npm install
$ npm run serve

Within the terminal you will be given a link http://localhost.... open the link and trade

For Production environment (Coming soon)

Download

Easiest way to run the system, perfect for traders/non-developers. visit https://opentradingplatform.org/traders.html

Platform Features

In this section we will explain all the available feature on the easy to use UI that we have made.

  1. Keyboard shortcuts
  2. View markets
  3. News
  4. Trezor integration
  5. Deposits
  6. Margin trading
  7. Server status

You can also visit our youtube video to see how to use the entire system. (Coming soon)

You can do almost everything that you can on the exchanges directly on this platform. Below we will discuss in details everything that you can do with the UI.

Keyboard Shortcuts

There is only one way to place a trade anywhere on the system by simply pressing alt+t To view all open orders you simply press alt+o

enter image description here

View markets

To select an exchange and a currency pair you have to visit markets on the navbar and choose your Exchange and currency pair there.

Choosing your currency

News

We have incorporated a little news widget to allow you to view the latest news in the, we haven't completed programming it, but in the near future depending on the Currency pair you are on it will provide you relevant information regarding those coins for different new channels.

enter image description here

Trezor

To use your trezor directly on the platform, use the navbar on the top, go to profile->Setting and connect your trezor. More info available on the WIKI. (Coming soon)

Deposit

You can get wallet address directly from the UI by going funds on the navbar and then wallet and choosing the exchange and currency. We do not allow withdrawls from the system for security reasons.

Margin trading

Go to the markets page and choose Derivatives market at the bottom.

Server status

On the top right of the nav bar there is a status bar that allows you to see if your local server is on or not. Green means connected, Orange means NOT connected.

FOR MORE DETAILS ON PLATFORM FEATURES PLEASE VISIT THE WIKI

How to recommend Platform features to us?

  • Just visit the issues tab on this github rep and choose the feature template.

Developers, Contributors and how to contribute

Developer
Hargun singh Project manager
Lovish wadhera Sr Full stack Developer
Mayank bhardwaj Minion Full stack Developer
Contributors
Ayush Gupta Full stack developer

Want to contribute? Great! We'll be adding guidelines soon.

Todos

  • Clean code
  • Add documentation (Swagger & JsDocs)
  • Finish up wiki
  • Complete all coming soon agendas

Developer note

This is our first open source project please bear with us as we navigate through this experience and try to make it as comfortable as an experience for you.

Roadmap

enter image description here

Donations

We accept crypto donations if you're looking to fund our teams Beers, Pizza's and Butter chicken.

BTC = 3N1eMLHky6mTYLLtN4QfzecWduakVYgdVa

LTC = MSnYXgutFWYmmfet9saYGMy66MFuiRYq1y

Your Security Concerns

Nothing is stored on a database and all your apikeys are safely stored on your local computer. All http requests are taken care of from the server running on your computer.

License

GNU AGPLv3

Free Software, We hope you enjoy it!

You can’t perform that action at this time.